Create auto reload

Action: POST
Endpoint: /autoreloads

Use this endpoint to create an auto reload.

Body field details

Name Type Required? Description Allowable Values
token string No 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.
36 char max
active boolean No Specifies whether the auto reload is active.

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

Default: true
currency_code string Yes The 3-character ISO 4217 currency code. The 3-character ISO 4217 currency code.

"USD" currently supported.
association object No 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.
funding_source_token string Yes The unique identifier of the funding source to use for this auto reload. Existing funding source token.

Issue a GET to /fundingsources/user/{user_token} to retrieve funding source tokens for a user.

Issue a GET to /fundingsources/business/{business_token} to retrieve funding source tokens for a business.
funding_source_address_token string No 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.
Existing funding source address token.

Issue a GET to /fundingsources/addresses/user/{user_token} to retrieve address tokens for a user.

Issue a GET to /fundingsources/addresses/business/{business_token} to retrieve address tokens for a business.
order_scope object Yes Defines the balance threshold and reload amounts.

The autoreloads.association object

Name Type Required? Description Allowable Values
user_token string No The unique identifer of the user for which the auto reload is configured. Existing user token.

Issue a GET to /users to retrieve user tokens.
card_product_token string No The unique identifer of the card product for which the auto reload is configured. Existing card product token.

Issue a GET to /cardproducts to retrieve card product tokens.
business_token string No The unique identifer of the business for which the auto reload is configured. Existing business token.

Issue a GET to /businesss to retrieve business tokens.

The autoreloads.order_scope object

Name Type Required? Description Allowable Values
gpa object Either gpa or msa required. Defines the type of order.
msa object Either gpa or msa required. Defines the type of order.

The autoreloads.gpa object

Name Type Required? Description Allowable Values
trigger_amount decimal Yes The threshold that determines when the reload happens.

The reload is triggered when the balance drops below this amount.
Must be at least $0.01
reload_amount decimal Yes 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.
Must be at least $0.01

The autoreloads.msa object

Name Type Required? Description Allowable Values
campaign_token string Yes Identifies the campaign on which the funds will be spent. Existing campaign token.

Issue a GET to /campaigns to retrieve campaign tokens.
trigger_amount decimal Yes The threshold that determines when the reload happens.

The reload is triggered when the balance drops below this amount.
Must be at least $0.01
reload_amount decimal Yes 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.
Must be at least $0.01

Sample request body

{
"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
}
}
}

Sample response body

{
"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": "2017-05-10T22:15:20Z",
"last_modified_time": "2017-05-10T22:15:20Z"
}


Retrieve auto reload

Action: GET
Endpoint: /autoreloads/{token}

Use this endpoint to retrieve a specific auto reload object.

URL path parameters

Name Type Required? Description Allowable Values
token string Yes Identifies the auto reload to retrieve. Existing auto reload token.

Issue a GET to /autoreloads to retrieve auto reload tokens.

Sample response body

{
"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": "2017-05-10T22:15:20Z",
"last_modified_time": "2017-05-10T22:15:20Z"
}


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

Name Type Required? Description Allowable Values
token string Yes Identifies the auto reload to update. Existing auto reload token.

Issue a GET to /autoreloads to retrieve auto reload tokens.

Body field details

Name Type Required? Description Allowable Values
active boolean No Specifies whether the auto reload is active.

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

Default: true
currency_code string Yes The 3-character ISO 4217 currency code. The 3-character ISO 4217 currency code.

"USD" currently supported.
association object No 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.
funding_source_token string Yes The unique identifier of the funding source to use for this auto reload. Existing funding source token.

Issue a GET to /fundingsources/user/{user_token} to retrieve funding source tokens for a user.

Issue a GET to /fundingsources/business/{business_token} to retrieve funding source tokens for a business.
funding_source_address_token string No 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.
Existing funding source address token.

Issue a GET to /fundingsources/addresses/user/{user_token} to retrieve address tokens for a user.

Issue a GET to /fundingsources/addresses/business/{business_token} to retrieve address tokens for a business.
order_scope object Yes Defines the balance threshold and reload amounts.

The autoreloads.association object

Name Type Required? Description Allowable Values
user_token string No The unique identifer of the user for which the auto reload is configured. Existing user token.

Issue a GET to /users to retrieve user tokens.
card_product_token string No The unique identifer of the card product for which the auto reload is configured. Existing card product token.

Issue a GET to /cardproducts to retrieve card product tokens.
business_token string No The unique identifer of the business for which the auto reload is configured. Existing business token.

Issue a GET to /businesss to retrieve business tokens.

The autoreloads.order_scope object

Name Type Required? Description Allowable Values
gpa object Either gpa or msa required. Defines the type of order.
msa object Either gpa or msa required. Defines the type of order.

The autoreloads.gpa object

Name Type Required? Description Allowable Values
trigger_amount decimal Yes The threshold that determines when the reload happens.

The reload is triggered when the balance drops below this amount.
Must be at least $0.01
reload_amount decimal Yes 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.
Must be at least $0.01

The autoreloads.msa object

Name Type Required? Description Allowable Values
campaign_token string Yes Identifies the campaign on which the funds will be spent. Existing campaign token.

Issue a GET to /campaigns to retrieve campaign tokens.
trigger_amount decimal Yes The threshold that determines when the reload happens.

The reload is triggered when the balance drops below this amount.
Must be at least $0.01
reload_amount decimal Yes 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.
Must be at least $0.01

Sample request body

{
"order_scope": {
"gpa": {
"trigger_amount": 250,
"reload_amount": 500
}
}
}

Sample response body

{
"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": 250,
"reload_amount": 500
}
},
"currency_code": "USD",
"created_time": "2017-05-10T22:15:20Z",
"last_modified_time": "2017-05-10T22:21:59Z"
}


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.

Query parameters

Name Type Required? Description Allowable Values
card_product string No The token identifying the card product whose auto reloads you want to retrieve. Existing card product token.

Issue a GET to /cardproducts to retrieve card product tokens.
user_token string No The token identifying the user whose auto reloads you want to retrieve. Existing user token.

Issue a GET to /users to retrieve user tokens.
business_token string No The token identifying the business whose auto reloads you want to retrieve. Existing business token.

Issue a GET to /businesses to retrieve business tokens.

Sample response body

{
"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": 250,
"reload_amount": 500
}
},
"currency_code": "USD",
"created_time": "2017-05-10T22:15:20Z",
"last_modified_time": "2017-05-10T22:21:59Z"
}
]
}