For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Bearer authentication of the form Bearer <token>, where token is your auth token.
Request
Transaction data to update, referenced by ‘tx_id’. The ‘timestamp’ field represents the update time. Only the fields to be updated need to be included.
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.
currencystringOptionalformat: "iso-4217"
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, 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_countrystringOptionalformat: "iso-3166-1"
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.
