Sign in

v1

latestOpenAPI 3.0.2Apache License 2.02026-07-13109285691.8 KB
Transactions

Create a Transaction

Create a new Transaction that can be funded

post/v1/transactions

Request body

payorIdstring uuid required

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

sourceAccountNamestring required

The name of the source account that the new Transaction will be associated with and any funding containing the transactionShortCode will credit.

transactionReferencestring required

The payors own reference for the transaction that can later be used for querying and retrieval.

transactionMetadataobject

Optional metadata that will be attached to the created transaction and can that can be retrieved later.| The total length of all the keys and values provided in the metadata must be no more than 4000 chars.

Example request

{
  "transactionMetadata": {
    "key": "any_value"
  },
  "transactionReference": "myInvoiceNumber-1234567890",
  "payorId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "sourceAccountName": "Payor_FOO_USD_Account"
}

Response

Transaction Created

transactionIdstring uuid required

The Id of the newly created transaction

transactionShortCodestring required

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

Example response

{
  "transactionId": "4d88e559-d057-45b1-8d8b-b9ccc06f4503",
  "transactionShortCode": "T1234ABC"
}