GET/
Use this endpoint to list auto reloads configured for the program or for a specific card product, user, or business.
This endpoint supports field filtering and pagination.
URL query parameters
| Fields | Description |
|---|---|
| card_product string Optional | Unique identifier of the card product whose auto reloads you want to retrieve. Allowable Values: Existing card_product token |
| user_token string Optional | Unique identifier of the user whose auto reloads you want to retrieve. Allowable Values: Existing user token |
| business_token string Optional | Unique identifier of the business whose auto reloads you want to retrieve. Allowable Values: Existing business token |
| count integer Optional | Number of resources to retrieve. If your requested count exceeds the maximum number of resources the platform can return in a single response, Marqeta returns a 206 Partial Content status code instead of 200 OK.Allowable Values: Any positive integer Default value: 10 |
| 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 |
| sort_by string Optional | Field on which to sort. Use any field in the resource model, or one of the system fields lastModifiedTime or createdTime. Prefix the field name with a hyphen (-) to sort in descending order. Omit the hyphen to sort in ascending order.Allowable Values: createdTime, lastModifiedTime, or any field in the resource modelDefault value: -lastModifiedTime |
Response body
| Fields | Description |
|---|---|
| count integer Conditionally returned | Number of resources to retrieve. This field is returned if there are objects in your returned array. If your requested count exceeds the maximum number of resources the platform can return in a single response, this field reflects the actual number of resources returned, and Marqeta returns a 206 Partial Content status code instead of 200 OK.Allowable Values: Any positive integer |
| data array of objects Conditionally returned | Array of auto reload objects. Objects are returned as appropriate to your query. Allowable Values: Valid array of one or more auto reload objects |
| data[].active boolean Conditionally returned | Specifies whether the auto reload is active. This field is returned if it exists in the resource. Allowable Values: true, false |
| data[].association object Conditionally returned | Specifies the scope of the auto reload. Allowable Values: business_token, card_product_token, user_token |
| data[].association.business_token string Conditionally returned | Unique identifier of the business for which the auto reload is configured. Allowable Values: 1–36 chars |
| data[].association.card_product_token string Conditionally returned | Unique identifier of the card product for which the auto reload is configured. Allowable Values: 1–36 chars |
| data[].association.user_token string Conditionally returned | Unique identifier of the user for which the auto reload is configured. Allowable Values: 1–36 chars |
| data[].created_time datetime Returned | Date and time when the auto reload object was created, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
| data[].currency_code string Returned | Three-digit ISO 4217 currency code. Allowable Values: Any currency code allowed by your program |
| data[].funding_source_address_token string Conditionally returned | Unique identifier of the funding source address to use for this auto reload. This field is returned if it exists in the resource. Allowable Values: 1–36 chars |
| data[].funding_source_token string Conditionally returned | Unique identifier of the funding source to use for this auto reload. This field is returned if it exists in the resource. Allowable Values: 1–36 chars |
| data[].last_modified_time datetime Returned | Date and time when the auto reload object was last modified, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
| data[].order_scope object Returned | Defines the balance threshold and reload amounts. Allowable Values: gpa |
| data[].order_scope.gpa object Conditionally returned | Defines the type of order. Allowable Values: reload_amount, trigger_amount |
| data[].order_scope.gpa.reload_amount decimal Returned | Available balance on the card after the reload has completed. Allowable Values: 0.01 min |
| data[].order_scope.gpa.trigger_amount decimal Returned | Threshold that determines when the reload happens. The reload is triggered when the card balance falls below this amount. Allowable Values: 0.01 min |
| data[].token string Conditionally returned | Unique identifier of the auto reload. This field is always returned. Allowable Values: 1–36 chars |
| end_index integer Conditionally returned | Sort order index of the last resource in the returned array. This field is returned if there are objects 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 objects 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 objects in your returned array. Allowable Values: Any integer |
Sample response body
JSON
{
"count": 1,
"start_index": 0,
"end_index": 0,
"is_more": false,
"data": [
{
"token": "my_user_01_autoreload_01",
"active": false,
"funding_source_token": "my_program_funding_source_01",
"association": {
"user_token": "my_user_01"
},
"order_scope": {
"gpa": {
"trigger_amount": 100,
"reload_amount": 200
}
},
"currency_code": "USD",
"created_time": "2022-11-10T22:15:20Z",
"last_modified_time": "2022-11-10T22:21:59Z"
}
]
}