Create a transaction

Request

Header Params

idempotency-key

string

required

Example:

Content-Type

string

required

Example:

application/json

Authorization

string

required

Example:

Bearer {{access_token}}

Body Params application/json

amount

integer

required

reference

string

required

metadata

object

required

from

string <uuid>

required

from wallet id

to

string <uuid>

required

to wallet id or beneficiary id

payment_type

enum<string>

required

Allowed values:

INTER_WALLETAUD_DE_1AUD_NPP_1

Examples

Inter Wallet (Synchronous)External Beneficiary (Asynchronous)

{
    "amount": 957,
    "reference": "dolore in",
    "metadata": {},
    "from": "ea95fda2-05cc-01e7-4a16-ade2d0bada83",
    "to": "abd5222d-5e66-8147-5e65-8ee84980f533",
    "payment_type": "AUD_DE_1"
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

cURL

Inter Wallet (Synchronous)External Beneficiary (Asynchronous)

curl --location --request POST '/customers/v1/transactions' \
--header 'idempotency-key: {{idempotency-key}}' \
--header 'Authorization: Bearer {{access_token}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "amount": 957,
    "reference": "dolore in",
    "metadata": {},
    "from": "ea95fda2-05cc-01e7-4a16-ade2d0bada83",
    "to": "abd5222d-5e66-8147-5e65-8ee84980f533",
    "payment_type": "AUD_DE_1"
}'

Responses

🟢200OK

application/json

Body

A record representing a financial transaction.

id

string <uuid>

required

The unique identifier of the transaction.

amount

number <float>

required

The amount of the transaction.

asset

enum<string>

required

The asset type of the transaction, such as AUD.

Allowed value:

AUD

asset_class

enum<string>

required

The class of asset, typically currency.

Allowed value:

CURRENCY

created_at

string <date-time>

required

The timestamp when the transaction was created.

external_id

string | null

required

An external identifier associated with the transaction.

from

string <uuid> | null

required

The originator of the transaction, typically a wallet ID.

payment_type

enum<string>

required

The type of payment used in the transaction.

Allowed values:

CARDINTER_WALLETMANUAL_CREDIT

reference

string

required

A reference code or description for the transaction.

status

enum<string>

required

The status of the transaction.

Allowed values:

ACCEPTEDDECLINEDPENDING

to

string <uuid> | null

required

The recipient of the transaction, typically a wallet ID.

type

enum<string>

required

The type of transaction being performed.

Allowed values:

INTER_WALLETREFUNDRESERVATIONREVERSALSETTLEMENTMANUAL_CREDITCARD_SPEND

updated_at

string <date-time>

required

The timestamp when the transaction was last updated.

metadata

object

required

Additional data associated with the transaction.

info

object | null

required

Optional information about the transaction.

Example

{
    "id": "9b1f05d8-f08f-4974-ae2b-df1e475e5024",
    "amount": 1,
    "asset": "AUD",
    "asset_class": "CURRENCY",
    "created_at": "2025-01-14T16:42:56.086Z",
    "external_id": "111",
    "from": "3d83ed2b-b760-4101-adf2-4f83ed57d366",
    "payment_type": "MANUAL_CREDIT",
    "reference": "in dolore nostrud sit velit",
    "status": "DECLINED",
    "to": "4e624f4c-d49c-4cb4-bda3-1c734042d134",
    "type": "RESERVATION",
    "updated_at": "2025-01-14T16:42:56.088Z",
    "metadata": {},
    "info": null
}