POST/
Use this endpoint to create an auto reload.
Request body
| Fields | Description |
|---|---|
| active boolean Optional | Specifies whether the auto reload is active. Only one auto reload per level, per object, can be active. Allowable Values: true, falseDefault value: true |
| association object Optional | Specifies the scope of the auto reload. Input no more than one field. If no value is supplied, the auto reload applies at the program level. Allowable Values: business_token, card_product_token, user_token |
| association.business_token string Optional | Unique identifier of the business for which the auto reload is configured. Send a GET request to /businesses to retrieve business tokens.Allowable Values: 1–36 chars |
| association.card_product_token string Optional | Unique identifier of the card product for which the auto reload is configured. Send a GET request to /cardproducts to retrieve card product tokens.Allowable Values: 1–36 chars |
| association.user_token string Optional | Unique identifier of the user for which the auto reload is configured. Send a GET request to /users to retrieve user tokens.Allowable Values: 1–36 chars |
| currency_code string Required | Three-digit ISO 4217 currency code. Allowable Values: Any currency code allowed by your program |
| funding_source_address_token string Optional | Unique identifier of the funding source address to use for this auto reload. If your funding source is an ACH account, then a funding_source_address_token is not required. If your funding source is a payment card, you must have at least one funding source address in order to create a GPA order.Send a GET request to /fundingsources/addresses/user/{user_token} to retrieve address tokens for a user.Send a GET request to /fundingsources/addresses/business/{business_token} to retrieve address tokens for a business.Allowable Values: 1–36 chars |
| funding_source_token string Optional | Unique identifier of the funding source to use for this auto reload. Send a GET request to /fundingsources/user/{user_token} to retrieve funding source tokens for a user.Send a GET request to /fundingsources/business/{business_token} to retrieve funding source tokens for a business.Allowable Values: 1–36 chars |
| order_scope object Required | Defines the balance threshold and reload amounts. Allowable Values: gpa |
| order_scope.gpa object Optional | Defines the type of order. Allowable Values: reload_amount, trigger_amount |
| order_scope.gpa.reload_amount decimal Required | Available balance on the card after the reload has completed. This value must be greater than or equal to the value of trigger_amount. Note that this is not the same as the amount added to the card, which will vary from reload to reload.Allowable Values: 0.01 min |
| order_scope.gpa.trigger_amount decimal Required | 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 Optional | Unique identifier of the auto reload. If you do not include a token, the system will generate one automatically. This token is necessary for use in other API calls, so we recommend that rather than let the system generate one, you use a simple string that is easy to remember. This value cannot be updated. Allowable Values: 1–36 chars |
Sample request body
JSON
{
"token": "my_user_01_autoreload_01",
"active": false,
"currency_code": "USD",
"association": {
"user_token": "my_user_01"
},
"funding_source_token": "my_program_funding_source_01",
"order_scope": {
"gpa": {
"trigger_amount": 100,
"reload_amount": 200
}
}
}
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,
"association": {
"user_token": "my_user_01"
},
"funding_source_token": "my_program_funding_source_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:15:20Z"
}