Transaction Data APITransactions

Add a new transaction

Headers

AuthorizationstringRequired

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

AuthorizationstringRequired

Request

This endpoint expects an object.
timestampdatetimeRequired
The time of the transaction. This should be in ISO 8601 format. When adding a new transaction, this field represents the creation time. When updating a transaction, this field represents the time the transaction was updated.
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
Allowed values:
methodenumOptional
amountdoubleOptional
currencystringOptional
ISO 4217 currency code
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, this could be an account number, customer id, or any other unique identifier. If you are sending customer data to Cable, this ID should be able to be referenced in that dataset.
sender_countrystringOptional

ISO 3166-1 alpha-2 country code

receiver_idstringOptional
Identifier of the receiver, this could be an account number, customer id, or any other unique identifier.
receiver_countrystringOptional

ISO 3166-1 alpha-2 country code

statusenumOptional

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