Add a new transaction
Headers
Authorization
Bearer authentication of the form Bearer <token>
, where token is your auth token.
Authorization
Request
This endpoint expects an object.
timestamp
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_id
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.
type
Allowed values:
method
amount
currency
ISO 4217 currency code
amount_usd
Amount in USD, if not provided will be calculated using the latest exchange rate using data from Open Exchange Rates (https://openexchangerates.org)
sender_id
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_country
ISO 3166-1 alpha-2 country code of the sender. Required when sender_id is provided.
receiver_id
Identifier of the receiver (e.g., account number, customer ID). Required if sender_id is not provided.
receiver_country
ISO 3166-1 alpha-2 country code of the receiver. Required when receiver_id is provided.
status
Response
Transaction added successfully
success
Indicates if the write operation was successful.
write_count
The number of records written to the database.
message
Provides additional information about the operation result.
organization_id
The organization ID for which the operation was performed.