GET/////
Returns a paginated list of transfers for a specific account holder.
URL path parameters
| Fields | Description |
|---|---|
| account_holder_token string Required | Unique identifier of the account holder (user or business). Allowable Values: Valid account holder token |
URL query parameters
| Fields | Description |
|---|---|
| count integer Optional | Number of transfers to return. The default value of this field is 10.Allowable Values: 1–50 |
| start_index integer Optional | Sort order index of the first resource in the returned array. The default value of this field is 0.Allowable Values: 0 min |
Response body
| Fields | Description |
|---|---|
| count integer Conditionally returned | Number of transfer resources to retrieve. Allowable Values: 1-10 |
| start_index integer Conditionally returned | Sort order index of the first resource in the returned array. Allowable Values: Any integer |
| end_index integer Conditionally returned | Sort order index of the last resource in the returned array. Allowable Values: Any integer |
| is_more boolean Conditionally returned | A value of true indicates that more unreturned resources exist.Allowable Values: true, false |
| data array of objects Conditionally returned | Array of transfer objects. Allowable Values: Valid array of transfer objects |
| data[].token string Conditionally returned | Unique identifier of the transfer. Allowable Values: 36 char max |
| data[].transfer_type string Conditionally returned | Type of transfer to perform. Allowable Values: CARD_PULL, CARD_PUSH, CARD_DISBURSEMENT |
| data[].card_token string Conditionally returned | Unique identifier of the external card involved in the transfer. Allowable Values: 36 char max |
| data[].source_user_token string Conditionally returned | User token that is the source for the transfer. Allowable Values: 36 char max |
| data[].source_business_token string Conditionally returned | Business token that is the source for the transfer. Allowable Values: 36 char max |
| data[].destination_user_token string Conditionally returned | User token that is the destination for the transfer. Allowable Values: 36 char max |
| data[].destination_business_token string Conditionally returned | Business token that is the destination for the transfer. Allowable Values: 36 char max |
| data[].amount decimal Conditionally returned | Amount of the transfer. Allowable Values: Any number between 0.01 and 1000000000 |
| data[].currency string Conditionally returned | Currency of the transfer. Allowable Values: A valid three-digit ISO 4217 currency code |
| data[].statement_descriptor string Conditionally returned | Description of the transaction, as it will appear on the recipient’s bank statement. Allowable Values: 22 char max |
| data[].status string Conditionally returned | Processing state of the transaction. Allowable Values: CHARGEBACK, COMPLETE, PENDING, REJECTED |
| data[].created_time datetime Conditionally returned | Date and time when the transfer was created, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
| data[].last_modified_time datetime Conditionally returned | Date and time when the transfer was updated, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |