GET////
Use this endpoint to list intra-account transfers sent by an account holder. Include a user or business token as a path parameter to identify the recipient.
This endpoint supports field filtering and pagination.
URL path parameters
| Fields | Description |
|---|---|
| user_or_business_token string Required | Existing user or business token. Send a GET request to /users to retrieve user tokens or to /businesses to retrieve business tokens.Allowable Values: Existing user or business resource token |
URL query parameters
| Fields | Description |
|---|---|
| count integer Optional | Number of intra-account transfer resources to retrieve. Allowable Values: 1-50 Default value: 25 |
| start_index integer Optional | Sort order index of the first resource in the returned array. Allowable Values: Any integer Default value: 0 |
| fields string Optional | Comma-delimited list of fields to return (field_1,field_2, and so on). Leave blank to return all fields.Allowable Values: Comma-delimited list of fields, or blank |
Response body
| Fields | Description |
|---|---|
| amount decimal Returned | Amount of the transfer. Allowable Values: decimal Format: 0.00 |
| currency_code string Returned | Three-digit ISO 4217 currency code. Allowable Values: Valid three-digit ISO 4217 currency code |
| memo string Conditionally returned | Additional descriptive text about the intra-account transfer. Allowable Values: 1–99 chars |
| recipient_business_token string Conditionally returned | Specifies the business account holder that receives funds. Allowable Values: 1–36 chars |
| recipient_user_token string Conditionally returned | Specifies the user account holder that receives funds. Allowable Values: 1–36 chars |
| sender_business_token string Conditionally returned | Specifies the business account holder that sends funds. Allowable Values: 1–36 chars |
| sender_user_token string Conditionally returned | Specifies the user account holder that sends funds. Allowable Values: 1–36 chars |
| tags string Conditionally returned | Metadata about the intra-account transfer. Allowable Values: 1–255 chars |
| token string Returned | Unique identifier of the intra-account transfer request. Allowable Values: 1–36 chars |
Sample response body
JSON
{
"count": 3,
"start_index": 0,
"end_index": 2,
"is_more": false,
"data[]": null,
"token": "my_intra_account_transfer_01",
"amount": 40,
"currency_code": "USD",
"sender_user_token": "my_user_01",
"recipient_user_token": "my_user_01_account_2",
"created_time": "2023-03-11T20:41:27Z"
}