Transaction

Transaction details

walletIduuidrequired

Wallet ID of the transaction

Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

iduuidrequired

Unique ID of the transaction

Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

shortIdstringrequired

Short ID of the transaction

Example: TR123

externalIdstringrequired

External ID of the transaction

Example: EXT123

typestringrequired

Type of the transaction

Possible values: [PAYMENT, DEPOSIT, CHARGE, EXCHANGE, OTHER_CREDIT_DEBIT]

Example: DEPOSIT

status objectrequired

Status of the transaction

statestringrequired

State of the transaction

Possible values: [FUNDS_REQUIRED, PENDING, AWAITING_APPROVAL, PROCESSING, SUCCESS, FAILED, REVERSED]

Example: COMPLETED

reasonstring

Reason for the transaction state

Example: LIMIT_REACHED

completeboolean

Completion status of the transaction

Example: true

amount objectrequired

Amount of the transaction

amountnumberrequired

The specific monetary value that is being converted from in the currency exchange

Example: 100

currencystringrequired

The type of currency that the money is being exchanged from

Possible values: non-empty, Value must match regular expression [A-Z]{3}

Example: USD

deposit object

Details of the deposit transaction

senderAccountIdentifierstringrequired

Sender's account identifier for the deposit

Example: ACC123

senderNamestringrequired

Name of the sender for the deposit

Example: John Doe

senderReferencestringrequired

Reference for the sender's deposit

Example: REF123

payment object

Details of the payment transaction

beneficiaryAccountIdentifierstringrequired

Beneficiary's account identifier for the payment

Example: BEN123

beneficiaryNamestringrequired

Name of the beneficiary for the payment

Example: Jane Doe

paymentReferencestringrequired

Reference for the payment

Example: PAY123

exchange object

Details of the exchange transaction

rate objectrequired

Rate of the exchange

pricenumberrequired

currencyPairstringrequired

Possible values: non-empty

typestringrequired

Possible values: [BID, OFFER]

from objectrequired

Money from the exchange

amountnumberrequired

The specific monetary value that is being converted from in the currency exchange

Example: 100

currencystringrequired

The type of currency that the money is being exchanged from

Possible values: non-empty, Value must match regular expression [A-Z]{3}

Example: USD

to objectrequired

Money to the exchange

amountnumberrequired

The specific monetary value that is being converted from in the currency exchange

Example: 100

currencystringrequired

The type of currency that the money is being exchanged from

Possible values: non-empty, Value must match regular expression [A-Z]{3}

Example: USD

charge object

Details of the charge transaction

chargeForTransactionIdstring

Charge for the transaction ID

Example: CHG123

createdAtdate-timerequired

Creation time of the transaction

Example: 2023-01-01T00:00:00Z

completedAtdate-time

Completion time of the transaction

Example: 2023-01-01T00:00:00Z

Transaction

{
  "walletId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "shortId": "TR123",
  "externalId": "EXT123",
  "type": "DEPOSIT",
  "status": "COMPLETED",
  "amount": {
    "amount": 100,
    "currency": "USD"
  },
  "deposit": {
    "senderAccountIdentifier": "ACC123",
    "senderName": "John Doe",
    "senderReference": "REF123"
  },
  "payment": {
    "beneficiaryAccountIdentifier": "BEN123",
    "beneficiaryName": "Jane Doe",
    "paymentReference": "PAY123"
  },
  "exchange": {
    "rate": {
      "price": 0,
      "currencyPair": "string",
      "type": "BID"
    },
    "from": {
      "amount": 100,
      "currency": "USD"
    },
    "to": {
      "amount": 100,
      "currency": "USD"
    }
  },
  "charge": {
    "chargeForTransactionId": "CHG123"
  },
  "createdAt": "2023-01-01T00:00:00Z",
  "completedAt": "2023-01-01T00:00:00Z"
}