API ReferenceTransactions

Add a new transaction

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

Transaction data to add. Amount and currency are required for new transactions. At least one of sender_id or receiver_id must be provided with their respective country codes.

timestampstringRequiredformat: "date-time"
When the transaction was processed in your system, in ISO 8601 format. For updates, use when the event occurred, not when you're reporting it.
tx_idstringRequired
Unique identifier for the transaction. This is the primary key for the transaction record and should be unique across all transactions. Updates to a transaction should be made using this identifier.
amountdouble or nullOptional

Transaction amount. Negative amounts are allowed for refunds, chargebacks, and credits. Zero amounts are allowed for auth-only, declined, and pre-authorization transactions. Required when creating new transactions, optional for updates.

amount_usddoubleOptional
Amount in USD, if not provided will be calculated using the latest exchange rate using data from Open Exchange Rates (https://openexchangerates.org)
currencystringOptionalformat: "iso-4217"
ISO 4217 currency code. Required when creating new transactions, optional for updates.
is_testbooleanOptionalDefaults to false
If the transaction is test data, this should be set to true
methodenumOptional
Payment method used for the transaction. Required when creating new transactions, optional for updates. Each method may have different processing times, fees, and regulatory requirements.
receiver_countrystringOptionalformat: "iso-3166-1"

ISO 3166-1 alpha-2 country code of the receiver. Required when receiver_id is provided.

receiver_idstring or nullOptional

Identifier of the receiver (e.g., account number, customer ID). Required if sender_id is not provided.

sender_countrystringOptionalformat: "iso-3166-1"

ISO 3166-1 alpha-2 country code of the sender. Required when sender_id is provided.

sender_idstring or nullOptional

Identifier of the sender (e.g., account number, customer ID). This ID should match the identifier used in your customer data sent to Cable. Required if receiver_id is not provided.

statusenumOptional
Transaction status. Required when creating new transactions, optional for updates.
typeenumOptional
Transaction type. Required when creating new transactions, optional for updates.
Allowed values:

Response

Transaction added successfully
successboolean
Indicates if the write operation was successful.
write_countinteger
The number of records written to the database.
messagestring
Provides additional information about the operation result.
organization_idstring
The organization ID for which the operation was performed.

Errors