API Reference
Update transactions in batch
/v2/transactions/batch https://api.cable.tech Authentication
- Bearer token in the Authorization header
transactions:write
Request body
An array of transaction update payloads. Each payload must include the ‘tx_id’ to identify the transaction and can include any other fields that need to be updated. The ‘timestamp’ field should represent the time of update.
-
timestampstring requiredWhen the transaction was processed in your system, in ISO 8601 format. For updates, use when the event occurred, not when you’re reporting it.
Format
date-time -
tx_idstring requiredUnique 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.
-
is_testbooleanSet to true if this is a test transaction
Default
false -
typestringTransaction type. Required when creating new transactions, optional for updates.
Allowed values
DEPOSITWITHDRAWAL -
methodstringPayment method used for the transaction. Required when creating new transactions, optional for updates. Each method may have different processing times, fees, and regulatory requirements.
Allowed values
WIREACHSWIFTSEPAAPPLE_PAYGOOGLE_PAYCHECK_DEPOSITINTERNAL_TRANSFERRTPFEDNOWPROV_X_TRANSFERCARD -
amountnumber | nullTransaction 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.
Format
float -
currencystringISO 4217 currency code. Required when creating new transactions, optional for updates.
Format
iso-4217 -
amount_usdnumberAmount in USD, if not provided will be calculated using the latest exchange rate using data from Open Exchange Rates (https://openexchangerates.org)
Format
float -
sender_idstring | nullIdentifier 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_countrystringISO 3166-1 alpha-2 country code of the sender. Required when sender_id is provided.
Format
iso-3166-1 -
receiver_idstring | nullIdentifier of the receiver (e.g., account number, customer ID). Required if sender_id is not provided.
-
receiver_countrystringISO 3166-1 alpha-2 country code of the receiver. Required when receiver_id is provided.
Format
iso-3166-1 -
statusstringTransaction status. Required when creating new transactions, optional for updates.
Allowed values
CREATEDPENDINGSETTLEDFAILEDREJECTEDREFUNDED
Responses
200 Batch processing result
-
successboolean requiredIndicates if the write operation was successful.
-
write_countinteger requiredThe number of records written to the database.
Format
int32 -
messagestring requiredProvides additional information about the operation result.
-
organization_idstring requiredThe organization ID for which the operation was performed.
Errors
- 400 Invalid transaction data in batch
- 401 Unauthorized request
- 404 Transaction not found in batch
- 429 Rate limit exceeded
- 500 Server error
- default General error
-
codeinteger requiredFormat
int32 -
messagestring required -
errorslist of objectsDetailed information about errors in specific fields.
-
fieldstring -
messagestring
-