Auto Reload
Auto reload enables you to automatically load a specified amount into an account when the account balance falls below a defined threshold.
Auto reloads execute only when the account balance falls below the trigger value due to spending. They do not execute due to unloading of funds or because of lack of funds when a user or business is first created.
You can define auto reloads at the level of an account holder, a card product, or a program. Each auto reload draws from a single funding source.
In the case of auto reloads defined at more than one level, the following order of precedence (first to last) determines which auto reload is executed:
-
Account holder
-
Card product
-
Program
Create auto reload
Copy section link
Action: POST
Endpoint: /autoreloads
Use this endpoint to create an auto reload.
Request body
Copy section link
Fields | Description |
---|---|
active
boolean
|
Specifies whether the auto reload is active. Only one auto reload per level, per object, can be active. Allowable Values:
Default value: |
association
object
|
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:
|
association.business_token
string
|
Unique identifier of the business for which the auto reload is configured. Send a Allowable Values: 1–36 chars |
association.card_product_token
string
|
Unique identifier of the card product for which the auto reload is configured. Send a Allowable Values: 1–36 chars |
association.user_token
string
|
Unique identifier of the user for which the auto reload is configured. Send a Allowable Values: 1–36 chars |
currency_code
string
|
Three-digit ISO 4217 currency code. Allowable Values: Any currency code allowed by your program |
funding_source_address_token
string
|
Unique identifier of the funding source address to use for this auto reload. If your funding source is an ACH account, then a Send a Send a Allowable Values: 1–36 chars |
funding_source_token
string
|
Unique identifier of the funding source to use for this auto reload. Send a Send a Allowable Values: 1–36 chars |
order_scope
object
|
Defines the balance threshold and reload amounts. Allowable Values:
|
order_scope.gpa
object
|
Defines the type of order. Allowable Values:
|
order_scope.gpa.reload_amount
decimal
|
Available balance on the card after the reload has completed. This value must be greater than or equal to the value of Allowable Values: 0.01 min |
order_scope.gpa.trigger_amount
decimal
|
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
|
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 |
Response body
Copy section link
Fields | Description |
---|---|
active
boolean
|
Specifies whether the auto reload is active. This field is returned if it exists in the resource. Allowable Values:
|
association
object
|
Specifies the scope of the auto reload. Allowable Values:
|
association.business_token
string
|
Unique identifier of the business for which the auto reload is configured. Allowable Values: 1–36 chars |
association.card_product_token
string
|
Unique identifier of the card product for which the auto reload is configured. Allowable Values: 1–36 chars |
association.user_token
string
|
Unique identifier of the user for which the auto reload is configured. Allowable Values: 1–36 chars |
created_time
datetime
|
Date and time when the auto reload object was created, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
currency_code
string
|
Three-digit ISO 4217 currency code. Allowable Values: Any currency code allowed by your program |
funding_source_address_token
string
|
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
|
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
|
Date and time when the auto reload object was last modified, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
order_scope
object
|
Defines the balance threshold and reload amounts. Allowable Values:
|
order_scope.gpa
object
|
Defines the type of order. Allowable Values:
|
order_scope.gpa.reload_amount
decimal
|
Available balance on the card after the reload has completed. Allowable Values: 0.01 min |
order_scope.gpa.trigger_amount
decimal
|
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
|
Unique identifier of the auto reload. This field is always returned. Allowable Values: 1–36 chars |
List auto reloads
Copy section link
Action: GET
Endpoint: /autoreloads
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
Copy section link
Fields | Description |
---|---|
card_product
string
|
Unique identifier of the card product whose auto reloads you want to retrieve. Allowable Values: Existing |
user_token
string
|
Unique identifier of the user whose auto reloads you want to retrieve. Allowable Values: Existing |
business_token
string
|
Unique identifier of the business whose auto reloads you want to retrieve. Allowable Values: Existing |
count
integer
|
Number of resources to retrieve. Allowable Values: 1-10 Default value: |
start_index
integer
|
Sort order index of the first resource in the returned array. Allowable Values: Any integer Default value: |
fields
string
|
Comma-delimited list of fields to return ( Allowable Values: Comma-delimited list of fields, or blank |
sort_by
string
|
Field on which to sort.
Use any field in the resource model, or one of the system fields Allowable Values:
Default value: |
Response body
Copy section link
Fields | Description |
---|---|
count
integer
|
Number of resources to retrieve. This field is returned if there are objects in your returned array. Allowable Values: 1-10 |
data
array of objects
|
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
|
Specifies whether the auto reload is active. This field is returned if it exists in the resource. Allowable Values:
|
data[].association
object
|
Specifies the scope of the auto reload. Allowable Values:
|
data[].association.business_token
string
|
Unique identifier of the business for which the auto reload is configured. Allowable Values: 1–36 chars |
data[].association.card_product_token
string
|
Unique identifier of the card product for which the auto reload is configured. Allowable Values: 1–36 chars |
data[].association.user_token
string
|
Unique identifier of the user for which the auto reload is configured. Allowable Values: 1–36 chars |
data[].created_time
datetime
|
Date and time when the auto reload object was created, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
data[].currency_code
string
|
Three-digit ISO 4217 currency code. Allowable Values: Any currency code allowed by your program |
data[].funding_source_address_token
string
|
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
|
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
|
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
|
Defines the balance threshold and reload amounts. Allowable Values:
|
data[].order_scope.gpa
object
|
Defines the type of order. Allowable Values:
|
data[].order_scope.gpa.reload_amount
decimal
|
Available balance on the card after the reload has completed. Allowable Values: 0.01 min |
data[].order_scope.gpa.trigger_amount
decimal
|
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
|
Unique identifier of the auto reload. This field is always returned. Allowable Values: 1–36 chars |
end_index
integer
|
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
|
A value of This field is returned if there are objects in your returned array. Allowable Values:
|
start_index
integer
|
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 |
Retrieve auto reload
Copy section link
Action: GET
Endpoint: /autoreloads/{token}
Use this endpoint to retrieve a specific auto reload object.
URL path parameters
Copy section link
Fields | Description |
---|---|
token
string
|
Unique identifier of the auto reload. Allowable Values: Existing auto reload token |
URL query parameters
Copy section link
Fields | Description |
---|---|
fields
string
|
Comma-delimited list of fields to return ( Allowable Values: Comma-delimited list of fields, or blank |
Response body
Copy section link
Fields | Description |
---|---|
active
boolean
|
Specifies whether the auto reload is active. This field is returned if it exists in the resource. Allowable Values:
|
association
object
|
Specifies the scope of the auto reload. Allowable Values:
|
association.business_token
string
|
Unique identifier of the business for which the auto reload is configured. Allowable Values: 1–36 chars |
association.card_product_token
string
|
Unique identifier of the card product for which the auto reload is configured. Allowable Values: 1–36 chars |
association.user_token
string
|
Unique identifier of the user for which the auto reload is configured. Allowable Values: 1–36 chars |
created_time
datetime
|
Date and time when the auto reload object was created, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
currency_code
string
|
Three-digit ISO 4217 currency code. Allowable Values: Any currency code allowed by your program |
funding_source_address_token
string
|
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
|
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
|
Date and time when the auto reload object was last modified, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
order_scope
object
|
Defines the balance threshold and reload amounts. Allowable Values:
|
order_scope.gpa
object
|
Defines the type of order. Allowable Values:
|
order_scope.gpa.reload_amount
decimal
|
Available balance on the card after the reload has completed. Allowable Values: 0.01 min |
order_scope.gpa.trigger_amount
decimal
|
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
|
Unique identifier of the auto reload. This field is always returned. Allowable Values: 1–36 chars |
Update auto reload
Copy section link
Action: PUT
Endpoint: /autoreloads/{token}
Use this endpoint to update an auto reload. Only values of parameters in the request are modified; all others are left unchanged.
URL path parameters
Copy section link
Fields | Description |
---|---|
token
string
|
Unique identifier of the auto reload. Allowable Values: Existing auto reload token |
Request body
Copy section link
Fields | Description |
---|---|
active
boolean
|
Specifies whether the auto reload is active. Only one auto reload per level, per object, can be active. Allowable Values:
Default value: |
association
object
|
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:
|
association.business_token
string
|
Unique identifier of the business for which the auto reload is configured. Send a Allowable Values: 1–36 chars |
association.card_product_token
string
|
Unique identifier of the card product for which the auto reload is configured. Send a Allowable Values: 1–36 chars |
association.user_token
string
|
Unique identifier of the user for which the auto reload is configured. Send a Allowable Values: 1–36 chars |
currency_code
string
|
Three-digit ISO 4217 currency code. Allowable Values: Any currency code allowed by your program |
funding_source_address_token
string
|
Unique identifier of the funding source address to use for this auto reload. If your funding source is an ACH account, then a Allowable Values: 1–36 chars Existing funding source address token. Send a Send a |
funding_source_token
string
|
Unique identifier of the funding source to use for this auto reload. Allowable Values: 1–36 chars Existing funding source token. Send a Send a |
order_scope
object
|
Defines the balance threshold and reload amounts. Allowable Values:
|
order_scope.gpa
object
|
Defines the type of order. Allowable Values:
|
order_scope.gpa.reload_amount
decimal
|
Available balance on the card after the reload has completed. This value must be greater than or equal to the value of Allowable Values: 0.01 min |
order_scope.gpa.trigger_amount
decimal
|
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
|
The token in the path parameter takes precedence over the Allowable Values: 1–36 chars |
Response body
Copy section link
Fields | Description |
---|---|
active
boolean
|
Specifies whether the auto reload is active. This field is returned if it exists in the resource. Allowable Values:
|
association
object
|
Specifies the scope of the auto reload. Allowable Values:
|
association.business_token
string
|
Unique identifier of the business for which the auto reload is configured. Allowable Values: 1–36 chars |
association.card_product_token
string
|
Unique identifier of the card product for which the auto reload is configured. Allowable Values: 1–36 chars |
association.user_token
string
|
Unique identifier of the user for which the auto reload is configured. Allowable Values: 1–36 chars |
created_time
datetime
|
Date and time when the auto reload object was created, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
currency_code
string
|
Three-digit ISO 4217 currency code. Allowable Values: Any currency code allowed by your program |
funding_source_address_token
string
|
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
|
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
|
Date and time when the auto reload object was last modified, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
order_scope
object
|
Defines the balance threshold and reload amounts. Allowable Values:
|
order_scope.gpa
object
|
Defines the type of order. Allowable Values:
|
order_scope.gpa.reload_amount
decimal
|
Available balance on the card after the reload has completed. Allowable Values: 0.01 min |
order_scope.gpa.trigger_amount
decimal
|
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
|
Unique identifier of the auto reload. This field is always returned. Allowable Values: 1–36 chars |