/
20 minute read
March 24, 2022

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

Action: POST
Endpoint: /autoreloads

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, false

Default 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:

A valid association object

association.business_token

string
Optional

The unique identifier of the business for which the auto reload is configured.

Allowable Values:

Existing business token.

Send a GET request to /businesses to retrieve business tokens.

association.card_product_token

string
Optional

The unique identifier of the card product for which the auto reload is configured.

Allowable Values:

Existing card product token.

Send a GET request to /cardproducts to retrieve card product tokens.

association.user_token

string
Optional

The unique identifier of the user for which the auto reload is configured.

Allowable Values:

Existing user token.

Send a GET request to /users to retrieve user tokens.

currency_code

string
Required

The three-digit ISO 4217 currency code.

Allowable Values:

Any currency code allowed by your program

funding_source_address_token

string
Optional

The 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.

Allowable Values:

Existing funding source address token.

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.

funding_source_token

string
Optional

The unique identifier of the funding source to use for this auto reload.

Allowable Values:

Existing funding source token.

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.

order_scope

object
Required

Defines the balance threshold and reload amounts.

Allowable Values:

A valid order_scope object

order_scope.gpa

object
Optional

Defines the type of order.

Allowable Values:

A valid gpa object

order_scope.gpa.reload_amount

decimal
Required

The 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

The threshold that determines when the reload happens.

The reload is triggered when the card balance falls below this amount.

Allowable Values:

0.01 min

order_scope.msa

object
N/A

Deprecated, do not use.

Allowable Values:

N/A

order_scope.msa.campaign_token

string
N/A

Deprecated, do not use.

Allowable Values:

N/A

order_scope.msa.reload_amount

decimal
N/A

Deprecated, do not use.

Allowable Values:

N/A

order_scope.msa.trigger_amount

decimal
Required

Deprecated, do not use.

Allowable Values:

N/A

token

string
Optional

The 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
Fields Description

active

boolean
Returned

Specifies whether the auto reload is active.

Only one auto reload per level, per object, can be active.

Allowable Values:

true, false

association

object
Conditionally returned

Specifies the scope of the auto reload. If no value is returned, the auto reload applies at the program level.

Allowable Values:

A valid association object

association.business_token

string
Conditionally returned

The unique identifier of the business for which the auto reload is configured, if applicable.

Allowable Values:

Existing business token.

association.card_product_token

string
Conditionally returned

The unique identifier of the card product for which the auto reload is configured, if applicable.

Allowable Values:

Existing card product token.

association.user_token

string
Conditionally returned

The unique identifier of the user for which the auto reload is configured, if applicable.

Allowable Values:

Existing user token.

created_time

datetime
Returned

The date and time when the auto reload object was created, in UTC. 2021-10-26T20:03:05Z, for example.

Allowable Values:

yyyy-MM-ddThh:mm:ssZ

currency_code

string
Returned

The three-digit ISO 4217 currency code.

Allowable Values:

Any currency code allowed by your program

funding_source_address_token

string
Conditionally returned

The unique identifier of the funding source address to use for this auto reload.

Allowable Values:

Existing funding source address token.

funding_source_token

string
Conditionally returned

The unique identifier of the funding source to use for this auto reload.

Allowable Values:

Existing funding source token.

last_modified_time

datetime
Returned

The date and time when the auto reload object was last modified, in UTC. 2021-10-26T20:03:10Z, for example.

Allowable Values:

yyyy-MM-ddThh:mm:ssZ

order_scope

object
Returned

Defines the balance threshold and reload amounts.

Allowable Values:

A valid order_scope object

order_scope.gpa

object
Conditionally returned

Defines the type of order.

Allowable Values:

A valid gpa object

order_scope.gpa.reload_amount

decimal
Returned

The 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
Returned

The threshold that determines when the reload happens.

The reload is triggered when the card balance falls below this amount.

Allowable Values:

0.01 min

order_scope.msa

object
N/A

Deprecated, do not use.

Allowable Values:

N/A

order_scope.msa.campaign_token

string
N/A

Deprecated, do not use.

Allowable Values:

N/A

order_scope.msa.reload_amount

decimal
N/A

Deprecated, do not use.

Allowable Values:

N/A

order_scope.msa.trigger_amount

decimal
N/A

Deprecated, do not use.

Allowable Values:

N/A

token

string
Returned

The unique identifier of the auto reload.

Allowable Values:

1–36 chars

Sample request body
JSON
Copied

Is this helpful?

Yes
No
Sample response body
JSON
Copied

Is this helpful?

Yes
No

List auto reloads

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
Fields Description

card_product

string
Optional

The token identifying the card product whose auto reloads you want to retrieve.

Allowable Values:

Existing card_product token

user_token

string
Optional

The token identifying the user whose auto reloads you want to retrieve.

Allowable Values:

Existing user token

business_token

string
Optional

The token identifying the business whose auto reloads you want to retrieve.

Allowable Values:

Existing business token

count

integer
Optional

The number of resources to retrieve.

Allowable Values:

1-10

Default Value
10

start_index

integer
Optional

The sort order index of the first resource in the returned array.

Allowable Values:

Any integer

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:

A 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:

lastModifiedTime, createdTime, or any field in the resource model

Response body
Fields Description

count

integer
Conditionally returned

The number of resources to retrieve.

Allowable Values:

1-10

data

array of objects
Conditionally returned

An array of objects in a returned resource.

Allowable Values:

A valid data array

data[].active

boolean
Returned

Specifies whether the auto reload is active.

Allowable Values:

true, false

data[].association

object
Conditionally returned

Specifies the scope of the auto reload. If no value is returned, the auto reload applies at the program level.

Allowable Values:

A valid association object

data[].association.business_token

string
Conditionally returned

The unique identifier of the business for which the auto reload is configured, if applicable.

Allowable Values:

Existing business token.

data[].association.card_product_token

string
Conditionally returned

The unique identifier of the card product for which the auto reload is configured, if applicable.

Allowable Values:

Existing card product token.

data[].association.user_token

string
Conditionally returned

The unique identifier of the user for which the auto reload is configured, if applicable.

Allowable Values:

Existing user token.

data[].created_time

datetime
Returned

The date and time when the auto reload object was created, in UTC. 2021-10-26T20:03:05Z, for example.

Allowable Values:

yyyy-MM-ddThh:mm:ssZ

data[].currency_code

string
Returned

The three-digit ISO 4217 currency code.

Allowable Values:

Any currency code allowed by your program

data[].funding_source_address_token

string
Conditionally returned

The unique identifier of the funding source address used for this auto reload.

Allowable Values:

Existing funding source address token.

data[].funding_source_token

string
Conditionally returned

The unique identifier of the funding source to use for this auto reload.

Allowable Values:

Existing funding source token.

data[].last_modified_time

datetime
Returned

The date and time when the auto reload object was last modified, in UTC. 2021-10-26T20:03:10Z, for example.

Allowable Values:

yyyy-MM-ddThh:mm:ssZ

data[].order_scope

object
Returned

Defines the balance threshold and reload amounts.

Allowable Values:

A valid order_scope object

data[].order_scope.gpa

object
Conditionally returned

Defines the type of order.

Allowable Values:

A valid gpa object

data[].order_scope.gpa.reload_amount

decimal
Returned

The available balance on the card after the reload has completed.

Allowable Values:

0.01 min

data[].order_scope.gpa.trigger_amount

decimal
Returned

The threshold that determines when the reload happens.

Allowable Values:

0.01 min

data[].order_scope.msa

object
N/A

Deprecated, do not use.

Allowable Values:

N/A

data[].order_scope.msa.campaign_token

string
N/A

Deprecated, do not use.

Allowable Values:

N/A

data[].order_scope.msa.reload_amount

decimal
N/A

Deprecated, do not use.

Allowable Values:

N/A

data[].order_scope.msa.trigger_amount

decimal
N/A

Deprecated, do not use.

Allowable Values:

N/A

data[].token

string
Conditionally returned

The unique identifier of the auto reload.

Allowable Values:

1–36 chars

end_index

integer
Conditionally returned

The sort order index of the last resource in the returned array.

Allowable Values:

Any integer

is_more

boolean
Conditionally returned

A value of true indicates that more unreturned resources exist.

Allowable Values:

true, false

start_index

integer
Conditionally returned

The sort order index of the first resource in the returned array.

Allowable Values:

Any integer

Sample response body
JSON
Copied

Is this helpful?

Yes
No

Retrieve auto reload

Action: GET
Endpoint: /autoreloads/{token}

Use this endpoint to retrieve a specific auto reload object.

URL path parameters
Fields Description

token

string
Required

The 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:

A comma-delimited list of fields, or blank

Response body
Fields Description

active

boolean
Returned

Specifies whether the auto reload is active.

Allowable Values:

true, false

association

object
Conditionally returned

Specifies the scope of the auto reload. If no value is returned, the auto reload applies at the program level.

Allowable Values:

A valid association object

association.business_token

string
Conditionally returned

The unique identifier of the business for which the auto reload is configured, if applicable.

Allowable Values:

Existing business token.

association.card_product_token

string
Conditionally returned

The unique identifier of the card product for which the auto reload is configured, if applicable.

Allowable Values:

Existing card product token.

association.user_token

string
Conditionally returned

The unique identifier of the user for which the auto reload is configured, if applicable.

Allowable Values:

Existing user token.

created_time

datetime
Returned

The date and time when the auto reload object was created, in UTC. 2021-10-26T20:03:05Z, for example.

Allowable Values:

yyyy-MM-ddThh:mm:ssZ

currency_code

string
Returned

The three-digit ISO 4217 currency code.

Allowable Values:

Any currency code allowed by your program

funding_source_address_token

string
Conditionally returned

The unique identifier of the funding source address used for this auto reload, if applicable.

Allowable Values:

Existing funding source address token.

funding_source_token

string
Conditionally returned

The unique identifier of the funding source to use for this auto reload, if applicable.

Allowable Values:

Existing funding source token.

last_modified_time

datetime
Returned

The date and time when the auto reload object was last modified, in UTC. 2021-10-26T20:03:10Z, for example.

Allowable Values:

yyyy-MM-ddThh:mm:ssZ

order_scope

object
Returned

Defines the balance threshold and reload amounts.

Allowable Values:

A valid order_scope object

order_scope.gpa

object
Conditionally returned

Defines the type of order.

Allowable Values:

A valid gpa object

order_scope.gpa.reload_amount

decimal
Returned

The available balance on the card after the reload has completed.

Allowable Values:

0.01 min

order_scope.gpa.trigger_amount

decimal
Returned

The threshold that determines when the reload happens.

The reload is triggered when the card balance falls below this amount.

Allowable Values:

0.01 min

order_scope.msa

object
N/A

Deprecated, do not use.

Allowable Values:

N/A

order_scope.msa.campaign_token

string
N/A

Deprecated, do not use.

Allowable Values:

N/A

order_scope.msa.reload_amount

decimal
N/A

Deprecated, do not use.

Allowable Values:

N/A

order_scope.msa.trigger_amount

decimal
N/A

Deprecated, do not use.

Allowable Values:

N/A

token

string
Returned

The unique identifier of the auto reload.

Allowable Values:

Existing auto reload token

Sample response body
JSON
Copied

Is this helpful?

Yes
No

Update auto reload

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
Fields Description

token

string
Required

The unique identifier of the auto reload.

Allowable Values:

Existing auto reload token

Send a GET request to /autoreloads to retrieve auto reload tokens.

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, false

Default 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:

A valid association object

association.business_token

string
Optional

The unique identifier of the business for which the auto reload is configured.

Allowable Values:

Existing business token.

Send a GET request to /businesses to retrieve business tokens.

association.card_product_token

string
Optional

The unique identifier of the card product for which the auto reload is configured.

Allowable Values:

Existing card product token.

Send a GET request to /cardproducts to retrieve card product tokens.

association.user_token

string
Optional

The unique identifier of the user for which the auto reload is configured.

Allowable Values:

Existing user token.

Send a GET request to /users to retrieve user tokens.

currency_code

string
Optional

The three-digit ISO 4217 currency code.

Allowable Values:

Any currency code allowed by your program

funding_source_address_token

string
Optional

The 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.

Allowable Values:

Existing funding source address token.

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.

funding_source_token

string
Optional

The unique identifier of the funding source to use for this auto reload.

Allowable Values:

Existing funding source token.

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.

order_scope

object
Optional

Defines the balance threshold and reload amounts.

Allowable Values:

A valid order_scope object

order_scope.gpa

object
Optional

Defines the type of order.

Allowable Values:

A valid gpa object

order_scope.gpa.reload_amount

decimal
Required

The 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

The threshold that determines when the reload happens.

The reload is triggered when the card balance falls below this amount.

Allowable Values:

0.01 min

order_scope.msa

object
N/A

Deprecated, do not use.

Allowable Values:

N/A

order_scope.msa.campaign_token

string
N/A

Deprecated, do not use.

Allowable Values:

N/A

order_scope.msa.reload_amount

decimal
N/A

Deprecated, do not use.

Allowable Values:

N/A

order_scope.msa.trigger_amount

decimal
N/A

Deprecated, do not use.

Allowable Values:

N/A

Response body
Fields Description

active

boolean
Returned

Specifies whether the auto reload is active.

Only one auto reload per level, per object, can be active.

Allowable Values:

true, false

association

object
Conditionally returned

Specifies the scope of the auto reload. If no value is returned, the auto reload applies at the program level.

Allowable Values:

A valid association object

association.business_token

string
Conditionally returned

The unique identifier of the business for which the auto reload is configured, if applicable.

Allowable Values:

Existing business token.

association.card_product_token

string
Conditionally returned

The unique identifier of the card product for which the auto reload is configured, if applicable.

Allowable Values:

Existing card product token.

association.user_token

string
Conditionally returned

The unique identifier of the user for which the auto reload is configured, if applicable.

Allowable Values:

Existing user token.

created_time

datetime
Returned

The date and time when the auto reload object was created, in UTC. 2021-10-26T20:03:05Z, for example.

Allowable Values:

yyyy-MM-ddThh:mm:ssZ

currency_code

string
Returned

The three-digit ISO 4217 currency code.

Allowable Values:

Any currency code allowed by your program

funding_source_address_token

string
Conditionally returned

The unique identifier of the funding source address used for this auto reload, if applicable.

Allowable Values:

Existing funding source address token.

funding_source_token

string
Conditionally returned

The unique identifier of the funding source used for this auto reload, if applicable.

Allowable Values:

Existing funding source token.

last_modified_time

datetime
Returned

The date and time when the auto reload object was last modified, in UTC. 2021-10-26T20:03:10Z, for example.

Allowable Values:

yyyy-MM-ddThh:mm:ssZ

order_scope

object
Returned

Defines the balance threshold and reload amounts.

Allowable Values:

A valid order_scope object

order_scope.gpa

object
Conditionally returned

Defines the type of order.

Allowable Values:

A valid gpa object

order_scope.gpa.reload_amount

decimal
Returned

The available balance on the card after the reload has completed.

Allowable Values:

0.01 min

order_scope.gpa.trigger_amount

decimal
Returned

The threshold that determines when the reload happens.

The reload is triggered when the card balance falls below this amount.

Allowable Values:

0.01 min

order_scope.msa

object
Conditionally returned

Deprecated, do not use.

Allowable Values:

N/A

order_scope.msa.campaign_token

string
Returned

Deprecated, do not use.

Allowable Values:

N/A

order_scope.msa.reload_amount

decimal
Returned

Deprecated, do not use.

Allowable Values:

N/A

order_scope.msa.trigger_amount

decimal
Returned

Deprecated, do not use.

Allowable Values:

N/A

token

string
Returned

The unique identifier of the auto reload.

Allowable Values:

1–36 chars

Sample request body
JSON
Copied

Is this helpful?

Yes
No
Sample response body
JSON
Copied

Is this helpful?

Yes
No
Join our developer newsletter