GET///
List funding sources associated with a specific user.
This endpoint supports field filtering.
URL path parameters
| Fields | Description |
|---|---|
| user_token string Required | Unique identifier of the user account holder. Allowable Values: Existing user resource token |
URL query parameters
| Fields | Description |
|---|---|
| type string Optional | Type of funding source to retrieve: ACH or payment card. Leave unspecified to return both types. Allowable Values: ACH, paymentcardDefault value: unspecified (both types) |
| 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 |
|---|---|
| count integer Conditionally returned | Number of resources to retrieve. This field is returned if there are resources in your returned array. Allowable Values: 1-10 |
| data array of objects Conditionally returned | Array of funding account objects. Objects are returned as appropriate to your query. Allowable Values: Valid data array of one or more funding account objects |
| data[].account_suffix string Conditionally returned | Account identifier appended to the bank account number. This field is returned if it exists in the resource. Allowable Values: 255 char max |
| data[].account_type string Conditionally returned | Type of account. This field is returned if it exists in the resource. Allowable Values: checking, savings, corporate, loan |
| data[].active boolean Conditionally returned | Specifies whether the account is active. This field is returned if it exists in the resource. Allowable Values: true, false |
| data[].business_token string Conditionally returned | Unique identifier of the business account holder. This token is returned if a user_token is not specified.Allowable Values: Existing business token |
| data[].created_time datetime Returned | Date and time when the resource was created, in UTC. Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ |
| data[].date_sent_for_verification datetime Conditionally returned | Date and time in UTC when the request for account validation was sent to the third-party partner. This field is returned if it exists in the resource. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
| data[].date_verified datetime Conditionally returned | Date and time when the account was verified, in UTC. This field is returned if it exists in the resource. Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ |
| data[].exp_date string Conditionally returned | Payment card expiration date. This field is returned if it exists in the resource. Allowable Values: Format: MMyy |
| data[].is_default_account boolean Conditionally returned | If there are multiple funding sources, this field specifies which source is used by default in funding calls. If there is only one funding source, the system ignores this field and always uses that source. This field is returned if it exists in the resource. Allowable Values: true, false |
| data[].last_modified_time datetime Returned | Date and time when the resource was last modified, in UTC. Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ |
| data[].name_on_account string Conditionally returned | Name on the account. This field is returned if it exists in the resource. Allowable Values: 1–50 chars |
| data[].partner string Conditionally returned | Name of the partner who validated the account holder. Returned when a third-party partner was used for account validation. Allowable Values: PLAID |
| data[].partner_account_link_reference_token string Conditionally returned | Supplied by the account validation partner, this value is a reference to the account holder’s details, such as the account number and routing number. Returned when a third-party partner was used for account validation. Allowable Values: 255 char max |
| data[].token string Conditionally returned | Unique identifier of the funding source. This field is returned if it exists in the resource. Allowable Values: Existing funding source token |
| data[].type string Conditionally returned | Funding source type. Allowable Values: ACH, paymentcard |
| data[].user_token string Conditionally returned | Unique identifier of the user account holder. This token is returned if a business_token is not specified.Allowable Values: Existing user token |
| data[].verification_notes string Conditionally returned | Free-form text field for holding notes about verification. This field is returned only if verification_override = true.Allowable Values: 255 char max |
| data[].verification_override boolean Conditionally returned | Allows the ACH funding source to be used regardless of its verification status. NOTE: When using PLAID to validate a funding source, this field is always set to true.Allowable Values: true, false |
| data[].verification_status string Conditionally returned | Account verification status. This field is returned if it exists in the resource. Allowable Values: ACH_FAILED, ACH_VERIFIED, VERIFICATION_PENDING |
| end_index integer Conditionally returned | Sort order index of the last resource in the returned array. This field is returned if there are resources in your returned array. Allowable Values: Any integer |
| is_more boolean Conditionally returned | A value of true indicates that more unreturned resources exist. A value of false indicates that no more unreturned resources exist.This field is returned if there are resources in your returned array. Allowable Values: true, false |
| start_index integer Conditionally returned | Sort order index of the first resource in the returned array. This field is returned if there are resources in your returned array. Allowable Values: Any integer |
Sample response body
JSON
{
"count": 2,
"start_index": 0,
"end_index": 1,
"is_more": false,
"data": [
{
"type": "paymentcard",
"token": "jane_doe_paymentcard_01",
"account_suffix": "4113",
"account_type": "corporate",
"active": true,
"is_default_account": true,
"exp_date": "1227",
"user_token": "my_user_01",
"created_time": "2023-02-26T20:03:05Z",
"last_modified_time": "2023-02-26T20:03:05Z"
},
{
"type": "ach",
"token": "jane_doe_ach_token",
"account_suffix": "4321",
"account_type": "savings",
"active": false,
"is_default_account": false,
"verification_status": "ACH_VERIFIED",
"user_token": "my_user_01",
"name_on_account": "Jane Doe",
"date_sent_for_verification": "2023-02-27T23:27:58Z",
"created_time": "2023-02-26T20:03:05Z",
"last_modified_time": "2023-02-26T20:03:05Z"
}
]
}