Sign in

v1

latestOpenAPI 3.0.32026-08-04404186.8 KB
Transactions

Update transactions in batch

put/v2/transactions/batch

Request body

amountnumber float nullable

Transaction 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.

amount_usdnumber float

Amount in USD, if not provided will be calculated using the latest exchange rate using data from Open Exchange Rates (https://openexchangerates.org)

currencystring iso-4217

ISO 4217 currency code. Required when creating new transactions, optional for updates.

is_testboolean

Set to true if this is a test transaction

method'WIRE' | 'ACH' | 'SWIFT' | 'SEPA' | 'APPLE_PAY' | 'GOOGLE_PAY' | 'CHECK_DEPOSIT' | 'INTERNAL_TRANSFER' | 'RTP' | 'FEDNOW' | 'PROV_X_TRANSFER' | 'CARD'

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.

receiver_countrystring iso-3166-1

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

receiver_idstring nullable

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

sender_countrystring iso-3166-1

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

sender_idstring nullable

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.

status'CREATED' | 'PENDING' | 'SETTLED' | 'FAILED' | 'REJECTED' | 'REFUNDED'

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

timestampstring date-time required

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_idstring required

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'DEPOSIT' | 'WITHDRAWAL'

Transaction type. Required when creating new transactions, optional for updates.

Response

Batch processing result

messagestring required

Provides additional information about the operation result.

organization_idstring required

The organization ID for which the operation was performed.

successboolean required

Indicates if the write operation was successful.

write_countinteger required

The number of records written to the database.