API ReferenceTransactions

Add transactions in batch

Authentication

AuthorizationBearer

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

Headers

AuthorizationstringRequired

Request

This endpoint expects a list of objects.
timestampdatetimeRequired
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.
typeenumOptional
Transaction type. Required when creating new transactions, optional for updates.
Allowed values:
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.
amountdoubleOptional
Transaction amount. Required when creating new transactions, optional for updates.
currencystringOptional
ISO 4217 currency code. 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)
sender_idstringOptional

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.

sender_countrystringOptional

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

receiver_idstringOptional

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

receiver_countrystringOptional

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

statusenumOptional
Transaction status. Required when creating new transactions, optional for updates.

Response

Batch processing result
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