GET//
Use this endpoint to retrieve a specific auto reload object.
URL path parameters
| Fields | Description |
|---|---|
| token string Required | Unique identifier of the auto reload. Allowable Values: Existing auto reload token |
URL query parameters
| Fields | Description |
|---|---|
| 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 |
|---|---|
| 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 |
| association object Conditionally returned | Specifies the scope of the auto reload. Allowable Values: business_token, card_product_token, user_token |
| association.business_token string Conditionally returned | Unique identifier of the business for which the auto reload is configured. Allowable Values: 1–36 chars |
| 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 |
| association.user_token string Conditionally returned | Unique identifier of the user for which the auto reload is configured. Allowable Values: 1–36 chars |
| created_time datetime Returned | Date and time when the auto reload object was created, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
| currency_code string Returned | Three-digit ISO 4217 currency code. Allowable Values: Any currency code allowed by your program |
| 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 |
| 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 |
| 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 |
| order_scope object Returned | Defines the balance threshold and reload amounts. Allowable Values: gpa |
| order_scope.gpa object Conditionally returned | Defines the type of order. Allowable Values: reload_amount, trigger_amount |
| order_scope.gpa.reload_amount decimal Returned | Available balance on the card after the reload has completed. Allowable Values: 0.01 min |
| 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 |
| token string Conditionally returned | Unique identifier of the auto reload. This field is always returned. Allowable Values: 1–36 chars |
Sample response body
JSON
{
"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"
}