v1

latestOpenAPI 3.0.2Apache License 2.02026-07-13109285691.8 KB

Transactions

Get Transaction

Get Transaction by Id

get/v1/transactions/{transactionId}

Path parameters

transactionIdstring uuid required

Response

Transaction response

transactionIdstring uuid required

The Id of the transaction

transactionShortCodestring required

The short code for the transaction that can be used when sending funds into the platform

payorIdstring uuid

Indicates the Payor of the Transaction and which matches the payorId on the provided source account

sourceAccountNamestring

The name of the source account associated with the Transaction

sourceAccountIdstring uuid

The Id of the source account associated with the Transaction

transactionReferencestring

The payors own reference for the transaction

transactionMetadataobject nullable

Optional metadata attached to the transaction at creation time.

balanceinteger

The total amount of transaction in minor units

currencystring

Valid ISO 4217 3 letter currency code. See the <a href="https://www.iso.org/iso-4217-currency-codes.html" target="_blank" a>ISO specification</a> for details.

createdAtstring date-time

A timestamp when the transaction has been created.

Example response

{
  "createdAt": "2021-01-27T10:08:25.701Z",
  "sourceAccountId": "7faf83a7-77e2-40bc-9e78-7d18fa2bb63e",
  "transactionMetadata": {
    "key": "any_value"
  },
  "balance": 800828190,
  "transactionReference": "myInvoiceNumber-1234567890",
  "currency": "USD",
  "payorId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "transactionId": "4d88e559-d057-45b1-8d8b-b9ccc06f4503",
  "transactionShortCode": "T1234ABC",
  "sourceAccountName": "Payor_FOO_USD_Account"
}