Balance History Mappings
How the reference field in the Balance History API is mapped from the source transaction.
The reference field in the Balance History API is currently in beta. Reach out to your Airwallex account manager if you would like to join the beta.
The Balance History API (GET /api/v1/balances/history) returns a record for each change to your balance. Each record includes a reference field that carries the customer-input reference of the source transaction that resulted in the balance change. This lets you reconcile balance movements against your own records without looking up the originating transaction separately.
How the reference is mapped
The reference field contains the reference associated with the originating transaction that produced the balance change. The value is mapped from the relevant reference field of the source transaction and may differ depending on the transaction type. The reference field is available for transaction types that have a corresponding reference.
Supported transaction types
The following table shows the transaction types for which the reference field is currently populated, the source field it is mapped from, and the source API that sets that field.
| Transaction type | Source field | Source API |
|---|---|---|
| Transfer | reference | Create a transferAPI |
| Scale Charge and Transfer | reference | Create a Connected Account TransferAPI |