API Reference
StatusDashboard

book_transfer_transaction.created

wbhk
book_transfer_transaction.created

Occurs when a book transfer transaction is created.

Payload
const
enum
required

The type of event that occurred.

Allowed:
string
enum
required
Allowed:
uuid
required

Unique identifier for the transaction

date-time
required

ISO 8601 timestamp of when the transaction was created

date-time
required

ISO 8601 timestamp of when the transaction was last updated

const
enum
required

TRANSFER - Book Transfer Transaction

Allowed:
string
enum
required
Allowed:
string
enum
required
string
required

3-character alphabetic ISO 4217 code for the settling currency of the transaction

integer
required

Amount of the transaction that has been settled in the currency's smallest unit (e.g., cents)

integer
required

Pending amount of the transaction in the currency's smallest unit (e.g., cents), including any acquirer fees.

The value of this field will go to zero over time once the financial transaction is settled.

events
array of objects
required

A list of all financial events that have modified this transfer

events*
uuid
required

Globally unique identifier for the financial account or card that will send the funds. Accepted type dependent on the program's use case

uuid
required

Globally unique identifier for the financial account or card that will receive the funds. Accepted type dependent on the program's use case

External ID defined by the customer

transaction_series

A series of transactions that are grouped together

external_resource

An external resource associated with the transfer

Response
200

Return a 200 status to indicate that the data was received successfully

Updated 9 months ago

Payload
Choose an example

Updated 9 months ago