CardDetails
This API endpoint will allow to get detailed information about a particular USConnect card such as balance, reward points, who owns it if it is already registered or tied to a user account.
GET /mobile/v:version/card/:oan_number[/]
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
Example Response: { "oan": "12345678901234", "user_id": 1, "total_balance": 100.00, "total_points": 1000, "active": true, "affiliate_id": 1, "daily_spend_limit": 0 }
GET /mobile/v:version/card/:oan_number[/]
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
Example Response: { "oan": "12345678901234", "user_id": 1, "total_balance": 100.00, "total_points": 1000, "active": true, "affiliate_id": 1, "daily_spend_limit": 0 }
GET /mobile/v:version/card/:oan_number[/]
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
Example Response: { "oan": "12345678901234", "user_id": 1, "total_balance": 100.00, "total_points": 1000, "active": true, "affiliate_id": 1, "daily_spend_limit": 0 }
GET /mobile/v:version/card/:oan_number[/]
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
Example Response: { "oan": "12345678901234", "user_id": 1, "total_balance": 100.00, "total_points": 1000, "active": true, "affiliate_id": 1, "daily_spend_limit": 0 }
CardListTransaction
This API endpoint will allow to get list of transactions occurred using the given USConnect card. NOTE: PASS UTC TIMESTAMPS, THEY WILL BE CONVERTED.
GET /mobile/v:version/card/:oan_number/transactions[/]
Fields
Field | Type | Description | Required |
---|---|---|---|
start_timestamp | Unix timestamp for starting date time range for which you want to filter the transactions. Minimum value is 1467331200 or July 1, 2016 12:00:00 AM. |
NO | |
end_timestamp | Unix timestamp for ending date time range for which you want to filter the transactions. Minimum value is 1467331200 or July 1, 2016 12:00:00 AM. |
NO | |
transaction_type | Restrict the transaction list to particular given sets of transaction types separated by comma. For example, “?transaction_type=purchase,load,transfer” |
NO | |
block_size | How many transactions in the result list to fetch each time. Valid range is from 20 to 100. Default value is 100. |
NO | |
offset | Offset value for where to start from for paginated result list. Starting value is 0 and it is also default value. |
NO | |
start_timestamp | Unix timestamp for starting date time range for which you want to filter the transactions. Minimum value is 1467331200 or July 1, 2016 12:00:00 AM. |
NO | |
end_timestamp | Unix timestamp for ending date time range for which you want to filter the transactions. Minimum value is 1467331200 or July 1, 2016 12:00:00 AM. |
NO | |
transaction_type | Restrict the transaction list to particular given sets of transaction types separated by comma. For example, “?transaction_type=purchase,load,transfer” |
NO | |
block_size | How many transactions in the result list to fetch each time. Valid range is from 20 to 100. Default value is 100. |
NO | |
offset | Offset value for where to start from for paginated result list. Starting value is 0 and it is also default value. |
NO | |
start_timestamp | Unix timestamp for starting date time range for which you want to filter the transactions. Minimum value is 1467331200 or July 1, 2016 12:00:00 AM. |
NO | |
end_timestamp | Unix timestamp for ending date time range for which you want to filter the transactions. Minimum value is 1467331200 or July 1, 2016 12:00:00 AM. |
NO | |
transaction_type | Restrict the transaction list to particular given sets of transaction types separated by comma. For example, “?transaction_type=purchase,load,transfer” |
NO | |
block_size | How many transactions in the result list to fetch each time. Valid range is from 20 to 100. Default value is 100. |
NO | |
offset | Offset value for where to start from for paginated result list. Starting value is 0 and it is also default value. |
NO | |
start_timestamp | Unix timestamp for starting date time range for which you want to filter the transactions. Minimum value is 1467331200 or July 1, 2016 12:00:00 AM. |
NO | |
end_timestamp | Unix timestamp for ending date time range for which you want to filter the transactions. Minimum value is 1467331200 or July 1, 2016 12:00:00 AM. |
NO | |
transaction_type | Restrict the transaction list to particular given sets of transaction types separated by comma. For example, “?transaction_type=purchase,load,transfer” |
NO | |
block_size | How many transactions in the result list to fetch each time. Valid range is from 20 to 100. Default value is 100. |
NO | |
offset | Offset value for where to start from for paginated result list. Starting value is 0 and it is also default value. |
NO |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
Example response: { "start_timestamp": 1470024000, "end_timestamp": 1472702399, "transactions": [ { "oan_number": "21200000888488", "connection_id": null, "transaction_id": 11916639, "transaction_amount": "10.00", "transaction_reward_points": null, "transaction_promotion_amount": null, "new_balance": 23.00, "new_reward_points": 0, "transaction_type": "load", "transaction_items": [ { "product_name": "Load", "price": 10.00 } ], "total_item": 0, "timestamp": 1470854763 }, { "oan_number": "21200000888488", "connection_id": null, "transaction_id": 11916640, "transaction_amount": 2.69, "transaction_reward_points": 10, "transaction_promotion_amount": null, "new_balance": 20.31, "new_reward_points": 0, "transaction_type": "purchase", "transaction_items": [ { "upc": null, "product_name": "Lipton Brisk Tea 20oz Bottle", "price": 1.60, "tax": 0.00, "deposit": 0.00 }, { "upc": "00028400070546", "product_name": "Mars Snickers", "price": 1.09, "tax": 0.00, "deposit": 0.00 } ], "total_item": 2, "timestamp": 1470854876 } ], "total": 10 }
GET /mobile/v:version/card/:oan_number/transactions[/]
Fields
Field | Type | Description | Required |
---|---|---|---|
start_timestamp | Unix timestamp for starting date time range for which you want to filter the transactions. Minimum value is 1467331200 or July 1, 2016 12:00:00 AM. |
NO | |
end_timestamp | Unix timestamp for ending date time range for which you want to filter the transactions. Minimum value is 1467331200 or July 1, 2016 12:00:00 AM. |
NO | |
transaction_type | Restrict the transaction list to particular given sets of transaction types separated by comma. For example, “?transaction_type=purchase,load,transfer” |
NO | |
block_size | How many transactions in the result list to fetch each time. Valid range is from 20 to 100. Default value is 100. |
NO | |
offset | Offset value for where to start from for paginated result list. Starting value is 0 and it is also default value. |
NO | |
start_timestamp | Unix timestamp for starting date time range for which you want to filter the transactions. Minimum value is 1467331200 or July 1, 2016 12:00:00 AM. |
NO | |
end_timestamp | Unix timestamp for ending date time range for which you want to filter the transactions. Minimum value is 1467331200 or July 1, 2016 12:00:00 AM. |
NO | |
transaction_type | Restrict the transaction list to particular given sets of transaction types separated by comma. For example, “?transaction_type=purchase,load,transfer” |
NO | |
block_size | How many transactions in the result list to fetch each time. Valid range is from 20 to 100. Default value is 100. |
NO | |
offset | Offset value for where to start from for paginated result list. Starting value is 0 and it is also default value. |
NO | |
start_timestamp | Unix timestamp for starting date time range for which you want to filter the transactions. Minimum value is 1467331200 or July 1, 2016 12:00:00 AM. |
NO | |
end_timestamp | Unix timestamp for ending date time range for which you want to filter the transactions. Minimum value is 1467331200 or July 1, 2016 12:00:00 AM. |
NO | |
transaction_type | Restrict the transaction list to particular given sets of transaction types separated by comma. For example, “?transaction_type=purchase,load,transfer” |
NO | |
block_size | How many transactions in the result list to fetch each time. Valid range is from 20 to 100. Default value is 100. |
NO | |
offset | Offset value for where to start from for paginated result list. Starting value is 0 and it is also default value. |
NO | |
start_timestamp | Unix timestamp for starting date time range for which you want to filter the transactions. Minimum value is 1467331200 or July 1, 2016 12:00:00 AM. |
NO | |
end_timestamp | Unix timestamp for ending date time range for which you want to filter the transactions. Minimum value is 1467331200 or July 1, 2016 12:00:00 AM. |
NO | |
transaction_type | Restrict the transaction list to particular given sets of transaction types separated by comma. For example, “?transaction_type=purchase,load,transfer” |
NO | |
block_size | How many transactions in the result list to fetch each time. Valid range is from 20 to 100. Default value is 100. |
NO | |
offset | Offset value for where to start from for paginated result list. Starting value is 0 and it is also default value. |
NO |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
Example response: { "start_timestamp": 1470024000, "end_timestamp": 1472702399, "transactions": [ { "oan_number": "21200000888488", "connection_id": null, "transaction_id": 11916639, "transaction_amount": "10.00", "transaction_reward_points": null, "transaction_promotion_amount": null, "new_balance": 23.00, "new_reward_points": 0, "transaction_type": "load", "transaction_items": [ { "product_name": "Load", "price": 10.00 } ], "total_item": 0, "timestamp": 1470854763 }, { "oan_number": "21200000888488", "connection_id": null, "transaction_id": 11916640, "transaction_amount": 2.69, "transaction_reward_points": 10, "transaction_promotion_amount": null, "new_balance": 20.31, "new_reward_points": 0, "transaction_type": "purchase", "transaction_items": [ { "upc": null, "product_name": "Lipton Brisk Tea 20oz Bottle", "price": 1.60, "tax": 0.00, "deposit": 0.00 }, { "upc": "00028400070546", "product_name": "Mars Snickers", "price": 1.09, "tax": 0.00, "deposit": 0.00 } ], "total_item": 2, "timestamp": 1470854876 } ], "total": 10 }
GET /mobile/v:version/card/:oan_number/transactions[/]
Fields
Field | Type | Description | Required |
---|---|---|---|
start_timestamp | Unix timestamp for starting date time range for which you want to filter the transactions. Minimum value is 1467331200 or July 1, 2016 12:00:00 AM. |
NO | |
end_timestamp | Unix timestamp for ending date time range for which you want to filter the transactions. Minimum value is 1467331200 or July 1, 2016 12:00:00 AM. |
NO | |
transaction_type | Restrict the transaction list to particular given sets of transaction types separated by comma. For example, “?transaction_type=purchase,load,transfer” |
NO | |
block_size | How many transactions in the result list to fetch each time. Valid range is from 20 to 100. Default value is 100. |
NO | |
offset | Offset value for where to start from for paginated result list. Starting value is 0 and it is also default value. |
NO | |
start_timestamp | Unix timestamp for starting date time range for which you want to filter the transactions. Minimum value is 1467331200 or July 1, 2016 12:00:00 AM. |
NO | |
end_timestamp | Unix timestamp for ending date time range for which you want to filter the transactions. Minimum value is 1467331200 or July 1, 2016 12:00:00 AM. |
NO | |
transaction_type | Restrict the transaction list to particular given sets of transaction types separated by comma. For example, “?transaction_type=purchase,load,transfer” |
NO | |
block_size | How many transactions in the result list to fetch each time. Valid range is from 20 to 100. Default value is 100. |
NO | |
offset | Offset value for where to start from for paginated result list. Starting value is 0 and it is also default value. |
NO | |
start_timestamp | Unix timestamp for starting date time range for which you want to filter the transactions. Minimum value is 1467331200 or July 1, 2016 12:00:00 AM. |
NO | |
end_timestamp | Unix timestamp for ending date time range for which you want to filter the transactions. Minimum value is 1467331200 or July 1, 2016 12:00:00 AM. |
NO | |
transaction_type | Restrict the transaction list to particular given sets of transaction types separated by comma. For example, “?transaction_type=purchase,load,transfer” |
NO | |
block_size | How many transactions in the result list to fetch each time. Valid range is from 20 to 100. Default value is 100. |
NO | |
offset | Offset value for where to start from for paginated result list. Starting value is 0 and it is also default value. |
NO | |
start_timestamp | Unix timestamp for starting date time range for which you want to filter the transactions. Minimum value is 1467331200 or July 1, 2016 12:00:00 AM. |
NO | |
end_timestamp | Unix timestamp for ending date time range for which you want to filter the transactions. Minimum value is 1467331200 or July 1, 2016 12:00:00 AM. |
NO | |
transaction_type | Restrict the transaction list to particular given sets of transaction types separated by comma. For example, “?transaction_type=purchase,load,transfer” |
NO | |
block_size | How many transactions in the result list to fetch each time. Valid range is from 20 to 100. Default value is 100. |
NO | |
offset | Offset value for where to start from for paginated result list. Starting value is 0 and it is also default value. |
NO |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
Example response: { "start_timestamp": 1470024000, "end_timestamp": 1472702399, "transactions": [ { "oan_number": "21200000888488", "connection_id": null, "transaction_id": 11916639, "transaction_amount": "10.00", "transaction_reward_points": null, "transaction_promotion_amount": null, "new_balance": 23.00, "new_reward_points": 0, "transaction_type": "load", "transaction_items": [ { "product_name": "Load", "price": 10.00 } ], "total_item": 0, "timestamp": 1470854763 }, { "oan_number": "21200000888488", "connection_id": null, "transaction_id": 11916640, "transaction_amount": 2.69, "transaction_reward_points": 10, "transaction_promotion_amount": null, "new_balance": 20.31, "new_reward_points": 0, "transaction_type": "purchase", "transaction_items": [ { "upc": null, "product_name": "Lipton Brisk Tea 20oz Bottle", "price": 1.60, "tax": 0.00, "deposit": 0.00 }, { "upc": "00028400070546", "product_name": "Mars Snickers", "price": 1.09, "tax": 0.00, "deposit": 0.00 } ], "total_item": 2, "timestamp": 1470854876 } ], "total": 10 }
GET /mobile/v:version/card/:oan_number/transactions[/]
Fields
Field | Type | Description | Required |
---|---|---|---|
start_timestamp | Unix timestamp for starting date time range for which you want to filter the transactions. Minimum value is 1467331200 or July 1, 2016 12:00:00 AM. |
NO | |
end_timestamp | Unix timestamp for ending date time range for which you want to filter the transactions. Minimum value is 1467331200 or July 1, 2016 12:00:00 AM. |
NO | |
transaction_type | Restrict the transaction list to particular given sets of transaction types separated by comma. For example, “?transaction_type=purchase,load,transfer” |
NO | |
block_size | How many transactions in the result list to fetch each time. Valid range is from 20 to 100. Default value is 100. |
NO | |
offset | Offset value for where to start from for paginated result list. Starting value is 0 and it is also default value. |
NO | |
start_timestamp | Unix timestamp for starting date time range for which you want to filter the transactions. Minimum value is 1467331200 or July 1, 2016 12:00:00 AM. |
NO | |
end_timestamp | Unix timestamp for ending date time range for which you want to filter the transactions. Minimum value is 1467331200 or July 1, 2016 12:00:00 AM. |
NO | |
transaction_type | Restrict the transaction list to particular given sets of transaction types separated by comma. For example, “?transaction_type=purchase,load,transfer” |
NO | |
block_size | How many transactions in the result list to fetch each time. Valid range is from 20 to 100. Default value is 100. |
NO | |
offset | Offset value for where to start from for paginated result list. Starting value is 0 and it is also default value. |
NO | |
start_timestamp | Unix timestamp for starting date time range for which you want to filter the transactions. Minimum value is 1467331200 or July 1, 2016 12:00:00 AM. |
NO | |
end_timestamp | Unix timestamp for ending date time range for which you want to filter the transactions. Minimum value is 1467331200 or July 1, 2016 12:00:00 AM. |
NO | |
transaction_type | Restrict the transaction list to particular given sets of transaction types separated by comma. For example, “?transaction_type=purchase,load,transfer” |
NO | |
block_size | How many transactions in the result list to fetch each time. Valid range is from 20 to 100. Default value is 100. |
NO | |
offset | Offset value for where to start from for paginated result list. Starting value is 0 and it is also default value. |
NO | |
start_timestamp | Unix timestamp for starting date time range for which you want to filter the transactions. Minimum value is 1467331200 or July 1, 2016 12:00:00 AM. |
NO | |
end_timestamp | Unix timestamp for ending date time range for which you want to filter the transactions. Minimum value is 1467331200 or July 1, 2016 12:00:00 AM. |
NO | |
transaction_type | Restrict the transaction list to particular given sets of transaction types separated by comma. For example, “?transaction_type=purchase,load,transfer” |
NO | |
block_size | How many transactions in the result list to fetch each time. Valid range is from 20 to 100. Default value is 100. |
NO | |
offset | Offset value for where to start from for paginated result list. Starting value is 0 and it is also default value. |
NO |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
Example response: { "start_timestamp": 1470024000, "end_timestamp": 1472702399, "transactions": [ { "oan_number": "21200000888488", "connection_id": null, "transaction_id": 11916639, "transaction_amount": "10.00", "transaction_reward_points": null, "transaction_promotion_amount": null, "new_balance": 23.00, "new_reward_points": 0, "transaction_type": "load", "transaction_items": [ { "product_name": "Load", "price": 10.00 } ], "total_item": 0, "timestamp": 1470854763 }, { "oan_number": "21200000888488", "connection_id": null, "transaction_id": 11916640, "transaction_amount": 2.69, "transaction_reward_points": 10, "transaction_promotion_amount": null, "new_balance": 20.31, "new_reward_points": 0, "transaction_type": "purchase", "transaction_items": [ { "upc": null, "product_name": "Lipton Brisk Tea 20oz Bottle", "price": 1.60, "tax": 0.00, "deposit": 0.00 }, { "upc": "00028400070546", "product_name": "Mars Snickers", "price": 1.09, "tax": 0.00, "deposit": 0.00 } ], "total_item": 2, "timestamp": 1470854876 } ], "total": 10 }
UserAddAdpPayroll
This API endpoint will allow you to add an ADP payroll deduction link to your account. Which can be used for one time loads, and recurring loads.
POST /mobile/v:version/user/add-adp-payroll[/]
Fields
Field | Type | Description | Required |
---|---|---|---|
employer | The employer that you work for. |
YES | |
worker_id | This is the ADP generated Associate ID which can be found when you log in to your ADP account at https://workforcenow.adp.com under your Profile. Please contact your HR administrator for further details. |
YES | |
dob | Employee's date of birth. |
YES | |
last_name | Employee's last name |
YES | |
employer | The employer that you work for. |
YES | |
worker_id | This is the ADP generated Associate ID which can be found when you log in to your ADP account at https://workforcenow.adp.com under your Profile. Please contact your HR administrator for further details. |
YES | |
dob | Employee's date of birth. |
YES | |
last_name | Employee's last name |
YES | |
employer | The employer that you work for. |
YES | |
worker_id | This is the ADP generated Associate ID which can be found when you log in to your ADP account at https://workforcenow.adp.com under your Profile. Please contact your HR administrator for further details. |
YES | |
dob | Employee's date of birth. |
YES | |
last_name | Employee's last name |
YES | |
employer | The employer that you work for. |
YES | |
worker_id | This is the ADP generated Associate ID which can be found when you log in to your ADP account at https://workforcenow.adp.com under your Profile. Please contact your HR administrator for further details. |
YES | |
dob | Employee's date of birth. |
YES | |
last_name | Employee's last name |
YES |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json |
Body
Example Request: { "employer": "Best Employer", "worker_id": "GMP78DX", "dob": "1970-01-01", "last_name": "Brown" }
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
Example Response: { "success": true }
POST /mobile/v:version/user/add-adp-payroll[/]
Fields
Field | Type | Description | Required |
---|---|---|---|
employer | The employer that you work for. |
YES | |
worker_id | This is the ADP generated Associate ID which can be found when you log in to your ADP account at https://workforcenow.adp.com under your Profile. Please contact your HR administrator for further details. |
YES | |
dob | Employee's date of birth. |
YES | |
last_name | Employee's last name |
YES | |
employer | The employer that you work for. |
YES | |
worker_id | This is the ADP generated Associate ID which can be found when you log in to your ADP account at https://workforcenow.adp.com under your Profile. Please contact your HR administrator for further details. |
YES | |
dob | Employee's date of birth. |
YES | |
last_name | Employee's last name |
YES | |
employer | The employer that you work for. |
YES | |
worker_id | This is the ADP generated Associate ID which can be found when you log in to your ADP account at https://workforcenow.adp.com under your Profile. Please contact your HR administrator for further details. |
YES | |
dob | Employee's date of birth. |
YES | |
last_name | Employee's last name |
YES | |
employer | The employer that you work for. |
YES | |
worker_id | This is the ADP generated Associate ID which can be found when you log in to your ADP account at https://workforcenow.adp.com under your Profile. Please contact your HR administrator for further details. |
YES | |
dob | Employee's date of birth. |
YES | |
last_name | Employee's last name |
YES |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json |
Body
Example Request: { "employer": "Best Employer", "worker_id": "GMP78DX", "dob": "1970-01-01", "last_name": "Brown" }
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
Example Response: { "success": true }
POST /mobile/v:version/user/add-adp-payroll[/]
Fields
Field | Type | Description | Required |
---|---|---|---|
employer | The employer that you work for. |
YES | |
worker_id | This is the ADP generated Associate ID which can be found when you log in to your ADP account at https://workforcenow.adp.com under your Profile. Please contact your HR administrator for further details. |
YES | |
dob | Employee's date of birth. |
YES | |
last_name | Employee's last name |
YES | |
employer | The employer that you work for. |
YES | |
worker_id | This is the ADP generated Associate ID which can be found when you log in to your ADP account at https://workforcenow.adp.com under your Profile. Please contact your HR administrator for further details. |
YES | |
dob | Employee's date of birth. |
YES | |
last_name | Employee's last name |
YES | |
employer | The employer that you work for. |
YES | |
worker_id | This is the ADP generated Associate ID which can be found when you log in to your ADP account at https://workforcenow.adp.com under your Profile. Please contact your HR administrator for further details. |
YES | |
dob | Employee's date of birth. |
YES | |
last_name | Employee's last name |
YES | |
employer | The employer that you work for. |
YES | |
worker_id | This is the ADP generated Associate ID which can be found when you log in to your ADP account at https://workforcenow.adp.com under your Profile. Please contact your HR administrator for further details. |
YES | |
dob | Employee's date of birth. |
YES | |
last_name | Employee's last name |
YES |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json |
Body
Example Request: { "employer": "Best Employer", "worker_id": "GMP78DX", "dob": "1970-01-01", "last_name": "Brown" }
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
Example Response: { "success": true }
POST /mobile/v:version/user/add-adp-payroll[/]
Fields
Field | Type | Description | Required |
---|---|---|---|
employer | The employer that you work for. |
YES | |
worker_id | This is the ADP generated Associate ID which can be found when you log in to your ADP account at https://workforcenow.adp.com under your Profile. Please contact your HR administrator for further details. |
YES | |
dob | Employee's date of birth. |
YES | |
last_name | Employee's last name |
YES | |
employer | The employer that you work for. |
YES | |
worker_id | This is the ADP generated Associate ID which can be found when you log in to your ADP account at https://workforcenow.adp.com under your Profile. Please contact your HR administrator for further details. |
YES | |
dob | Employee's date of birth. |
YES | |
last_name | Employee's last name |
YES | |
employer | The employer that you work for. |
YES | |
worker_id | This is the ADP generated Associate ID which can be found when you log in to your ADP account at https://workforcenow.adp.com under your Profile. Please contact your HR administrator for further details. |
YES | |
dob | Employee's date of birth. |
YES | |
last_name | Employee's last name |
YES | |
employer | The employer that you work for. |
YES | |
worker_id | This is the ADP generated Associate ID which can be found when you log in to your ADP account at https://workforcenow.adp.com under your Profile. Please contact your HR administrator for further details. |
YES | |
dob | Employee's date of birth. |
YES | |
last_name | Employee's last name |
YES |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json |
Body
Example Request: { "employer": "Best Employer", "worker_id": "GMP78DX", "dob": "1970-01-01", "last_name": "Brown" }
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
Example Response: { "success": true }
UserAdpDelete
This API endpoint will allow to remove a particular ADP funding source setup for the given user.
DELETE /mobile/v:version/user/adp/:funding_source_id[/]
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 204: No Content
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
DELETE /mobile/v:version/user/adp/:funding_source_id[/]
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 204: No Content
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
DELETE /mobile/v:version/user/adp/:funding_source_id[/]
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 204: No Content
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
DELETE /mobile/v:version/user/adp/:funding_source_id[/]
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 204: No Content
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
UserAppleWallet
This API endpoint will allow the user to add or remove a pass from Apple Wallet.
POST /mobile/v:version/user/set-apple-wallet[/]
Fields
Field | Type | Description | Required |
---|---|---|---|
UserId | The ID of the user whose balance needs to be updated. |
YES | |
BarcodeOAN | The OAN barcode associated with the pass. |
YES | |
IsActive | Boolean flag that indicates if the pass is active or inactive. Value should be 1 if true (pass is installed and balance updates should be sent )or 0 if false (pass has been removed and balance updates should no longer be sent). |
YES | |
UserId | The ID of the user whose balance needs to be updated. |
YES | |
BarcodeOAN | The OAN barcode associated with the pass. |
YES | |
IsActive | Boolean flag that indicates if the pass is active or inactive. Value should be 1 if true (pass is installed and balance updates should be sent )or 0 if false (pass has been removed and balance updates should no longer be sent). |
YES | |
UserId | The ID of the user whose balance needs to be updated. |
YES | |
BarcodeOAN | The OAN barcode associated with the pass. |
YES | |
IsActive | Boolean flag that indicates if the pass is active or inactive. Value should be 1 if true (pass is installed and balance updates should be sent )or 0 if false (pass has been removed and balance updates should no longer be sent). |
YES | |
UserId | The ID of the user whose balance needs to be updated. |
YES | |
BarcodeOAN | The OAN barcode associated with the pass. |
YES | |
IsActive | Boolean flag that indicates if the pass is active or inactive. Value should be 1 if true (pass is installed and balance updates should be sent )or 0 if false (pass has been removed and balance updates should no longer be sent). |
YES |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json |
Body
Example Request: { "UserId": 6, "BarcodeOAN": "123456789012", "IsActive": 1 }
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
Example Response: { "UserId": 6, "BarcodeOAN": "123456789012", "IsActive": true }
POST /mobile/v:version/user/set-apple-wallet[/]
Fields
Field | Type | Description | Required |
---|---|---|---|
UserId | The ID of the user whose balance needs to be updated. |
YES | |
BarcodeOAN | The OAN barcode associated with the pass. |
YES | |
IsActive | Boolean flag that indicates if the pass is active or inactive. Value should be 1 if true (pass is installed and balance updates should be sent )or 0 if false (pass has been removed and balance updates should no longer be sent). |
YES | |
UserId | The ID of the user whose balance needs to be updated. |
YES | |
BarcodeOAN | The OAN barcode associated with the pass. |
YES | |
IsActive | Boolean flag that indicates if the pass is active or inactive. Value should be 1 if true (pass is installed and balance updates should be sent )or 0 if false (pass has been removed and balance updates should no longer be sent). |
YES | |
UserId | The ID of the user whose balance needs to be updated. |
YES | |
BarcodeOAN | The OAN barcode associated with the pass. |
YES | |
IsActive | Boolean flag that indicates if the pass is active or inactive. Value should be 1 if true (pass is installed and balance updates should be sent )or 0 if false (pass has been removed and balance updates should no longer be sent). |
YES | |
UserId | The ID of the user whose balance needs to be updated. |
YES | |
BarcodeOAN | The OAN barcode associated with the pass. |
YES | |
IsActive | Boolean flag that indicates if the pass is active or inactive. Value should be 1 if true (pass is installed and balance updates should be sent )or 0 if false (pass has been removed and balance updates should no longer be sent). |
YES |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json |
Body
Example Request: { "UserId": 6, "BarcodeOAN": "123456789012", "IsActive": 1 }
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
Example Response: { "UserId": 6, "BarcodeOAN": "123456789012", "IsActive": true }
POST /mobile/v:version/user/set-apple-wallet[/]
Fields
Field | Type | Description | Required |
---|---|---|---|
UserId | The ID of the user whose balance needs to be updated. |
YES | |
BarcodeOAN | The OAN barcode associated with the pass. |
YES | |
IsActive | Boolean flag that indicates if the pass is active or inactive. Value should be 1 if true (pass is installed and balance updates should be sent )or 0 if false (pass has been removed and balance updates should no longer be sent). |
YES | |
UserId | The ID of the user whose balance needs to be updated. |
YES | |
BarcodeOAN | The OAN barcode associated with the pass. |
YES | |
IsActive | Boolean flag that indicates if the pass is active or inactive. Value should be 1 if true (pass is installed and balance updates should be sent )or 0 if false (pass has been removed and balance updates should no longer be sent). |
YES | |
UserId | The ID of the user whose balance needs to be updated. |
YES | |
BarcodeOAN | The OAN barcode associated with the pass. |
YES | |
IsActive | Boolean flag that indicates if the pass is active or inactive. Value should be 1 if true (pass is installed and balance updates should be sent )or 0 if false (pass has been removed and balance updates should no longer be sent). |
YES | |
UserId | The ID of the user whose balance needs to be updated. |
YES | |
BarcodeOAN | The OAN barcode associated with the pass. |
YES | |
IsActive | Boolean flag that indicates if the pass is active or inactive. Value should be 1 if true (pass is installed and balance updates should be sent )or 0 if false (pass has been removed and balance updates should no longer be sent). |
YES |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json |
Body
Example Request: { "UserId": 6, "BarcodeOAN": "123456789012", "IsActive": 1 }
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
Example Response: { "UserId": 6, "BarcodeOAN": "123456789012", "IsActive": true }
POST /mobile/v:version/user/set-apple-wallet[/]
Fields
Field | Type | Description | Required |
---|---|---|---|
UserId | The ID of the user whose balance needs to be updated. |
YES | |
BarcodeOAN | The OAN barcode associated with the pass. |
YES | |
IsActive | Boolean flag that indicates if the pass is active or inactive. Value should be 1 if true (pass is installed and balance updates should be sent )or 0 if false (pass has been removed and balance updates should no longer be sent). |
YES | |
UserId | The ID of the user whose balance needs to be updated. |
YES | |
BarcodeOAN | The OAN barcode associated with the pass. |
YES | |
IsActive | Boolean flag that indicates if the pass is active or inactive. Value should be 1 if true (pass is installed and balance updates should be sent )or 0 if false (pass has been removed and balance updates should no longer be sent). |
YES | |
UserId | The ID of the user whose balance needs to be updated. |
YES | |
BarcodeOAN | The OAN barcode associated with the pass. |
YES | |
IsActive | Boolean flag that indicates if the pass is active or inactive. Value should be 1 if true (pass is installed and balance updates should be sent )or 0 if false (pass has been removed and balance updates should no longer be sent). |
YES | |
UserId | The ID of the user whose balance needs to be updated. |
YES | |
BarcodeOAN | The OAN barcode associated with the pass. |
YES | |
IsActive | Boolean flag that indicates if the pass is active or inactive. Value should be 1 if true (pass is installed and balance updates should be sent )or 0 if false (pass has been removed and balance updates should no longer be sent). |
YES |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json |
Body
Example Request: { "UserId": 6, "BarcodeOAN": "123456789012", "IsActive": 1 }
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
Example Response: { "UserId": 6, "BarcodeOAN": "123456789012", "IsActive": true }
UserAutoReloadSetup
This API endpoint will allow you to add an Auto Reload (Recurring top off load) to your account.
POST /mobile/v:version/user/cards/:oan_number/auto-reload-setup[/]
Fields
Field | Type | Description | Required |
---|---|---|---|
id | Primary id of the auto reload setup. If this is null, a new setup will be created, else the current one will be updated. |
NO | |
funding_source_id | Alphanumeric ID (token) of the fund source (credit/debit card or payroll) from which the dollar value should be imported/charged. |
YES | |
type | Options: "regular", "adp" Default is regular if type is unset or any other value. |
NO | |
threshold | When balance falls below this amount, the "amount" will be loaded onto the card. |
YES | |
amount | Amount of money to be loaded to the card. |
YES | |
status | Turn on or off. 1 or 0. |
YES | |
id | Primary id of the auto reload setup. If this is null, a new setup will be created, else the current one will be updated. |
NO | |
funding_source_id | Alphanumeric ID (token) of the fund source (credit/debit card or payroll) from which the dollar value should be imported/charged. |
YES | |
type | Options: "regular", "adp" Default is regular if type is unset or any other value. |
NO | |
threshold | When balance falls below this amount, the "amount" will be loaded onto the card. |
YES | |
amount | Amount of money to be loaded to the card. |
YES | |
status | Turn on or off. 1 or 0. |
YES | |
id | Primary id of the auto reload setup. If this is null, a new setup will be created, else the current one will be updated. |
NO | |
funding_source_id | Alphanumeric ID (token) of the fund source (credit/debit card or payroll) from which the dollar value should be imported/charged. |
YES | |
type | Options: "regular", "adp" Default is regular if type is unset or any other value. |
NO | |
threshold | When balance falls below this amount, the "amount" will be loaded onto the card. |
YES | |
amount | Amount of money to be loaded to the card. |
YES | |
status | Turn on or off. 1 or 0. |
YES | |
id | Primary id of the auto reload setup. If this is null, a new setup will be created, else the current one will be updated. |
NO | |
funding_source_id | Alphanumeric ID (token) of the fund source (credit/debit card or payroll) from which the dollar value should be imported/charged. |
YES | |
type | Options: "regular", "adp" Default is regular if type is unset or any other value. |
NO | |
threshold | When balance falls below this amount, the "amount" will be loaded onto the card. |
YES | |
amount | Amount of money to be loaded to the card. |
YES | |
status | Turn on or off. 1 or 0. |
YES |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json |
Body
CREATE { "funding_source_id": "35", "type": "adp", "threshold": "50.00", "amount": "10.00", "status": "1" } OR UPDATE { "id": "20", "funding_source_id": "35", "type": "adp", "threshold": "50.00", "amount": "10.00", "status": "1" }
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
{ "success": "true" }
POST /mobile/v:version/user/cards/:oan_number/auto-reload-setup[/]
Fields
Field | Type | Description | Required |
---|---|---|---|
id | Primary id of the auto reload setup. If this is null, a new setup will be created, else the current one will be updated. |
NO | |
funding_source_id | Alphanumeric ID (token) of the fund source (credit/debit card or payroll) from which the dollar value should be imported/charged. |
YES | |
type | Options: "regular", "adp" Default is regular if type is unset or any other value. |
NO | |
threshold | When balance falls below this amount, the "amount" will be loaded onto the card. |
YES | |
amount | Amount of money to be loaded to the card. |
YES | |
status | Turn on or off. 1 or 0. |
YES | |
id | Primary id of the auto reload setup. If this is null, a new setup will be created, else the current one will be updated. |
NO | |
funding_source_id | Alphanumeric ID (token) of the fund source (credit/debit card or payroll) from which the dollar value should be imported/charged. |
YES | |
type | Options: "regular", "adp" Default is regular if type is unset or any other value. |
NO | |
threshold | When balance falls below this amount, the "amount" will be loaded onto the card. |
YES | |
amount | Amount of money to be loaded to the card. |
YES | |
status | Turn on or off. 1 or 0. |
YES | |
id | Primary id of the auto reload setup. If this is null, a new setup will be created, else the current one will be updated. |
NO | |
funding_source_id | Alphanumeric ID (token) of the fund source (credit/debit card or payroll) from which the dollar value should be imported/charged. |
YES | |
type | Options: "regular", "adp" Default is regular if type is unset or any other value. |
NO | |
threshold | When balance falls below this amount, the "amount" will be loaded onto the card. |
YES | |
amount | Amount of money to be loaded to the card. |
YES | |
status | Turn on or off. 1 or 0. |
YES | |
id | Primary id of the auto reload setup. If this is null, a new setup will be created, else the current one will be updated. |
NO | |
funding_source_id | Alphanumeric ID (token) of the fund source (credit/debit card or payroll) from which the dollar value should be imported/charged. |
YES | |
type | Options: "regular", "adp" Default is regular if type is unset or any other value. |
NO | |
threshold | When balance falls below this amount, the "amount" will be loaded onto the card. |
YES | |
amount | Amount of money to be loaded to the card. |
YES | |
status | Turn on or off. 1 or 0. |
YES |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json |
Body
CREATE { "funding_source_id": "35", "type": "adp", "threshold": "50.00", "amount": "10.00", "status": "1" } OR UPDATE { "id": "20", "funding_source_id": "35", "type": "adp", "threshold": "50.00", "amount": "10.00", "status": "1" }
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
{ "success": "true" }
POST /mobile/v:version/user/cards/:oan_number/auto-reload-setup[/]
Fields
Field | Type | Description | Required |
---|---|---|---|
id | Primary id of the auto reload setup. If this is null, a new setup will be created, else the current one will be updated. |
NO | |
funding_source_id | Alphanumeric ID (token) of the fund source (credit/debit card or payroll) from which the dollar value should be imported/charged. |
YES | |
type | Options: "regular", "adp" Default is regular if type is unset or any other value. |
NO | |
threshold | When balance falls below this amount, the "amount" will be loaded onto the card. |
YES | |
amount | Amount of money to be loaded to the card. |
YES | |
status | Turn on or off. 1 or 0. |
YES | |
id | Primary id of the auto reload setup. If this is null, a new setup will be created, else the current one will be updated. |
NO | |
funding_source_id | Alphanumeric ID (token) of the fund source (credit/debit card or payroll) from which the dollar value should be imported/charged. |
YES | |
type | Options: "regular", "adp" Default is regular if type is unset or any other value. |
NO | |
threshold | When balance falls below this amount, the "amount" will be loaded onto the card. |
YES | |
amount | Amount of money to be loaded to the card. |
YES | |
status | Turn on or off. 1 or 0. |
YES | |
id | Primary id of the auto reload setup. If this is null, a new setup will be created, else the current one will be updated. |
NO | |
funding_source_id | Alphanumeric ID (token) of the fund source (credit/debit card or payroll) from which the dollar value should be imported/charged. |
YES | |
type | Options: "regular", "adp" Default is regular if type is unset or any other value. |
NO | |
threshold | When balance falls below this amount, the "amount" will be loaded onto the card. |
YES | |
amount | Amount of money to be loaded to the card. |
YES | |
status | Turn on or off. 1 or 0. |
YES | |
id | Primary id of the auto reload setup. If this is null, a new setup will be created, else the current one will be updated. |
NO | |
funding_source_id | Alphanumeric ID (token) of the fund source (credit/debit card or payroll) from which the dollar value should be imported/charged. |
YES | |
type | Options: "regular", "adp" Default is regular if type is unset or any other value. |
NO | |
threshold | When balance falls below this amount, the "amount" will be loaded onto the card. |
YES | |
amount | Amount of money to be loaded to the card. |
YES | |
status | Turn on or off. 1 or 0. |
YES |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json |
Body
CREATE { "funding_source_id": "35", "type": "adp", "threshold": "50.00", "amount": "10.00", "status": "1" } OR UPDATE { "id": "20", "funding_source_id": "35", "type": "adp", "threshold": "50.00", "amount": "10.00", "status": "1" }
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
{ "success": "true" }
POST /mobile/v:version/user/cards/:oan_number/auto-reload-setup[/]
Fields
Field | Type | Description | Required |
---|---|---|---|
id | Primary id of the auto reload setup. If this is null, a new setup will be created, else the current one will be updated. |
NO | |
funding_source_id | Alphanumeric ID (token) of the fund source (credit/debit card or payroll) from which the dollar value should be imported/charged. |
YES | |
type | Options: "regular", "adp" Default is regular if type is unset or any other value. |
NO | |
threshold | When balance falls below this amount, the "amount" will be loaded onto the card. |
YES | |
amount | Amount of money to be loaded to the card. |
YES | |
status | Turn on or off. 1 or 0. |
YES | |
id | Primary id of the auto reload setup. If this is null, a new setup will be created, else the current one will be updated. |
NO | |
funding_source_id | Alphanumeric ID (token) of the fund source (credit/debit card or payroll) from which the dollar value should be imported/charged. |
YES | |
type | Options: "regular", "adp" Default is regular if type is unset or any other value. |
NO | |
threshold | When balance falls below this amount, the "amount" will be loaded onto the card. |
YES | |
amount | Amount of money to be loaded to the card. |
YES | |
status | Turn on or off. 1 or 0. |
YES | |
id | Primary id of the auto reload setup. If this is null, a new setup will be created, else the current one will be updated. |
NO | |
funding_source_id | Alphanumeric ID (token) of the fund source (credit/debit card or payroll) from which the dollar value should be imported/charged. |
YES | |
type | Options: "regular", "adp" Default is regular if type is unset or any other value. |
NO | |
threshold | When balance falls below this amount, the "amount" will be loaded onto the card. |
YES | |
amount | Amount of money to be loaded to the card. |
YES | |
status | Turn on or off. 1 or 0. |
YES | |
id | Primary id of the auto reload setup. If this is null, a new setup will be created, else the current one will be updated. |
NO | |
funding_source_id | Alphanumeric ID (token) of the fund source (credit/debit card or payroll) from which the dollar value should be imported/charged. |
YES | |
type | Options: "regular", "adp" Default is regular if type is unset or any other value. |
NO | |
threshold | When balance falls below this amount, the "amount" will be loaded onto the card. |
YES | |
amount | Amount of money to be loaded to the card. |
YES | |
status | Turn on or off. 1 or 0. |
YES |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json |
Body
CREATE { "funding_source_id": "35", "type": "adp", "threshold": "50.00", "amount": "10.00", "status": "1" } OR UPDATE { "id": "20", "funding_source_id": "35", "type": "adp", "threshold": "50.00", "amount": "10.00", "status": "1" }
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
{ "success": "true" }
UserCardNew
This API endpoint will allow to tie an existing OAN card that is not yet associated with any user, to the given user.
POST /mobile/v:version/user/add-card[/]
Fields
Field | Type | Description | Required |
---|---|---|---|
oan | Any existing OAN/card number that is not registered yet but already active. |
YES | |
oan | Any existing OAN/card number that is not registered yet but already active. |
YES | |
oan | Any existing OAN/card number that is not registered yet but already active. |
YES | |
oan | Any existing OAN/card number that is not registered yet but already active. |
YES |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json |
Body
Example Request: { "oan": "20200000085821", }
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
Example Response: { "success": true }
POST /mobile/v:version/user/add-card[/]
Fields
Field | Type | Description | Required |
---|---|---|---|
oan | Any existing OAN/card number that is not registered yet but already active. |
YES | |
oan | Any existing OAN/card number that is not registered yet but already active. |
YES | |
oan | Any existing OAN/card number that is not registered yet but already active. |
YES | |
oan | Any existing OAN/card number that is not registered yet but already active. |
YES |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json |
Body
Example Request: { "oan": "20200000085821", }
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
Example Response: { "success": true }
POST /mobile/v:version/user/add-card[/]
Fields
Field | Type | Description | Required |
---|---|---|---|
oan | Any existing OAN/card number that is not registered yet but already active. |
YES | |
oan | Any existing OAN/card number that is not registered yet but already active. |
YES | |
oan | Any existing OAN/card number that is not registered yet but already active. |
YES | |
oan | Any existing OAN/card number that is not registered yet but already active. |
YES |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json |
Body
Example Request: { "oan": "20200000085821", }
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
Example Response: { "success": true }
POST /mobile/v:version/user/add-card[/]
Fields
Field | Type | Description | Required |
---|---|---|---|
oan | Any existing OAN/card number that is not registered yet but already active. |
YES | |
oan | Any existing OAN/card number that is not registered yet but already active. |
YES | |
oan | Any existing OAN/card number that is not registered yet but already active. |
YES | |
oan | Any existing OAN/card number that is not registered yet but already active. |
YES |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json |
Body
Example Request: { "oan": "20200000085821", }
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
Example Response: { "success": true }
UserCardSetPrimary
This API endpoint will allow to set an existing OAN card that belongs to the given user as the primary card.
POST /mobile/v:version/user/set-primary-card[/]
Fields
Field | Type | Description | Required |
---|---|---|---|
oan | Any existing OAN number that belongs to the given user. |
YES | |
oan | Any existing OAN number that belongs to the given user. |
YES | |
oan | Any existing OAN number that belongs to the given user. |
YES | |
oan | Any existing OAN number that belongs to the given user. |
YES |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json |
Body
Example Request: { "oan": "20200000085821", }
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
Example Response: { "success": true }
POST /mobile/v:version/user/set-primary-card[/]
Fields
Field | Type | Description | Required |
---|---|---|---|
oan | Any existing OAN number that belongs to the given user. |
YES | |
oan | Any existing OAN number that belongs to the given user. |
YES | |
oan | Any existing OAN number that belongs to the given user. |
YES | |
oan | Any existing OAN number that belongs to the given user. |
YES |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json |
Body
Example Request: { "oan": "20200000085821", }
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
Example Response: { "success": true }
POST /mobile/v:version/user/set-primary-card[/]
Fields
Field | Type | Description | Required |
---|---|---|---|
oan | Any existing OAN number that belongs to the given user. |
YES | |
oan | Any existing OAN number that belongs to the given user. |
YES | |
oan | Any existing OAN number that belongs to the given user. |
YES | |
oan | Any existing OAN number that belongs to the given user. |
YES |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json |
Body
Example Request: { "oan": "20200000085821", }
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
Example Response: { "success": true }
POST /mobile/v:version/user/set-primary-card[/]
Fields
Field | Type | Description | Required |
---|---|---|---|
oan | Any existing OAN number that belongs to the given user. |
YES | |
oan | Any existing OAN number that belongs to the given user. |
YES | |
oan | Any existing OAN number that belongs to the given user. |
YES | |
oan | Any existing OAN number that belongs to the given user. |
YES |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json |
Body
Example Request: { "oan": "20200000085821", }
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
Example Response: { "success": true }
UserCharities
This API endpoint will allow to get the list of charity organizations available for user to elect for donating a portion of their purchase transactions to their designated charity.
GET /mobile/v:version/user/charities
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
Example Response: { "charity_list": [{ "id": 1, "name": "Charity 1", "thumbnail_url": "/images/charity_1.png" }, { "id": 2, "name": "Charity 2", "thumbnail_url": "/images/charity_2.png" }] }
GET /mobile/v:version/user/charities
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
Example Response: { "charity_list": [{ "id": 1, "name": "Charity 1", "thumbnail_url": "/images/charity_1.png" }, { "id": 2, "name": "Charity 2", "thumbnail_url": "/images/charity_2.png" }] }
GET /mobile/v:version/user/charities
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
Example Response: { "charity_list": [{ "id": 1, "name": "Charity 1", "thumbnail_url": "/images/charity_1.png" }, { "id": 2, "name": "Charity 2", "thumbnail_url": "/images/charity_2.png" }] }
GET /mobile/v:version/user/charities
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
Example Response: { "charity_list": [{ "id": 1, "name": "Charity 1", "thumbnail_url": "/images/charity_1.png" }, { "id": 2, "name": "Charity 2", "thumbnail_url": "/images/charity_2.png" }] }
UserCharityDetails
This API endpoint will allow to get detailed information of a particular charity as identified by its charity ID.
GET /mobile/v:version/user/charities/:charity_id[/]
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
Example Response: { "id": 1, "name": "Charity 1", "thumbnail_url": "/images/charity_thumbnail_1.png", "image_url": "/images/charity_1.png", "desc": "Charity 1 Description", "category": "Charity 1 Category", "website": "www.example.com", "city": "New York", "state": "NY" }
GET /mobile/v:version/user/charities/:charity_id[/]
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
Example Response: { "id": 1, "name": "Charity 1", "thumbnail_url": "/images/charity_thumbnail_1.png", "image_url": "/images/charity_1.png", "desc": "Charity 1 Description", "category": "Charity 1 Category", "website": "www.example.com", "city": "New York", "state": "NY" }
GET /mobile/v:version/user/charities/:charity_id[/]
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
Example Response: { "id": 1, "name": "Charity 1", "thumbnail_url": "/images/charity_thumbnail_1.png", "image_url": "/images/charity_1.png", "desc": "Charity 1 Description", "category": "Charity 1 Category", "website": "www.example.com", "city": "New York", "state": "NY" }
GET /mobile/v:version/user/charities/:charity_id[/]
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
Example Response: { "id": 1, "name": "Charity 1", "thumbnail_url": "/images/charity_thumbnail_1.png", "image_url": "/images/charity_1.png", "desc": "Charity 1 Description", "category": "Charity 1 Category", "website": "www.example.com", "city": "New York", "state": "NY" }
UserDetails
This API endpoint will allow to get the detailed information for a given user ID, such as first name, last name, email address, OAN numbers belonged to, address, phone.
GET /mobile/v:version/user[/]
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
Example Response: { "id": "12345", "oans": [ "12345678901" ], "first_name": "John", "last_name": "Doe", "email": "test@test.com", "phone": "5555555555", "address": "123 test st.", "city": "new york", "state": "NY", "zip": "10001" "group_code": "usconnect", "group_id": "123", "charity_id": "123", "charity_name": "Test Charity" }
GET /mobile/v:version/user[/]
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
Example Response: { "id": "12345", "oans": [ "12345678901" ], "first_name": "John", "last_name": "Doe", "email": "test@test.com", "phone": "5555555555", "address": "123 test st.", "city": "new york", "state": "NY", "zip": "10001" "group_code": "usconnect", "group_id": "123", "charity_id": "123", "charity_name": "Test Charity" }
GET /mobile/v:version/user[/]
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
Example Response: { "id": "12345", "oans": [ "12345678901" ], "first_name": "John", "last_name": "Doe", "email": "test@test.com", "phone": "5555555555", "address": "123 test st.", "city": "new york", "state": "NY", "zip": "10001" "group_code": "usconnect", "group_id": "123", "charity_id": "123", "charity_name": "Test Charity" }
GET /mobile/v:version/user[/]
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
Example Response: { "id": "12345", "oans": [ "12345678901" ], "first_name": "John", "last_name": "Doe", "email": "test@test.com", "phone": "5555555555", "address": "123 test st.", "city": "new york", "state": "NY", "zip": "10001" "group_code": "usconnect", "group_id": "123", "charity_id": "123", "charity_name": "Test Charity" }
UserEditProfile
This API endpoint will allow the user to edit profile settings.
POST /mobile/v:version/user/edit-profile[/]
Fields
Field | Type | Description | Required |
---|---|---|---|
first_name | First name of the user |
YES | |
last_name | Last name of the user to be registered |
YES | |
Email address of the user |
YES | ||
new_password | New Password for the user |
NO | |
address | Street address of the user (max number of 100 characters) |
NO | |
city | City name as part of the full address |
NO | |
state | Postal code of the state as part of the full address, such as CA for California. For complete list of postal code name for US states please see: http://www.infoplease.com/ipa/A0110468.html |
NO | |
zip | Zip code as part of the full address |
NO | |
phone | Phone number of the user |
NO | |
phone_type | Type of phone: C (cell), H (home), or W (work). |
NO | |
language | string | Language |
NO |
first_name | First name of the user |
YES | |
last_name | Last name of the user to be registered |
YES | |
Email address of the user |
YES | ||
new_password | New Password for the user |
NO | |
address | Street address of the user (max number of 100 characters) |
NO | |
city | City name as part of the full address |
NO | |
state | Postal code of the state as part of the full address, such as CA for California. For complete list of postal code name for US states please see: http://www.infoplease.com/ipa/A0110468.html |
NO | |
zip | Zip code as part of the full address |
NO | |
phone | Phone number of the user |
NO | |
phone_type | Type of phone: C (cell), H (home), or W (work). |
NO | |
language | string | Language |
NO |
first_name | First name of the user |
YES | |
last_name | Last name of the user to be registered |
YES | |
Email address of the user |
YES | ||
new_password | New Password for the user |
NO | |
address | Street address of the user (max number of 100 characters) |
NO | |
city | City name as part of the full address |
NO | |
state | Postal code of the state as part of the full address, such as CA for California. For complete list of postal code name for US states please see: http://www.infoplease.com/ipa/A0110468.html |
NO | |
zip | Zip code as part of the full address |
NO | |
phone | Phone number of the user |
NO | |
phone_type | Type of phone: C (cell), H (home), or W (work). |
NO | |
language | string | Language |
NO |
first_name | First name of the user |
YES | |
last_name | Last name of the user to be registered |
YES | |
Email address of the user |
YES | ||
new_password | New Password for the user |
NO | |
address | Street address of the user (max number of 100 characters) |
NO | |
city | City name as part of the full address |
NO | |
state | Postal code of the state as part of the full address, such as CA for California. For complete list of postal code name for US states please see: http://www.infoplease.com/ipa/A0110468.html |
NO | |
zip | Zip code as part of the full address |
NO | |
phone | Phone number of the user |
NO | |
phone_type | Type of phone: C (cell), H (home), or W (work). |
NO | |
language | string | Language |
NO |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json |
Body
Example Request: { "first_name": "john", "last_name": "doe", "email": "test@test.com", "password": "abc123", "address": "123 test st.", "city": "new york", "state": "NY", "zip": "10001", "phone": "5555555555", "group_code": "sprout", "phone_type": "C" }
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
Example response: { "id": 123, "first_name": "john", "last_name": "doe", "email": "test@test.com", "phone": "5555555555", "address": "123 abc st.", "city": "New York", "state": "NY", "zip": "10001" }
POST /mobile/v:version/user/edit-profile[/]
Fields
Field | Type | Description | Required |
---|---|---|---|
first_name | First name of the user |
YES | |
last_name | Last name of the user to be registered |
YES | |
Email address of the user |
YES | ||
new_password | New Password for the user |
NO | |
address | Street address of the user (max number of 100 characters) |
NO | |
city | City name as part of the full address |
NO | |
state | Postal code of the state as part of the full address, such as CA for California. For complete list of postal code name for US states please see: http://www.infoplease.com/ipa/A0110468.html |
NO | |
zip | Zip code as part of the full address |
NO | |
phone | Phone number of the user |
NO | |
phone_type | Type of phone: C (cell), H (home), or W (work). |
NO | |
language | string | Language |
NO |
first_name | First name of the user |
YES | |
last_name | Last name of the user to be registered |
YES | |
Email address of the user |
YES | ||
new_password | New Password for the user |
NO | |
address | Street address of the user (max number of 100 characters) |
NO | |
city | City name as part of the full address |
NO | |
state | Postal code of the state as part of the full address, such as CA for California. For complete list of postal code name for US states please see: http://www.infoplease.com/ipa/A0110468.html |
NO | |
zip | Zip code as part of the full address |
NO | |
phone | Phone number of the user |
NO | |
phone_type | Type of phone: C (cell), H (home), or W (work). |
NO | |
language | string | Language |
NO |
first_name | First name of the user |
YES | |
last_name | Last name of the user to be registered |
YES | |
Email address of the user |
YES | ||
new_password | New Password for the user |
NO | |
address | Street address of the user (max number of 100 characters) |
NO | |
city | City name as part of the full address |
NO | |
state | Postal code of the state as part of the full address, such as CA for California. For complete list of postal code name for US states please see: http://www.infoplease.com/ipa/A0110468.html |
NO | |
zip | Zip code as part of the full address |
NO | |
phone | Phone number of the user |
NO | |
phone_type | Type of phone: C (cell), H (home), or W (work). |
NO | |
language | string | Language |
NO |
first_name | First name of the user |
YES | |
last_name | Last name of the user to be registered |
YES | |
Email address of the user |
YES | ||
new_password | New Password for the user |
NO | |
address | Street address of the user (max number of 100 characters) |
NO | |
city | City name as part of the full address |
NO | |
state | Postal code of the state as part of the full address, such as CA for California. For complete list of postal code name for US states please see: http://www.infoplease.com/ipa/A0110468.html |
NO | |
zip | Zip code as part of the full address |
NO | |
phone | Phone number of the user |
NO | |
phone_type | Type of phone: C (cell), H (home), or W (work). |
NO | |
language | string | Language |
NO |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json |
Body
Example Request: { "first_name": "john", "last_name": "doe", "email": "test@test.com", "password": "abc123", "address": "123 test st.", "city": "new york", "state": "NY", "zip": "10001", "phone": "5555555555", "group_code": "sprout", "phone_type": "C" }
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
Example response: { "id": 123, "first_name": "john", "last_name": "doe", "email": "test@test.com", "phone": "5555555555", "address": "123 abc st.", "city": "New York", "state": "NY", "zip": "10001" }
POST /mobile/v:version/user/edit-profile[/]
Fields
Field | Type | Description | Required |
---|---|---|---|
first_name | First name of the user |
YES | |
last_name | Last name of the user to be registered |
YES | |
Email address of the user |
YES | ||
new_password | New Password for the user |
NO | |
address | Street address of the user (max number of 100 characters) |
NO | |
city | City name as part of the full address |
NO | |
state | Postal code of the state as part of the full address, such as CA for California. For complete list of postal code name for US states please see: http://www.infoplease.com/ipa/A0110468.html |
NO | |
zip | Zip code as part of the full address |
NO | |
phone | Phone number of the user |
NO | |
phone_type | Type of phone: C (cell), H (home), or W (work). |
NO | |
language | string | Language |
NO |
first_name | First name of the user |
YES | |
last_name | Last name of the user to be registered |
YES | |
Email address of the user |
YES | ||
new_password | New Password for the user |
NO | |
address | Street address of the user (max number of 100 characters) |
NO | |
city | City name as part of the full address |
NO | |
state | Postal code of the state as part of the full address, such as CA for California. For complete list of postal code name for US states please see: http://www.infoplease.com/ipa/A0110468.html |
NO | |
zip | Zip code as part of the full address |
NO | |
phone | Phone number of the user |
NO | |
phone_type | Type of phone: C (cell), H (home), or W (work). |
NO | |
language | string | Language |
NO |
first_name | First name of the user |
YES | |
last_name | Last name of the user to be registered |
YES | |
Email address of the user |
YES | ||
new_password | New Password for the user |
NO | |
address | Street address of the user (max number of 100 characters) |
NO | |
city | City name as part of the full address |
NO | |
state | Postal code of the state as part of the full address, such as CA for California. For complete list of postal code name for US states please see: http://www.infoplease.com/ipa/A0110468.html |
NO | |
zip | Zip code as part of the full address |
NO | |
phone | Phone number of the user |
NO | |
phone_type | Type of phone: C (cell), H (home), or W (work). |
NO | |
language | string | Language |
NO |
first_name | First name of the user |
YES | |
last_name | Last name of the user to be registered |
YES | |
Email address of the user |
YES | ||
new_password | New Password for the user |
NO | |
address | Street address of the user (max number of 100 characters) |
NO | |
city | City name as part of the full address |
NO | |
state | Postal code of the state as part of the full address, such as CA for California. For complete list of postal code name for US states please see: http://www.infoplease.com/ipa/A0110468.html |
NO | |
zip | Zip code as part of the full address |
NO | |
phone | Phone number of the user |
NO | |
phone_type | Type of phone: C (cell), H (home), or W (work). |
NO | |
language | string | Language |
NO |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json |
Body
Example Request: { "first_name": "john", "last_name": "doe", "email": "test@test.com", "password": "abc123", "address": "123 test st.", "city": "new york", "state": "NY", "zip": "10001", "phone": "5555555555", "group_code": "sprout", "phone_type": "C" }
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
Example response: { "id": 123, "first_name": "john", "last_name": "doe", "email": "test@test.com", "phone": "5555555555", "address": "123 abc st.", "city": "New York", "state": "NY", "zip": "10001" }
POST /mobile/v:version/user/edit-profile[/]
Fields
Field | Type | Description | Required |
---|---|---|---|
first_name | First name of the user |
YES | |
last_name | Last name of the user to be registered |
YES | |
Email address of the user |
YES | ||
new_password | New Password for the user |
NO | |
address | Street address of the user (max number of 100 characters) |
NO | |
city | City name as part of the full address |
NO | |
state | Postal code of the state as part of the full address, such as CA for California. For complete list of postal code name for US states please see: http://www.infoplease.com/ipa/A0110468.html |
NO | |
zip | Zip code as part of the full address |
NO | |
phone | Phone number of the user |
NO | |
phone_type | Type of phone: C (cell), H (home), or W (work). |
NO | |
language | string | Language |
NO |
first_name | First name of the user |
YES | |
last_name | Last name of the user to be registered |
YES | |
Email address of the user |
YES | ||
new_password | New Password for the user |
NO | |
address | Street address of the user (max number of 100 characters) |
NO | |
city | City name as part of the full address |
NO | |
state | Postal code of the state as part of the full address, such as CA for California. For complete list of postal code name for US states please see: http://www.infoplease.com/ipa/A0110468.html |
NO | |
zip | Zip code as part of the full address |
NO | |
phone | Phone number of the user |
NO | |
phone_type | Type of phone: C (cell), H (home), or W (work). |
NO | |
language | string | Language |
NO |
first_name | First name of the user |
YES | |
last_name | Last name of the user to be registered |
YES | |
Email address of the user |
YES | ||
new_password | New Password for the user |
NO | |
address | Street address of the user (max number of 100 characters) |
NO | |
city | City name as part of the full address |
NO | |
state | Postal code of the state as part of the full address, such as CA for California. For complete list of postal code name for US states please see: http://www.infoplease.com/ipa/A0110468.html |
NO | |
zip | Zip code as part of the full address |
NO | |
phone | Phone number of the user |
NO | |
phone_type | Type of phone: C (cell), H (home), or W (work). |
NO | |
language | string | Language |
NO |
first_name | First name of the user |
YES | |
last_name | Last name of the user to be registered |
YES | |
Email address of the user |
YES | ||
new_password | New Password for the user |
NO | |
address | Street address of the user (max number of 100 characters) |
NO | |
city | City name as part of the full address |
NO | |
state | Postal code of the state as part of the full address, such as CA for California. For complete list of postal code name for US states please see: http://www.infoplease.com/ipa/A0110468.html |
NO | |
zip | Zip code as part of the full address |
NO | |
phone | Phone number of the user |
NO | |
phone_type | Type of phone: C (cell), H (home), or W (work). |
NO | |
language | string | Language |
NO |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json |
Body
Example Request: { "first_name": "john", "last_name": "doe", "email": "test@test.com", "password": "abc123", "address": "123 test st.", "city": "new york", "state": "NY", "zip": "10001", "phone": "5555555555", "group_code": "sprout", "phone_type": "C" }
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
Example response: { "id": 123, "first_name": "john", "last_name": "doe", "email": "test@test.com", "phone": "5555555555", "address": "123 abc st.", "city": "New York", "state": "NY", "zip": "10001" }
UserFrame
This API endpoint will return a view for PCI adding cards. After submitting the page will be redirected appending either the keyword success or error. If Error one or more messages will also be included. The possible messages are - Nickname is required, max length is 100 characters. - Zip Code is required, format is nnnnn or nnnnn-nnnn. - Billing address is required. - Billing city is required. - Billing state is required.
GET /mobile/v:version/userframe[/]
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /mobile/v:version/userframe[/]
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /mobile/v:version/userframe[/]
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /mobile/v:version/userframe[/]
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
UserFundingDelete
This API endpoint will allow to remove a particular funding source setup for the given user.
DELETE /mobile/v:version/user/funding/:funding_source_id[/]
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 204: No Content
- 404: Not Found
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
DELETE /mobile/v:version/user/funding/:funding_source_id[/]
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 204: No Content
- 404: Not Found
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
DELETE /mobile/v:version/user/funding/:funding_source_id[/]
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 204: No Content
- 404: Not Found
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
DELETE /mobile/v:version/user/funding/:funding_source_id[/]
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 204: No Content
- 404: Not Found
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
UserFundingEdit
This API endpoint will allow to you to edit a funding source. Updating Zipcode, Expiration and nickname.
POST /mobile/v:version/user/funding/edit/:funding_source_id[/]
Fields
Field | Type | Description | Required |
---|---|---|---|
nickname | Nickname for the funding source. |
NO | |
zipcode | Zip code associated with the card. |
YES | |
expiration_date | Expiration date of the card in the format of “mm/yyyy”. For example, if the card expires in 2016 December, the value will be “12/2016” |
YES | |
nickname | Nickname for the funding source. |
NO | |
zipcode | Zip code associated with the card. |
YES | |
expiration_date | Expiration date of the card in the format of “mm/yyyy”. For example, if the card expires in 2016 December, the value will be “12/2016” |
YES | |
nickname | Nickname for the funding source. |
NO | |
zipcode | Zip code associated with the card. |
YES | |
expiration_date | Expiration date of the card in the format of “mm/yyyy”. For example, if the card expires in 2016 December, the value will be “12/2016” |
YES | |
nickname | Nickname for the funding source. |
NO | |
zipcode | Zip code associated with the card. |
YES | |
expiration_date | Expiration date of the card in the format of “mm/yyyy”. For example, if the card expires in 2016 December, the value will be “12/2016” |
YES |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json |
Body
Example Request: { "nickname": "Amex Test", "zipcode": "75024", "expiration_date": "12/2025" }
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
Example Response: { "success": true, "errors": [] }
POST /mobile/v:version/user/funding/edit/:funding_source_id[/]
Fields
Field | Type | Description | Required |
---|---|---|---|
nickname | Nickname for the funding source. |
NO | |
zipcode | Zip code associated with the card. |
YES | |
expiration_date | Expiration date of the card in the format of “mm/yyyy”. For example, if the card expires in 2016 December, the value will be “12/2016” |
YES | |
nickname | Nickname for the funding source. |
NO | |
zipcode | Zip code associated with the card. |
YES | |
expiration_date | Expiration date of the card in the format of “mm/yyyy”. For example, if the card expires in 2016 December, the value will be “12/2016” |
YES | |
nickname | Nickname for the funding source. |
NO | |
zipcode | Zip code associated with the card. |
YES | |
expiration_date | Expiration date of the card in the format of “mm/yyyy”. For example, if the card expires in 2016 December, the value will be “12/2016” |
YES | |
nickname | Nickname for the funding source. |
NO | |
zipcode | Zip code associated with the card. |
YES | |
expiration_date | Expiration date of the card in the format of “mm/yyyy”. For example, if the card expires in 2016 December, the value will be “12/2016” |
YES |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json |
Body
Example Request: { "nickname": "Amex Test", "zipcode": "75024", "expiration_date": "12/2025" }
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
Example Response: { "success": true, "errors": [] }
POST /mobile/v:version/user/funding/edit/:funding_source_id[/]
Fields
Field | Type | Description | Required |
---|---|---|---|
nickname | Nickname for the funding source. |
NO | |
zipcode | Zip code associated with the card. |
YES | |
expiration_date | Expiration date of the card in the format of “mm/yyyy”. For example, if the card expires in 2016 December, the value will be “12/2016” |
YES | |
nickname | Nickname for the funding source. |
NO | |
zipcode | Zip code associated with the card. |
YES | |
expiration_date | Expiration date of the card in the format of “mm/yyyy”. For example, if the card expires in 2016 December, the value will be “12/2016” |
YES | |
nickname | Nickname for the funding source. |
NO | |
zipcode | Zip code associated with the card. |
YES | |
expiration_date | Expiration date of the card in the format of “mm/yyyy”. For example, if the card expires in 2016 December, the value will be “12/2016” |
YES | |
nickname | Nickname for the funding source. |
NO | |
zipcode | Zip code associated with the card. |
YES | |
expiration_date | Expiration date of the card in the format of “mm/yyyy”. For example, if the card expires in 2016 December, the value will be “12/2016” |
YES |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json |
Body
Example Request: { "nickname": "Amex Test", "zipcode": "75024", "expiration_date": "12/2025" }
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
Example Response: { "success": true, "errors": [] }
POST /mobile/v:version/user/funding/edit/:funding_source_id[/]
Fields
Field | Type | Description | Required |
---|---|---|---|
nickname | Nickname for the funding source. |
NO | |
zipcode | Zip code associated with the card. |
YES | |
expiration_date | Expiration date of the card in the format of “mm/yyyy”. For example, if the card expires in 2016 December, the value will be “12/2016” |
YES | |
nickname | Nickname for the funding source. |
NO | |
zipcode | Zip code associated with the card. |
YES | |
expiration_date | Expiration date of the card in the format of “mm/yyyy”. For example, if the card expires in 2016 December, the value will be “12/2016” |
YES | |
nickname | Nickname for the funding source. |
NO | |
zipcode | Zip code associated with the card. |
YES | |
expiration_date | Expiration date of the card in the format of “mm/yyyy”. For example, if the card expires in 2016 December, the value will be “12/2016” |
YES | |
nickname | Nickname for the funding source. |
NO | |
zipcode | Zip code associated with the card. |
YES | |
expiration_date | Expiration date of the card in the format of “mm/yyyy”. For example, if the card expires in 2016 December, the value will be “12/2016” |
YES |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json |
Body
Example Request: { "nickname": "Amex Test", "zipcode": "75024", "expiration_date": "12/2025" }
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
Example Response: { "success": true, "errors": [] }
UserFundingNew
This API endpoint will allow to add a funding source (credit/debit cards) for the given user so that the user can load cash into their USConnect cards online either through a website or mobile app.
POST /mobile/v:version/user/add-funding
Fields
Field | Type | Description | Required |
---|---|---|---|
nickname | Nickname for the new credit/debit card you are adding as a funding source. |
YES | |
type | Credit/debit card type, possible values: "amex" (American Express), "discover" (Discover), "mastercard" (Mastercard), "visa" (Visa) |
YES | |
zipcode | Zip code associated with the card. |
YES | |
expiration_date | Expiration date of the card in the format of “mm/yyyy”. For example, if the card expires in 2016 December, the value will be “12/2016” |
YES | |
number | Last 4 of Credit Card number. |
YES | |
address | Billing address of the credit/debit card you are adding as a funding source. |
YES | |
city | Billing city of the credit/debit card you are adding as a funding source. |
YES | |
state | Billing state of the credit/debit card you are adding as a funding source. |
YES | |
token | Token from the Heartland iframe |
YES | |
payload | This is the info from heartland using this for logging |
YES | |
nickname | Nickname for the new credit/debit card you are adding as a funding source. |
YES | |
type | Credit/debit card type, possible values: "amex" (American Express), "discover" (Discover), "mastercard" (Mastercard), "visa" (Visa) |
YES | |
zipcode | Zip code associated with the card. |
YES | |
expiration_date | Expiration date of the card in the format of “mm/yyyy”. For example, if the card expires in 2016 December, the value will be “12/2016” |
YES | |
number | Last 4 of Credit Card number. |
YES | |
address | Billing address of the credit/debit card you are adding as a funding source. |
YES | |
city | Billing city of the credit/debit card you are adding as a funding source. |
YES | |
state | Billing state of the credit/debit card you are adding as a funding source. |
YES | |
token | Token from the Heartland iframe |
YES | |
payload | This is the info from heartland using this for logging |
YES | |
nickname | Nickname for the new credit/debit card you are adding as a funding source. |
YES | |
type | Credit/debit card type, possible values: "amex" (American Express), "discover" (Discover), "mastercard" (Mastercard), "visa" (Visa) |
YES | |
zipcode | Zip code associated with the card. |
YES | |
expiration_date | Expiration date of the card in the format of “mm/yyyy”. For example, if the card expires in 2016 December, the value will be “12/2016” |
YES | |
number | Last 4 of Credit Card number. |
YES | |
address | Billing address of the credit/debit card you are adding as a funding source. |
YES | |
city | Billing city of the credit/debit card you are adding as a funding source. |
YES | |
state | Billing state of the credit/debit card you are adding as a funding source. |
YES | |
token | Token from the Heartland iframe |
YES | |
payload | This is the info from heartland using this for logging |
YES | |
nickname | Nickname for the new credit/debit card you are adding as a funding source. |
YES | |
type | Credit/debit card type, possible values: "amex" (American Express), "discover" (Discover), "mastercard" (Mastercard), "visa" (Visa) |
YES | |
zipcode | Zip code associated with the card. |
YES | |
expiration_date | Expiration date of the card in the format of “mm/yyyy”. For example, if the card expires in 2016 December, the value will be “12/2016” |
YES | |
number | Last 4 of Credit Card number. |
YES | |
address | Billing address of the credit/debit card you are adding as a funding source. |
YES | |
city | Billing city of the credit/debit card you are adding as a funding source. |
YES | |
state | Billing state of the credit/debit card you are adding as a funding source. |
YES | |
token | Token from the Heartland iframe |
YES | |
payload | This is the info from heartland using this for logging |
YES |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json |
Body
Example Request: { "nickname": "Amex Test", "type": "amex", "address": "6860", "city": "dallas", "state": "TX", "zipcode": "75024", "number": "372700699251018", "cvv": "1234", "expiration_date": "12/2025" }
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /mobile/v:version/user/add-funding
Fields
Field | Type | Description | Required |
---|---|---|---|
nickname | Nickname for the new credit/debit card you are adding as a funding source. |
YES | |
type | Credit/debit card type, possible values: "amex" (American Express), "discover" (Discover), "mastercard" (Mastercard), "visa" (Visa) |
YES | |
zipcode | Zip code associated with the card. |
YES | |
expiration_date | Expiration date of the card in the format of “mm/yyyy”. For example, if the card expires in 2016 December, the value will be “12/2016” |
YES | |
number | Last 4 of Credit Card number. |
YES | |
address | Billing address of the credit/debit card you are adding as a funding source. |
YES | |
city | Billing city of the credit/debit card you are adding as a funding source. |
YES | |
state | Billing state of the credit/debit card you are adding as a funding source. |
YES | |
token | Token from the Heartland iframe |
YES | |
payload | This is the info from heartland using this for logging |
YES | |
nickname | Nickname for the new credit/debit card you are adding as a funding source. |
YES | |
type | Credit/debit card type, possible values: "amex" (American Express), "discover" (Discover), "mastercard" (Mastercard), "visa" (Visa) |
YES | |
zipcode | Zip code associated with the card. |
YES | |
expiration_date | Expiration date of the card in the format of “mm/yyyy”. For example, if the card expires in 2016 December, the value will be “12/2016” |
YES | |
number | Last 4 of Credit Card number. |
YES | |
address | Billing address of the credit/debit card you are adding as a funding source. |
YES | |
city | Billing city of the credit/debit card you are adding as a funding source. |
YES | |
state | Billing state of the credit/debit card you are adding as a funding source. |
YES | |
token | Token from the Heartland iframe |
YES | |
payload | This is the info from heartland using this for logging |
YES | |
nickname | Nickname for the new credit/debit card you are adding as a funding source. |
YES | |
type | Credit/debit card type, possible values: "amex" (American Express), "discover" (Discover), "mastercard" (Mastercard), "visa" (Visa) |
YES | |
zipcode | Zip code associated with the card. |
YES | |
expiration_date | Expiration date of the card in the format of “mm/yyyy”. For example, if the card expires in 2016 December, the value will be “12/2016” |
YES | |
number | Last 4 of Credit Card number. |
YES | |
address | Billing address of the credit/debit card you are adding as a funding source. |
YES | |
city | Billing city of the credit/debit card you are adding as a funding source. |
YES | |
state | Billing state of the credit/debit card you are adding as a funding source. |
YES | |
token | Token from the Heartland iframe |
YES | |
payload | This is the info from heartland using this for logging |
YES | |
nickname | Nickname for the new credit/debit card you are adding as a funding source. |
YES | |
type | Credit/debit card type, possible values: "amex" (American Express), "discover" (Discover), "mastercard" (Mastercard), "visa" (Visa) |
YES | |
zipcode | Zip code associated with the card. |
YES | |
expiration_date | Expiration date of the card in the format of “mm/yyyy”. For example, if the card expires in 2016 December, the value will be “12/2016” |
YES | |
number | Last 4 of Credit Card number. |
YES | |
address | Billing address of the credit/debit card you are adding as a funding source. |
YES | |
city | Billing city of the credit/debit card you are adding as a funding source. |
YES | |
state | Billing state of the credit/debit card you are adding as a funding source. |
YES | |
token | Token from the Heartland iframe |
YES | |
payload | This is the info from heartland using this for logging |
YES |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json |
Body
Example Request: { "nickname": "Amex Test", "type": "amex", "address": "6860", "city": "dallas", "state": "TX", "zipcode": "75024", "number": "372700699251018", "cvv": "1234", "expiration_date": "12/2025" }
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /mobile/v:version/user/add-funding
Fields
Field | Type | Description | Required |
---|---|---|---|
nickname | Nickname for the new credit/debit card you are adding as a funding source. |
YES | |
type | Credit/debit card type, possible values: "amex" (American Express), "discover" (Discover), "mastercard" (Mastercard), "visa" (Visa) |
YES | |
zipcode | Zip code associated with the card. |
YES | |
expiration_date | Expiration date of the card in the format of “mm/yyyy”. For example, if the card expires in 2016 December, the value will be “12/2016” |
YES | |
number | Last 4 of Credit Card number. |
YES | |
address | Billing address of the credit/debit card you are adding as a funding source. |
YES | |
city | Billing city of the credit/debit card you are adding as a funding source. |
YES | |
state | Billing state of the credit/debit card you are adding as a funding source. |
YES | |
token | Token from the Heartland iframe |
YES | |
payload | This is the info from heartland using this for logging |
YES | |
nickname | Nickname for the new credit/debit card you are adding as a funding source. |
YES | |
type | Credit/debit card type, possible values: "amex" (American Express), "discover" (Discover), "mastercard" (Mastercard), "visa" (Visa) |
YES | |
zipcode | Zip code associated with the card. |
YES | |
expiration_date | Expiration date of the card in the format of “mm/yyyy”. For example, if the card expires in 2016 December, the value will be “12/2016” |
YES | |
number | Last 4 of Credit Card number. |
YES | |
address | Billing address of the credit/debit card you are adding as a funding source. |
YES | |
city | Billing city of the credit/debit card you are adding as a funding source. |
YES | |
state | Billing state of the credit/debit card you are adding as a funding source. |
YES | |
token | Token from the Heartland iframe |
YES | |
payload | This is the info from heartland using this for logging |
YES | |
nickname | Nickname for the new credit/debit card you are adding as a funding source. |
YES | |
type | Credit/debit card type, possible values: "amex" (American Express), "discover" (Discover), "mastercard" (Mastercard), "visa" (Visa) |
YES | |
zipcode | Zip code associated with the card. |
YES | |
expiration_date | Expiration date of the card in the format of “mm/yyyy”. For example, if the card expires in 2016 December, the value will be “12/2016” |
YES | |
number | Last 4 of Credit Card number. |
YES | |
address | Billing address of the credit/debit card you are adding as a funding source. |
YES | |
city | Billing city of the credit/debit card you are adding as a funding source. |
YES | |
state | Billing state of the credit/debit card you are adding as a funding source. |
YES | |
token | Token from the Heartland iframe |
YES | |
payload | This is the info from heartland using this for logging |
YES | |
nickname | Nickname for the new credit/debit card you are adding as a funding source. |
YES | |
type | Credit/debit card type, possible values: "amex" (American Express), "discover" (Discover), "mastercard" (Mastercard), "visa" (Visa) |
YES | |
zipcode | Zip code associated with the card. |
YES | |
expiration_date | Expiration date of the card in the format of “mm/yyyy”. For example, if the card expires in 2016 December, the value will be “12/2016” |
YES | |
number | Last 4 of Credit Card number. |
YES | |
address | Billing address of the credit/debit card you are adding as a funding source. |
YES | |
city | Billing city of the credit/debit card you are adding as a funding source. |
YES | |
state | Billing state of the credit/debit card you are adding as a funding source. |
YES | |
token | Token from the Heartland iframe |
YES | |
payload | This is the info from heartland using this for logging |
YES |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json |
Body
Example Request: { "nickname": "Amex Test", "type": "amex", "address": "6860", "city": "dallas", "state": "TX", "zipcode": "75024", "number": "372700699251018", "cvv": "1234", "expiration_date": "12/2025" }
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /mobile/v:version/user/add-funding
Fields
Field | Type | Description | Required |
---|---|---|---|
nickname | Nickname for the new credit/debit card you are adding as a funding source. |
YES | |
type | Credit/debit card type, possible values: "amex" (American Express), "discover" (Discover), "mastercard" (Mastercard), "visa" (Visa) |
YES | |
zipcode | Zip code associated with the card. |
YES | |
expiration_date | Expiration date of the card in the format of “mm/yyyy”. For example, if the card expires in 2016 December, the value will be “12/2016” |
YES | |
number | Last 4 of Credit Card number. |
YES | |
address | Billing address of the credit/debit card you are adding as a funding source. |
YES | |
city | Billing city of the credit/debit card you are adding as a funding source. |
YES | |
state | Billing state of the credit/debit card you are adding as a funding source. |
YES | |
token | Token from the Heartland iframe |
YES | |
payload | This is the info from heartland using this for logging |
YES | |
nickname | Nickname for the new credit/debit card you are adding as a funding source. |
YES | |
type | Credit/debit card type, possible values: "amex" (American Express), "discover" (Discover), "mastercard" (Mastercard), "visa" (Visa) |
YES | |
zipcode | Zip code associated with the card. |
YES | |
expiration_date | Expiration date of the card in the format of “mm/yyyy”. For example, if the card expires in 2016 December, the value will be “12/2016” |
YES | |
number | Last 4 of Credit Card number. |
YES | |
address | Billing address of the credit/debit card you are adding as a funding source. |
YES | |
city | Billing city of the credit/debit card you are adding as a funding source. |
YES | |
state | Billing state of the credit/debit card you are adding as a funding source. |
YES | |
token | Token from the Heartland iframe |
YES | |
payload | This is the info from heartland using this for logging |
YES | |
nickname | Nickname for the new credit/debit card you are adding as a funding source. |
YES | |
type | Credit/debit card type, possible values: "amex" (American Express), "discover" (Discover), "mastercard" (Mastercard), "visa" (Visa) |
YES | |
zipcode | Zip code associated with the card. |
YES | |
expiration_date | Expiration date of the card in the format of “mm/yyyy”. For example, if the card expires in 2016 December, the value will be “12/2016” |
YES | |
number | Last 4 of Credit Card number. |
YES | |
address | Billing address of the credit/debit card you are adding as a funding source. |
YES | |
city | Billing city of the credit/debit card you are adding as a funding source. |
YES | |
state | Billing state of the credit/debit card you are adding as a funding source. |
YES | |
token | Token from the Heartland iframe |
YES | |
payload | This is the info from heartland using this for logging |
YES | |
nickname | Nickname for the new credit/debit card you are adding as a funding source. |
YES | |
type | Credit/debit card type, possible values: "amex" (American Express), "discover" (Discover), "mastercard" (Mastercard), "visa" (Visa) |
YES | |
zipcode | Zip code associated with the card. |
YES | |
expiration_date | Expiration date of the card in the format of “mm/yyyy”. For example, if the card expires in 2016 December, the value will be “12/2016” |
YES | |
number | Last 4 of Credit Card number. |
YES | |
address | Billing address of the credit/debit card you are adding as a funding source. |
YES | |
city | Billing city of the credit/debit card you are adding as a funding source. |
YES | |
state | Billing state of the credit/debit card you are adding as a funding source. |
YES | |
token | Token from the Heartland iframe |
YES | |
payload | This is the info from heartland using this for logging |
YES |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json |
Body
Example Request: { "nickname": "Amex Test", "type": "amex", "address": "6860", "city": "dallas", "state": "TX", "zipcode": "75024", "number": "372700699251018", "cvv": "1234", "expiration_date": "12/2025" }
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
UserListAutoReload
This API endpoint will allow to view all the auto reload setups for the given user.
GET /mobile/v:version/user/cards/:oan_number/auto-reload[/]
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
{ "id": "20", "funding_source_id": "35", "type": "adp", "threshold": "50.00", "amount": "10.00", "status": "1" }
GET /mobile/v:version/user/cards/:oan_number/auto-reload[/]
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
{ "id": "20", "funding_source_id": "35", "type": "adp", "threshold": "50.00", "amount": "10.00", "status": "1" }
GET /mobile/v:version/user/cards/:oan_number/auto-reload[/]
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
{ "id": "20", "funding_source_id": "35", "type": "adp", "threshold": "50.00", "amount": "10.00", "status": "1" }
GET /mobile/v:version/user/cards/:oan_number/auto-reload[/]
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
{ "id": "20", "funding_source_id": "35", "type": "adp", "threshold": "50.00", "amount": "10.00", "status": "1" }
UserListCards
This API endpoint will allow to view the list of OAN cards belonged to the given user.
GET /mobile/v:version/user/cards[/]
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
Example Response: { "user_id": 1234, "oans": [{ "oan": "12345678901234", "is_virtual": false, "is_primary": false, "is_active": true, "balance": 175.48 }, { "oan": "91234567891234", "is_virtual": true, "is_primary": true, "is_active": true, "balance": 205.00 }] }
GET /mobile/v:version/user/cards[/]
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
Example Response: { "user_id": 1234, "oans": [{ "oan": "12345678901234", "is_virtual": false, "is_primary": false, "is_active": true, "balance": 175.48 }, { "oan": "91234567891234", "is_virtual": true, "is_primary": true, "is_active": true, "balance": 205.00 }] }
GET /mobile/v:version/user/cards[/]
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
Example Response: { "user_id": 1234, "oans": [{ "oan": "12345678901234", "is_virtual": false, "is_primary": false, "is_active": true, "balance": 175.48 }, { "oan": "91234567891234", "is_virtual": true, "is_primary": true, "is_active": true, "balance": 205.00 }] }
GET /mobile/v:version/user/cards[/]
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
Example Response: { "user_id": 1234, "oans": [{ "oan": "12345678901234", "is_virtual": false, "is_primary": false, "is_active": true, "balance": 175.48 }, { "oan": "91234567891234", "is_virtual": true, "is_primary": true, "is_active": true, "balance": 205.00 }] }
UserListFunding
This API endpoint will allow to view all the funding sources setup for the given user.
GET /mobile/v:version/user/funding[/]
Funding index will be credit/debit sources, Payroll index will be any payroll companies identified by "type".
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
Example Response: { "funding": [ { "id": 1, "nickname": "Amex Test", "type": "amex", "token": "Eic0C108Tbmyt4AcaL4V1018", "last_digits": "1018", "zipcode": "75024", "expiration_date": "12/2025" "created_timestamp": 1460738783 }, { "id": 2, "nickname": "Mastercard Test", "type": "mastercard", "token": "zfcNzY082gILIQ1MvnVp0014", "last_digits": "0014", "zipcode": "75024", "expiration_date": "12/2025", "created_timestamp": 1459891476 } ], "payroll": [ { "id": "35", "employer": "Random Employer", "associate_id": "48844", "type": "adp" } ] }
GET /mobile/v:version/user/funding[/]
Funding index will be credit/debit sources, Payroll index will be any payroll companies identified by "type".
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
Example Response: { "funding": [ { "id": 1, "nickname": "Amex Test", "type": "amex", "token": "Eic0C108Tbmyt4AcaL4V1018", "last_digits": "1018", "zipcode": "75024", "expiration_date": "12/2025" "created_timestamp": 1460738783 }, { "id": 2, "nickname": "Mastercard Test", "type": "mastercard", "token": "zfcNzY082gILIQ1MvnVp0014", "last_digits": "0014", "zipcode": "75024", "expiration_date": "12/2025", "created_timestamp": 1459891476 } ], "payroll": [ { "id": "35", "employer": "Random Employer", "associate_id": "48844", "type": "adp" } ] }
GET /mobile/v:version/user/funding[/]
Funding index will be credit/debit sources, Payroll index will be any payroll companies identified by "type".
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
Example Response: { "funding": [ { "id": 1, "nickname": "Amex Test", "type": "amex", "token": "Eic0C108Tbmyt4AcaL4V1018", "last_digits": "1018", "zipcode": "75024", "expiration_date": "12/2025" "created_timestamp": 1460738783 }, { "id": 2, "nickname": "Mastercard Test", "type": "mastercard", "token": "zfcNzY082gILIQ1MvnVp0014", "last_digits": "0014", "zipcode": "75024", "expiration_date": "12/2025", "created_timestamp": 1459891476 } ], "payroll": [ { "id": "35", "employer": "Random Employer", "associate_id": "48844", "type": "adp" } ] }
GET /mobile/v:version/user/funding[/]
Funding index will be credit/debit sources, Payroll index will be any payroll companies identified by "type".
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
Example Response: { "funding": [ { "id": 1, "nickname": "Amex Test", "type": "amex", "token": "Eic0C108Tbmyt4AcaL4V1018", "last_digits": "1018", "zipcode": "75024", "expiration_date": "12/2025" "created_timestamp": 1460738783 }, { "id": 2, "nickname": "Mastercard Test", "type": "mastercard", "token": "zfcNzY082gILIQ1MvnVp0014", "last_digits": "0014", "zipcode": "75024", "expiration_date": "12/2025", "created_timestamp": 1459891476 } ], "payroll": [ { "id": "35", "employer": "Random Employer", "associate_id": "48844", "type": "adp" } ] }
UserLoad
This API endpoint will allow to load dollar value credit into an existing OAN card owned by the given user.
POST /mobile/v:version/user/cards/:oan_number/load[/]
Fields
Field | Type | Description | Required |
---|---|---|---|
amount | Amount of money to be loaded to the card. |
NO | |
funding_source_id | Alphanumeric ID (token) of the fund source (credit/debit card) from which the dollar value should be imported/charged. |
NO | |
cvv | CVV of the fund source (credit/debit card) from which the dollar value should be imported/charged. Length should be 4 digits for amex, 3 digits for everything else. |
NO | |
type | Options: "regular", "adp", "apple pay" Default is regular if type is unset or any other value. |
NO | |
payment_data | Payment token data from apple pay in JSON format. This will only be used if type is set to "apple pay" |
NO | |
app_reference_id | Unique Id of load |
NO | |
amount | Amount of money to be loaded to the card. |
NO | |
funding_source_id | Alphanumeric ID (token) of the fund source (credit/debit card) from which the dollar value should be imported/charged. |
NO | |
cvv | CVV of the fund source (credit/debit card) from which the dollar value should be imported/charged. Length should be 4 digits for amex, 3 digits for everything else. |
NO | |
type | Options: "regular", "adp", "apple pay" Default is regular if type is unset or any other value. |
NO | |
payment_data | Payment token data from apple pay in JSON format. This will only be used if type is set to "apple pay" |
NO | |
app_reference_id | Unique Id of load |
NO | |
amount | Amount of money to be loaded to the card. |
NO | |
funding_source_id | Alphanumeric ID (token) of the fund source (credit/debit card) from which the dollar value should be imported/charged. |
NO | |
cvv | CVV of the fund source (credit/debit card) from which the dollar value should be imported/charged. Length should be 4 digits for amex, 3 digits for everything else. |
NO | |
type | Options: "regular", "adp", "apple pay" Default is regular if type is unset or any other value. |
NO | |
payment_data | Payment token data from apple pay in JSON format. This will only be used if type is set to "apple pay" |
NO | |
app_reference_id | Unique Id of load |
NO | |
amount | Amount of money to be loaded to the card. |
NO | |
funding_source_id | Alphanumeric ID (token) of the fund source (credit/debit card) from which the dollar value should be imported/charged. |
NO | |
cvv | CVV of the fund source (credit/debit card) from which the dollar value should be imported/charged. Length should be 4 digits for amex, 3 digits for everything else. |
NO | |
type | Options: "regular", "adp", "apple pay" Default is regular if type is unset or any other value. |
NO | |
payment_data | Payment token data from apple pay in JSON format. This will only be used if type is set to "apple pay" |
NO | |
app_reference_id | Unique Id of load |
NO |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json |
Body
Example Request: { "amount": 10.00, "funding_source_id": "Eic0C108Tbmyt4AcaL4V1018", "cvv": "082" } OR { "type": "payroll", "amount": 10.00, "funding_source_id": "35" } OR { "type": "apple pay", "payment_data": { "data": "1984ukjf1h9f34871h928317v592812351-235=12vn9512p;d15u,d51o2pu3v15i2up351v03;51pfc315.02935", "header": { "placeholder": "placeholder" }, "placeholder": "placeholder" } }
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
Example Response: { "success": true, "amount": 10.00, "balance": 100.00, "transaction_id": 1 }
POST /mobile/v:version/user/cards/:oan_number/load[/]
Fields
Field | Type | Description | Required |
---|---|---|---|
amount | Amount of money to be loaded to the card. |
NO | |
funding_source_id | Alphanumeric ID (token) of the fund source (credit/debit card) from which the dollar value should be imported/charged. |
NO | |
cvv | CVV of the fund source (credit/debit card) from which the dollar value should be imported/charged. Length should be 4 digits for amex, 3 digits for everything else. |
NO | |
type | Options: "regular", "adp", "apple pay" Default is regular if type is unset or any other value. |
NO | |
payment_data | Payment token data from apple pay in JSON format. This will only be used if type is set to "apple pay" |
NO | |
app_reference_id | Unique Id of load |
NO | |
amount | Amount of money to be loaded to the card. |
NO | |
funding_source_id | Alphanumeric ID (token) of the fund source (credit/debit card) from which the dollar value should be imported/charged. |
NO | |
cvv | CVV of the fund source (credit/debit card) from which the dollar value should be imported/charged. Length should be 4 digits for amex, 3 digits for everything else. |
NO | |
type | Options: "regular", "adp", "apple pay" Default is regular if type is unset or any other value. |
NO | |
payment_data | Payment token data from apple pay in JSON format. This will only be used if type is set to "apple pay" |
NO | |
app_reference_id | Unique Id of load |
NO | |
amount | Amount of money to be loaded to the card. |
NO | |
funding_source_id | Alphanumeric ID (token) of the fund source (credit/debit card) from which the dollar value should be imported/charged. |
NO | |
cvv | CVV of the fund source (credit/debit card) from which the dollar value should be imported/charged. Length should be 4 digits for amex, 3 digits for everything else. |
NO | |
type | Options: "regular", "adp", "apple pay" Default is regular if type is unset or any other value. |
NO | |
payment_data | Payment token data from apple pay in JSON format. This will only be used if type is set to "apple pay" |
NO | |
app_reference_id | Unique Id of load |
NO | |
amount | Amount of money to be loaded to the card. |
NO | |
funding_source_id | Alphanumeric ID (token) of the fund source (credit/debit card) from which the dollar value should be imported/charged. |
NO | |
cvv | CVV of the fund source (credit/debit card) from which the dollar value should be imported/charged. Length should be 4 digits for amex, 3 digits for everything else. |
NO | |
type | Options: "regular", "adp", "apple pay" Default is regular if type is unset or any other value. |
NO | |
payment_data | Payment token data from apple pay in JSON format. This will only be used if type is set to "apple pay" |
NO | |
app_reference_id | Unique Id of load |
NO |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json |
Body
Example Request: { "amount": 10.00, "funding_source_id": "Eic0C108Tbmyt4AcaL4V1018", "cvv": "082" } OR { "type": "payroll", "amount": 10.00, "funding_source_id": "35" } OR { "type": "apple pay", "payment_data": { "data": "1984ukjf1h9f34871h928317v592812351-235=12vn9512p;d15u,d51o2pu3v15i2up351v03;51pfc315.02935", "header": { "placeholder": "placeholder" }, "placeholder": "placeholder" } }
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
Example Response: { "success": true, "amount": 10.00, "balance": 100.00, "transaction_id": 1 }
POST /mobile/v:version/user/cards/:oan_number/load[/]
Fields
Field | Type | Description | Required |
---|---|---|---|
amount | Amount of money to be loaded to the card. |
NO | |
funding_source_id | Alphanumeric ID (token) of the fund source (credit/debit card) from which the dollar value should be imported/charged. |
NO | |
cvv | CVV of the fund source (credit/debit card) from which the dollar value should be imported/charged. Length should be 4 digits for amex, 3 digits for everything else. |
NO | |
type | Options: "regular", "adp", "apple pay" Default is regular if type is unset or any other value. |
NO | |
payment_data | Payment token data from apple pay in JSON format. This will only be used if type is set to "apple pay" |
NO | |
app_reference_id | Unique Id of load |
NO | |
amount | Amount of money to be loaded to the card. |
NO | |
funding_source_id | Alphanumeric ID (token) of the fund source (credit/debit card) from which the dollar value should be imported/charged. |
NO | |
cvv | CVV of the fund source (credit/debit card) from which the dollar value should be imported/charged. Length should be 4 digits for amex, 3 digits for everything else. |
NO | |
type | Options: "regular", "adp", "apple pay" Default is regular if type is unset or any other value. |
NO | |
payment_data | Payment token data from apple pay in JSON format. This will only be used if type is set to "apple pay" |
NO | |
app_reference_id | Unique Id of load |
NO | |
amount | Amount of money to be loaded to the card. |
NO | |
funding_source_id | Alphanumeric ID (token) of the fund source (credit/debit card) from which the dollar value should be imported/charged. |
NO | |
cvv | CVV of the fund source (credit/debit card) from which the dollar value should be imported/charged. Length should be 4 digits for amex, 3 digits for everything else. |
NO | |
type | Options: "regular", "adp", "apple pay" Default is regular if type is unset or any other value. |
NO | |
payment_data | Payment token data from apple pay in JSON format. This will only be used if type is set to "apple pay" |
NO | |
app_reference_id | Unique Id of load |
NO | |
amount | Amount of money to be loaded to the card. |
NO | |
funding_source_id | Alphanumeric ID (token) of the fund source (credit/debit card) from which the dollar value should be imported/charged. |
NO | |
cvv | CVV of the fund source (credit/debit card) from which the dollar value should be imported/charged. Length should be 4 digits for amex, 3 digits for everything else. |
NO | |
type | Options: "regular", "adp", "apple pay" Default is regular if type is unset or any other value. |
NO | |
payment_data | Payment token data from apple pay in JSON format. This will only be used if type is set to "apple pay" |
NO | |
app_reference_id | Unique Id of load |
NO |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json |
Body
Example Request: { "amount": 10.00, "funding_source_id": "Eic0C108Tbmyt4AcaL4V1018", "cvv": "082" } OR { "type": "payroll", "amount": 10.00, "funding_source_id": "35" } OR { "type": "apple pay", "payment_data": { "data": "1984ukjf1h9f34871h928317v592812351-235=12vn9512p;d15u,d51o2pu3v15i2up351v03;51pfc315.02935", "header": { "placeholder": "placeholder" }, "placeholder": "placeholder" } }
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
Example Response: { "success": true, "amount": 10.00, "balance": 100.00, "transaction_id": 1 }
POST /mobile/v:version/user/cards/:oan_number/load[/]
Fields
Field | Type | Description | Required |
---|---|---|---|
amount | Amount of money to be loaded to the card. |
NO | |
funding_source_id | Alphanumeric ID (token) of the fund source (credit/debit card) from which the dollar value should be imported/charged. |
NO | |
cvv | CVV of the fund source (credit/debit card) from which the dollar value should be imported/charged. Length should be 4 digits for amex, 3 digits for everything else. |
NO | |
type | Options: "regular", "adp", "apple pay" Default is regular if type is unset or any other value. |
NO | |
payment_data | Payment token data from apple pay in JSON format. This will only be used if type is set to "apple pay" |
NO | |
app_reference_id | Unique Id of load |
NO | |
amount | Amount of money to be loaded to the card. |
NO | |
funding_source_id | Alphanumeric ID (token) of the fund source (credit/debit card) from which the dollar value should be imported/charged. |
NO | |
cvv | CVV of the fund source (credit/debit card) from which the dollar value should be imported/charged. Length should be 4 digits for amex, 3 digits for everything else. |
NO | |
type | Options: "regular", "adp", "apple pay" Default is regular if type is unset or any other value. |
NO | |
payment_data | Payment token data from apple pay in JSON format. This will only be used if type is set to "apple pay" |
NO | |
app_reference_id | Unique Id of load |
NO | |
amount | Amount of money to be loaded to the card. |
NO | |
funding_source_id | Alphanumeric ID (token) of the fund source (credit/debit card) from which the dollar value should be imported/charged. |
NO | |
cvv | CVV of the fund source (credit/debit card) from which the dollar value should be imported/charged. Length should be 4 digits for amex, 3 digits for everything else. |
NO | |
type | Options: "regular", "adp", "apple pay" Default is regular if type is unset or any other value. |
NO | |
payment_data | Payment token data from apple pay in JSON format. This will only be used if type is set to "apple pay" |
NO | |
app_reference_id | Unique Id of load |
NO | |
amount | Amount of money to be loaded to the card. |
NO | |
funding_source_id | Alphanumeric ID (token) of the fund source (credit/debit card) from which the dollar value should be imported/charged. |
NO | |
cvv | CVV of the fund source (credit/debit card) from which the dollar value should be imported/charged. Length should be 4 digits for amex, 3 digits for everything else. |
NO | |
type | Options: "regular", "adp", "apple pay" Default is regular if type is unset or any other value. |
NO | |
payment_data | Payment token data from apple pay in JSON format. This will only be used if type is set to "apple pay" |
NO | |
app_reference_id | Unique Id of load |
NO |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json |
Body
Example Request: { "amount": 10.00, "funding_source_id": "Eic0C108Tbmyt4AcaL4V1018", "cvv": "082" } OR { "type": "payroll", "amount": 10.00, "funding_source_id": "35" } OR { "type": "apple pay", "payment_data": { "data": "1984ukjf1h9f34871h928317v592812351-235=12vn9512p;d15u,d51o2pu3v15i2up351v03;51pfc315.02935", "header": { "placeholder": "placeholder" }, "placeholder": "placeholder" } }
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
Example Response: { "success": true, "amount": 10.00, "balance": 100.00, "transaction_id": 1 }
UserLogin
This API endpoint will allow the user to login via username and password.
NOTE: Username must be a valid email address.
POST /mobile/v:version/user/login[/]
Fields
Field | Type | Description | Required |
---|---|---|---|
username | Email address of the user. |
YES | |
password | Password of the user. |
YES | |
grant_type | Grant type |
YES | |
client_id | ID of the application requesting access |
YES | |
username | Email address of the user. |
YES | |
password | Password of the user. |
YES | |
grant_type | Grant type |
YES | |
client_id | ID of the application requesting access |
YES | |
username | Email address of the user. |
YES | |
password | Password of the user. |
YES | |
grant_type | Grant type |
YES | |
client_id | ID of the application requesting access |
YES | |
username | Email address of the user. |
YES | |
password | Password of the user. |
YES | |
grant_type | Grant type |
YES | |
client_id | ID of the application requesting access |
YES |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json |
Body
Example Request: { "username": "test@test.com", "password": "password", "grant_type": "password", "client_id": "smallfootprint" }
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /mobile/v:version/user/login[/]
Fields
Field | Type | Description | Required |
---|---|---|---|
username | Email address of the user. |
YES | |
password | Password of the user. |
YES | |
grant_type | Grant type |
YES | |
client_id | ID of the application requesting access |
YES | |
username | Email address of the user. |
YES | |
password | Password of the user. |
YES | |
grant_type | Grant type |
YES | |
client_id | ID of the application requesting access |
YES | |
username | Email address of the user. |
YES | |
password | Password of the user. |
YES | |
grant_type | Grant type |
YES | |
client_id | ID of the application requesting access |
YES | |
username | Email address of the user. |
YES | |
password | Password of the user. |
YES | |
grant_type | Grant type |
YES | |
client_id | ID of the application requesting access |
YES |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json |
Body
Example Request: { "username": "test@test.com", "password": "password", "grant_type": "password", "client_id": "smallfootprint" }
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /mobile/v:version/user/login[/]
Fields
Field | Type | Description | Required |
---|---|---|---|
username | Email address of the user. |
YES | |
password | Password of the user. |
YES | |
grant_type | Grant type |
YES | |
client_id | ID of the application requesting access |
YES | |
username | Email address of the user. |
YES | |
password | Password of the user. |
YES | |
grant_type | Grant type |
YES | |
client_id | ID of the application requesting access |
YES | |
username | Email address of the user. |
YES | |
password | Password of the user. |
YES | |
grant_type | Grant type |
YES | |
client_id | ID of the application requesting access |
YES | |
username | Email address of the user. |
YES | |
password | Password of the user. |
YES | |
grant_type | Grant type |
YES | |
client_id | ID of the application requesting access |
YES |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json |
Body
Example Request: { "username": "test@test.com", "password": "password", "grant_type": "password", "client_id": "smallfootprint" }
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /mobile/v:version/user/login[/]
Fields
Field | Type | Description | Required |
---|---|---|---|
username | Email address of the user. |
YES | |
password | Password of the user. |
YES | |
grant_type | Grant type |
YES | |
client_id | ID of the application requesting access |
YES | |
username | Email address of the user. |
YES | |
password | Password of the user. |
YES | |
grant_type | Grant type |
YES | |
client_id | ID of the application requesting access |
YES | |
username | Email address of the user. |
YES | |
password | Password of the user. |
YES | |
grant_type | Grant type |
YES | |
client_id | ID of the application requesting access |
YES | |
username | Email address of the user. |
YES | |
password | Password of the user. |
YES | |
grant_type | Grant type |
YES | |
client_id | ID of the application requesting access |
YES |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json |
Body
Example Request: { "username": "test@test.com", "password": "password", "grant_type": "password", "client_id": "smallfootprint" }
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
UserPasswordReset
This API endpoint will allow the user to login to request to send password reset email.
NOTE: Username must be a valid email address.
POST /mobile/v:version/user/request-temp-password
Fields
Field | Type | Description | Required |
---|---|---|---|
username | Email address of the user. |
YES | |
username | Email address of the user. |
YES | |
username | Email address of the user. |
YES | |
username | Email address of the user. |
YES |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json |
Body
Example Request: { "username": "test@test.com" }
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
Example Response: { "success": true }
POST /mobile/v:version/user/request-temp-password
Fields
Field | Type | Description | Required |
---|---|---|---|
username | Email address of the user. |
YES | |
username | Email address of the user. |
YES | |
username | Email address of the user. |
YES | |
username | Email address of the user. |
YES |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json |
Body
Example Request: { "username": "test@test.com" }
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
Example Response: { "success": true }
POST /mobile/v:version/user/request-temp-password
Fields
Field | Type | Description | Required |
---|---|---|---|
username | Email address of the user. |
YES | |
username | Email address of the user. |
YES | |
username | Email address of the user. |
YES | |
username | Email address of the user. |
YES |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json |
Body
Example Request: { "username": "test@test.com" }
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
Example Response: { "success": true }
POST /mobile/v:version/user/request-temp-password
Fields
Field | Type | Description | Required |
---|---|---|---|
username | Email address of the user. |
YES | |
username | Email address of the user. |
YES | |
username | Email address of the user. |
YES | |
username | Email address of the user. |
YES |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json |
Body
Example Request: { "username": "test@test.com" }
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
Example Response: { "success": true }
UserPickCharity
This API endpoint will allow to select a particular charity for a user as their designated charity for donation through their purchase transaction activities.
NOTE: at any time only one charity can only be selected for a user. Any new charity selection overrides any previous selection of charity for that user.
POST /mobile/v:version/user/pick-charity
Fields
Field | Type | Description | Required |
---|---|---|---|
charity_id | Unique ID of the charity to be selected. |
YES | |
charity_id | Unique ID of the charity to be selected. |
YES | |
charity_id | Unique ID of the charity to be selected. |
YES | |
charity_id | Unique ID of the charity to be selected. |
YES |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json |
Body
Example Request: { "charity_id": 1 }
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
Example Response: { "success": true }
POST /mobile/v:version/user/pick-charity
Fields
Field | Type | Description | Required |
---|---|---|---|
charity_id | Unique ID of the charity to be selected. |
YES | |
charity_id | Unique ID of the charity to be selected. |
YES | |
charity_id | Unique ID of the charity to be selected. |
YES | |
charity_id | Unique ID of the charity to be selected. |
YES |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json |
Body
Example Request: { "charity_id": 1 }
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
Example Response: { "success": true }
POST /mobile/v:version/user/pick-charity
Fields
Field | Type | Description | Required |
---|---|---|---|
charity_id | Unique ID of the charity to be selected. |
YES | |
charity_id | Unique ID of the charity to be selected. |
YES | |
charity_id | Unique ID of the charity to be selected. |
YES | |
charity_id | Unique ID of the charity to be selected. |
YES |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json |
Body
Example Request: { "charity_id": 1 }
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
Example Response: { "success": true }
POST /mobile/v:version/user/pick-charity
Fields
Field | Type | Description | Required |
---|---|---|---|
charity_id | Unique ID of the charity to be selected. |
YES | |
charity_id | Unique ID of the charity to be selected. |
YES | |
charity_id | Unique ID of the charity to be selected. |
YES | |
charity_id | Unique ID of the charity to be selected. |
YES |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json |
Body
Example Request: { "charity_id": 1 }
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
Example Response: { "success": true }
UserPromotionDetails
This API endpoint will allow to get the detailed information about a particular promotion program.
GET /mobile/v:version/user/promotions/:promotion_id[/]
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
Example Response: { "id": 1, "title": "Promotion 1", "desc": "Promotion 1 Description", "image_url": "/images/promotion_1.png", "start_timestamp": 1467331200, "end_timestamp": 1470787200, created_timestamp": 1469710841 }
GET /mobile/v:version/user/promotions/:promotion_id[/]
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
Example Response: { "id": 1, "title": "Promotion 1", "desc": "Promotion 1 Description", "image_url": "/images/promotion_1.png", "start_timestamp": 1467331200, "end_timestamp": 1470787200, created_timestamp": 1469710841 }
GET /mobile/v:version/user/promotions/:promotion_id[/]
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
Example Response: { "id": 1, "title": "Promotion 1", "desc": "Promotion 1 Description", "image_url": "/images/promotion_1.png", "start_timestamp": 1467331200, "end_timestamp": 1470787200, created_timestamp": 1469710841 }
GET /mobile/v:version/user/promotions/:promotion_id[/]
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
Example Response: { "id": 1, "title": "Promotion 1", "desc": "Promotion 1 Description", "image_url": "/images/promotion_1.png", "start_timestamp": 1467331200, "end_timestamp": 1470787200, created_timestamp": 1469710841 }
UserPromotions
This API endpoint will allow to fetch the list of available promotions to the given user.
GET /mobile/v:version/user/promotions[/]
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
Example Response: { "promotions": [{ "id": 1, "title": "Promotion 1", "image_url": "/images/promotion_1.png", "start_timestamp": "1507089600", "end_timestamp": "1514782799", "total_claimed": "0", "purchased": 0, "required": 4, "dollar_off": 0, "percent_off": 0, "total_saved": 0 }, { "id": 2, "title": "Promotion 2", "image_url": "/images/promotion_2.png", "start_timestamp": "1507089600", "end_timestamp": "1514782799", "total_claimed": "1", "purchased": 1, "required": 4, "dollar_off": 0, "percent_off": 10, "total_saved": 0.10 }, { "id": 3, "title": "Promotion 23, "image_url": "/images/promotion_3.png", "start_timestamp": "1507089600", "end_timestamp": "1514782799", "total_claimed": "2", "purchased": 0, "required": 0, "dollar_off": 1, "percent_off": 0, "total_saved": 2 }] }
GET /mobile/v:version/user/promotions[/]
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
Example Response: { "promotions": [{ "id": 1, "title": "Promotion 1", "image_url": "/images/promotion_1.png", "start_timestamp": "1507089600", "end_timestamp": "1514782799", "total_claimed": "0", "purchased": 0, "required": 4, "dollar_off": 0, "percent_off": 0, "total_saved": 0 }, { "id": 2, "title": "Promotion 2", "image_url": "/images/promotion_2.png", "start_timestamp": "1507089600", "end_timestamp": "1514782799", "total_claimed": "1", "purchased": 1, "required": 4, "dollar_off": 0, "percent_off": 10, "total_saved": 0.10 }, { "id": 3, "title": "Promotion 23, "image_url": "/images/promotion_3.png", "start_timestamp": "1507089600", "end_timestamp": "1514782799", "total_claimed": "2", "purchased": 0, "required": 0, "dollar_off": 1, "percent_off": 0, "total_saved": 2 }] }
GET /mobile/v:version/user/promotions[/]
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
Example Response: { "promotions": [{ "id": 1, "title": "Promotion 1", "image_url": "/images/promotion_1.png", "start_timestamp": "1507089600", "end_timestamp": "1514782799", "total_claimed": "0", "purchased": 0, "required": 4, "dollar_off": 0, "percent_off": 0, "total_saved": 0 }, { "id": 2, "title": "Promotion 2", "image_url": "/images/promotion_2.png", "start_timestamp": "1507089600", "end_timestamp": "1514782799", "total_claimed": "1", "purchased": 1, "required": 4, "dollar_off": 0, "percent_off": 10, "total_saved": 0.10 }, { "id": 3, "title": "Promotion 23, "image_url": "/images/promotion_3.png", "start_timestamp": "1507089600", "end_timestamp": "1514782799", "total_claimed": "2", "purchased": 0, "required": 0, "dollar_off": 1, "percent_off": 0, "total_saved": 2 }] }
GET /mobile/v:version/user/promotions[/]
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
Example Response: { "promotions": [{ "id": 1, "title": "Promotion 1", "image_url": "/images/promotion_1.png", "start_timestamp": "1507089600", "end_timestamp": "1514782799", "total_claimed": "0", "purchased": 0, "required": 4, "dollar_off": 0, "percent_off": 0, "total_saved": 0 }, { "id": 2, "title": "Promotion 2", "image_url": "/images/promotion_2.png", "start_timestamp": "1507089600", "end_timestamp": "1514782799", "total_claimed": "1", "purchased": 1, "required": 4, "dollar_off": 0, "percent_off": 10, "total_saved": 0.10 }, { "id": 3, "title": "Promotion 23, "image_url": "/images/promotion_3.png", "start_timestamp": "1507089600", "end_timestamp": "1514782799", "total_claimed": "2", "purchased": 0, "required": 0, "dollar_off": 1, "percent_off": 0, "total_saved": 2 }] }
UserRedeemPromotion
This API endpoint will allow to redeem a promo code.
POST /mobile/v:version/user/redeem-promotion[/]
Fields
Field | Type | Description | Required |
---|---|---|---|
promo_code | Alphanumeric promotion code. |
YES | |
oan | The OAN number of the card owned by the user to which you want to deposit the redeemed credit. |
YES | |
promo_code | Alphanumeric promotion code. |
YES | |
oan | The OAN number of the card owned by the user to which you want to deposit the redeemed credit. |
YES | |
promo_code | Alphanumeric promotion code. |
YES | |
oan | The OAN number of the card owned by the user to which you want to deposit the redeemed credit. |
YES | |
promo_code | Alphanumeric promotion code. |
YES | |
oan | The OAN number of the card owned by the user to which you want to deposit the redeemed credit. |
YES |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json |
Body
Example Request: { "promo_code": "abc123", "oan": "12345678901234" }
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
Example Response: { "success": true, "redeemed_code": abc123, "redeemed_credit": 1.00, "transaction_id": 1, "oan": "12345678901234", "new_balance": 11.00 }
POST /mobile/v:version/user/redeem-promotion[/]
Fields
Field | Type | Description | Required |
---|---|---|---|
promo_code | Alphanumeric promotion code. |
YES | |
oan | The OAN number of the card owned by the user to which you want to deposit the redeemed credit. |
YES | |
promo_code | Alphanumeric promotion code. |
YES | |
oan | The OAN number of the card owned by the user to which you want to deposit the redeemed credit. |
YES | |
promo_code | Alphanumeric promotion code. |
YES | |
oan | The OAN number of the card owned by the user to which you want to deposit the redeemed credit. |
YES | |
promo_code | Alphanumeric promotion code. |
YES | |
oan | The OAN number of the card owned by the user to which you want to deposit the redeemed credit. |
YES |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json |
Body
Example Request: { "promo_code": "abc123", "oan": "12345678901234" }
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
Example Response: { "success": true, "redeemed_code": abc123, "redeemed_credit": 1.00, "transaction_id": 1, "oan": "12345678901234", "new_balance": 11.00 }
POST /mobile/v:version/user/redeem-promotion[/]
Fields
Field | Type | Description | Required |
---|---|---|---|
promo_code | Alphanumeric promotion code. |
YES | |
oan | The OAN number of the card owned by the user to which you want to deposit the redeemed credit. |
YES | |
promo_code | Alphanumeric promotion code. |
YES | |
oan | The OAN number of the card owned by the user to which you want to deposit the redeemed credit. |
YES | |
promo_code | Alphanumeric promotion code. |
YES | |
oan | The OAN number of the card owned by the user to which you want to deposit the redeemed credit. |
YES | |
promo_code | Alphanumeric promotion code. |
YES | |
oan | The OAN number of the card owned by the user to which you want to deposit the redeemed credit. |
YES |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json |
Body
Example Request: { "promo_code": "abc123", "oan": "12345678901234" }
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
Example Response: { "success": true, "redeemed_code": abc123, "redeemed_credit": 1.00, "transaction_id": 1, "oan": "12345678901234", "new_balance": 11.00 }
POST /mobile/v:version/user/redeem-promotion[/]
Fields
Field | Type | Description | Required |
---|---|---|---|
promo_code | Alphanumeric promotion code. |
YES | |
oan | The OAN number of the card owned by the user to which you want to deposit the redeemed credit. |
YES | |
promo_code | Alphanumeric promotion code. |
YES | |
oan | The OAN number of the card owned by the user to which you want to deposit the redeemed credit. |
YES | |
promo_code | Alphanumeric promotion code. |
YES | |
oan | The OAN number of the card owned by the user to which you want to deposit the redeemed credit. |
YES | |
promo_code | Alphanumeric promotion code. |
YES | |
oan | The OAN number of the card owned by the user to which you want to deposit the redeemed credit. |
YES |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json |
Body
Example Request: { "promo_code": "abc123", "oan": "12345678901234" }
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
Example Response: { "success": true, "redeemed_code": abc123, "redeemed_credit": 1.00, "transaction_id": 1, "oan": "12345678901234", "new_balance": 11.00 }
UserRedeem
This API endpoint will allow to redeem credit for available reward points collected by the user. For example, if the redemption rule is 500 points for $1 dollar, redeeming the available 500 points will deposit $1 dollar into one of the USConnect card owned by the given user.
POST /mobile/v:version/user/redeem[/]
Fields
Field | Type | Description | Required |
---|---|---|---|
redeem_points | Total number of points you want to redeem for this given user. If the requested points are less than eligible redemption rules, it will be not processed. |
YES | |
oan | The OAN number of the card owned by the user to which you want to deposit the redeemed credit. |
YES | |
redeem_points | Total number of points you want to redeem for this given user. If the requested points are less than eligible redemption rules, it will be not processed. |
YES | |
oan | The OAN number of the card owned by the user to which you want to deposit the redeemed credit. |
YES | |
redeem_points | Total number of points you want to redeem for this given user. If the requested points are less than eligible redemption rules, it will be not processed. |
YES | |
oan | The OAN number of the card owned by the user to which you want to deposit the redeemed credit. |
YES | |
redeem_points | Total number of points you want to redeem for this given user. If the requested points are less than eligible redemption rules, it will be not processed. |
YES | |
oan | The OAN number of the card owned by the user to which you want to deposit the redeemed credit. |
YES |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json |
Body
Example Request: { "redeem_points": 500, "oan": "12345678901234", }
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
Example Response: { "success": true, "redeemed_points": 500, "redeemed_credit": 1.00, "transaction_id": 1, "oan": "12345678901234", "new_balance": 11.00 }
POST /mobile/v:version/user/redeem[/]
Fields
Field | Type | Description | Required |
---|---|---|---|
redeem_points | Total number of points you want to redeem for this given user. If the requested points are less than eligible redemption rules, it will be not processed. |
YES | |
oan | The OAN number of the card owned by the user to which you want to deposit the redeemed credit. |
YES | |
redeem_points | Total number of points you want to redeem for this given user. If the requested points are less than eligible redemption rules, it will be not processed. |
YES | |
oan | The OAN number of the card owned by the user to which you want to deposit the redeemed credit. |
YES | |
redeem_points | Total number of points you want to redeem for this given user. If the requested points are less than eligible redemption rules, it will be not processed. |
YES | |
oan | The OAN number of the card owned by the user to which you want to deposit the redeemed credit. |
YES | |
redeem_points | Total number of points you want to redeem for this given user. If the requested points are less than eligible redemption rules, it will be not processed. |
YES | |
oan | The OAN number of the card owned by the user to which you want to deposit the redeemed credit. |
YES |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json |
Body
Example Request: { "redeem_points": 500, "oan": "12345678901234", }
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
Example Response: { "success": true, "redeemed_points": 500, "redeemed_credit": 1.00, "transaction_id": 1, "oan": "12345678901234", "new_balance": 11.00 }
POST /mobile/v:version/user/redeem[/]
Fields
Field | Type | Description | Required |
---|---|---|---|
redeem_points | Total number of points you want to redeem for this given user. If the requested points are less than eligible redemption rules, it will be not processed. |
YES | |
oan | The OAN number of the card owned by the user to which you want to deposit the redeemed credit. |
YES | |
redeem_points | Total number of points you want to redeem for this given user. If the requested points are less than eligible redemption rules, it will be not processed. |
YES | |
oan | The OAN number of the card owned by the user to which you want to deposit the redeemed credit. |
YES | |
redeem_points | Total number of points you want to redeem for this given user. If the requested points are less than eligible redemption rules, it will be not processed. |
YES | |
oan | The OAN number of the card owned by the user to which you want to deposit the redeemed credit. |
YES | |
redeem_points | Total number of points you want to redeem for this given user. If the requested points are less than eligible redemption rules, it will be not processed. |
YES | |
oan | The OAN number of the card owned by the user to which you want to deposit the redeemed credit. |
YES |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json |
Body
Example Request: { "redeem_points": 500, "oan": "12345678901234", }
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
Example Response: { "success": true, "redeemed_points": 500, "redeemed_credit": 1.00, "transaction_id": 1, "oan": "12345678901234", "new_balance": 11.00 }
POST /mobile/v:version/user/redeem[/]
Fields
Field | Type | Description | Required |
---|---|---|---|
redeem_points | Total number of points you want to redeem for this given user. If the requested points are less than eligible redemption rules, it will be not processed. |
YES | |
oan | The OAN number of the card owned by the user to which you want to deposit the redeemed credit. |
YES | |
redeem_points | Total number of points you want to redeem for this given user. If the requested points are less than eligible redemption rules, it will be not processed. |
YES | |
oan | The OAN number of the card owned by the user to which you want to deposit the redeemed credit. |
YES | |
redeem_points | Total number of points you want to redeem for this given user. If the requested points are less than eligible redemption rules, it will be not processed. |
YES | |
oan | The OAN number of the card owned by the user to which you want to deposit the redeemed credit. |
YES | |
redeem_points | Total number of points you want to redeem for this given user. If the requested points are less than eligible redemption rules, it will be not processed. |
YES | |
oan | The OAN number of the card owned by the user to which you want to deposit the redeemed credit. |
YES |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json |
Body
Example Request: { "redeem_points": 500, "oan": "12345678901234", }
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
Example Response: { "success": true, "redeemed_points": 500, "redeemed_credit": 1.00, "transaction_id": 1, "oan": "12345678901234", "new_balance": 11.00 }
UserRegistration
This API endpoint will allow registration of a new user.
POST /mobile/v:version/user/register[/]
Fields
Field | Type | Description | Required |
---|---|---|---|
card_number | Any existing card number that is not registered yet but already active. If no card number is provided, a new virtual card number will be assigned. |
NO | |
first_name | First name of the new user to be registered |
YES | |
last_name | Last name of the new user to be registered |
YES | |
Email address of the user |
YES | ||
password | Password for the user to also login from website |
YES | |
address | Street address of the user (max number of 100 characters) |
YES | |
city | City name as part of the full address |
YES | |
state | Postal code of the state as part of the full address, such as CA for California. For complete list of postal code name for US states please see: http://www.infoplease.com/ipa/A0110468.html |
YES | |
zip | Zip code as part of the full address |
YES | |
phone | Phone number of the user |
YES | |
group_code | Optional group code |
NO | |
phone_type | Type of phone: cell, home, or work. |
NO | |
language | string | Language |
NO |
card_number | Any existing card number that is not registered yet but already active. If no card number is provided, a new virtual card number will be assigned. |
NO | |
first_name | First name of the new user to be registered |
YES | |
last_name | Last name of the new user to be registered |
YES | |
Email address of the user |
YES | ||
password | Password for the user to also login from website |
YES | |
address | Street address of the user (max number of 100 characters) |
YES | |
city | City name as part of the full address |
YES | |
state | Postal code of the state as part of the full address, such as CA for California. For complete list of postal code name for US states please see: http://www.infoplease.com/ipa/A0110468.html |
YES | |
zip | Zip code as part of the full address |
YES | |
phone | Phone number of the user |
YES | |
group_code | Optional group code |
NO | |
phone_type | Type of phone: cell, home, or work. |
NO | |
language | string | Language |
NO |
card_number | Any existing card number that is not registered yet but already active. If no card number is provided, a new virtual card number will be assigned. |
NO | |
first_name | First name of the new user to be registered |
YES | |
last_name | Last name of the new user to be registered |
YES | |
Email address of the user |
YES | ||
password | Password for the user to also login from website |
YES | |
address | Street address of the user (max number of 100 characters) |
YES | |
city | City name as part of the full address |
YES | |
state | Postal code of the state as part of the full address, such as CA for California. For complete list of postal code name for US states please see: http://www.infoplease.com/ipa/A0110468.html |
YES | |
zip | Zip code as part of the full address |
YES | |
phone | Phone number of the user |
YES | |
group_code | Optional group code |
NO | |
phone_type | Type of phone: cell, home, or work. |
NO | |
language | string | Language |
NO |
card_number | Any existing card number that is not registered yet but already active. If no card number is provided, a new virtual card number will be assigned. |
NO | |
first_name | First name of the new user to be registered |
YES | |
last_name | Last name of the new user to be registered |
YES | |
Email address of the user |
YES | ||
password | Password for the user to also login from website |
YES | |
address | Street address of the user (max number of 100 characters) |
YES | |
city | City name as part of the full address |
YES | |
state | Postal code of the state as part of the full address, such as CA for California. For complete list of postal code name for US states please see: http://www.infoplease.com/ipa/A0110468.html |
YES | |
zip | Zip code as part of the full address |
YES | |
phone | Phone number of the user |
YES | |
group_code | Optional group code |
NO | |
phone_type | Type of phone: cell, home, or work. |
NO | |
language | string | Language |
NO |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json |
Body
Example request: { "card_number": "123456789012" "first_name": "John", "last_name": "Doe", "email": "test@test.com", "password": "abc123", "address": "123 test st", "city": "new york", "state": "NY", "zip": "10001" "phone": "5555555555" "group_code": "usconnect", "phone_type": "C" }
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
Example response: { "success": true, "errors": [], "id": 123 }
POST /mobile/v:version/user/register[/]
Fields
Field | Type | Description | Required |
---|---|---|---|
card_number | Any existing card number that is not registered yet but already active. If no card number is provided, a new virtual card number will be assigned. |
NO | |
first_name | First name of the new user to be registered |
YES | |
last_name | Last name of the new user to be registered |
YES | |
Email address of the user |
YES | ||
password | Password for the user to also login from website |
YES | |
address | Street address of the user (max number of 100 characters) |
YES | |
city | City name as part of the full address |
YES | |
state | Postal code of the state as part of the full address, such as CA for California. For complete list of postal code name for US states please see: http://www.infoplease.com/ipa/A0110468.html |
YES | |
zip | Zip code as part of the full address |
YES | |
phone | Phone number of the user |
YES | |
group_code | Optional group code |
NO | |
phone_type | Type of phone: cell, home, or work. |
NO | |
language | string | Language |
NO |
card_number | Any existing card number that is not registered yet but already active. If no card number is provided, a new virtual card number will be assigned. |
NO | |
first_name | First name of the new user to be registered |
YES | |
last_name | Last name of the new user to be registered |
YES | |
Email address of the user |
YES | ||
password | Password for the user to also login from website |
YES | |
address | Street address of the user (max number of 100 characters) |
YES | |
city | City name as part of the full address |
YES | |
state | Postal code of the state as part of the full address, such as CA for California. For complete list of postal code name for US states please see: http://www.infoplease.com/ipa/A0110468.html |
YES | |
zip | Zip code as part of the full address |
YES | |
phone | Phone number of the user |
YES | |
group_code | Optional group code |
NO | |
phone_type | Type of phone: cell, home, or work. |
NO | |
language | string | Language |
NO |
card_number | Any existing card number that is not registered yet but already active. If no card number is provided, a new virtual card number will be assigned. |
NO | |
first_name | First name of the new user to be registered |
YES | |
last_name | Last name of the new user to be registered |
YES | |
Email address of the user |
YES | ||
password | Password for the user to also login from website |
YES | |
address | Street address of the user (max number of 100 characters) |
YES | |
city | City name as part of the full address |
YES | |
state | Postal code of the state as part of the full address, such as CA for California. For complete list of postal code name for US states please see: http://www.infoplease.com/ipa/A0110468.html |
YES | |
zip | Zip code as part of the full address |
YES | |
phone | Phone number of the user |
YES | |
group_code | Optional group code |
NO | |
phone_type | Type of phone: cell, home, or work. |
NO | |
language | string | Language |
NO |
card_number | Any existing card number that is not registered yet but already active. If no card number is provided, a new virtual card number will be assigned. |
NO | |
first_name | First name of the new user to be registered |
YES | |
last_name | Last name of the new user to be registered |
YES | |
Email address of the user |
YES | ||
password | Password for the user to also login from website |
YES | |
address | Street address of the user (max number of 100 characters) |
YES | |
city | City name as part of the full address |
YES | |
state | Postal code of the state as part of the full address, such as CA for California. For complete list of postal code name for US states please see: http://www.infoplease.com/ipa/A0110468.html |
YES | |
zip | Zip code as part of the full address |
YES | |
phone | Phone number of the user |
YES | |
group_code | Optional group code |
NO | |
phone_type | Type of phone: cell, home, or work. |
NO | |
language | string | Language |
NO |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json |
Body
Example request: { "card_number": "123456789012" "first_name": "John", "last_name": "Doe", "email": "test@test.com", "password": "abc123", "address": "123 test st", "city": "new york", "state": "NY", "zip": "10001" "phone": "5555555555" "group_code": "usconnect", "phone_type": "C" }
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
Example response: { "success": true, "errors": [], "id": 123 }
POST /mobile/v:version/user/register[/]
Fields
Field | Type | Description | Required |
---|---|---|---|
card_number | Any existing card number that is not registered yet but already active. If no card number is provided, a new virtual card number will be assigned. |
NO | |
first_name | First name of the new user to be registered |
YES | |
last_name | Last name of the new user to be registered |
YES | |
Email address of the user |
YES | ||
password | Password for the user to also login from website |
YES | |
address | Street address of the user (max number of 100 characters) |
YES | |
city | City name as part of the full address |
YES | |
state | Postal code of the state as part of the full address, such as CA for California. For complete list of postal code name for US states please see: http://www.infoplease.com/ipa/A0110468.html |
YES | |
zip | Zip code as part of the full address |
YES | |
phone | Phone number of the user |
YES | |
group_code | Optional group code |
NO | |
phone_type | Type of phone: cell, home, or work. |
NO | |
language | string | Language |
NO |
card_number | Any existing card number that is not registered yet but already active. If no card number is provided, a new virtual card number will be assigned. |
NO | |
first_name | First name of the new user to be registered |
YES | |
last_name | Last name of the new user to be registered |
YES | |
Email address of the user |
YES | ||
password | Password for the user to also login from website |
YES | |
address | Street address of the user (max number of 100 characters) |
YES | |
city | City name as part of the full address |
YES | |
state | Postal code of the state as part of the full address, such as CA for California. For complete list of postal code name for US states please see: http://www.infoplease.com/ipa/A0110468.html |
YES | |
zip | Zip code as part of the full address |
YES | |
phone | Phone number of the user |
YES | |
group_code | Optional group code |
NO | |
phone_type | Type of phone: cell, home, or work. |
NO | |
language | string | Language |
NO |
card_number | Any existing card number that is not registered yet but already active. If no card number is provided, a new virtual card number will be assigned. |
NO | |
first_name | First name of the new user to be registered |
YES | |
last_name | Last name of the new user to be registered |
YES | |
Email address of the user |
YES | ||
password | Password for the user to also login from website |
YES | |
address | Street address of the user (max number of 100 characters) |
YES | |
city | City name as part of the full address |
YES | |
state | Postal code of the state as part of the full address, such as CA for California. For complete list of postal code name for US states please see: http://www.infoplease.com/ipa/A0110468.html |
YES | |
zip | Zip code as part of the full address |
YES | |
phone | Phone number of the user |
YES | |
group_code | Optional group code |
NO | |
phone_type | Type of phone: cell, home, or work. |
NO | |
language | string | Language |
NO |
card_number | Any existing card number that is not registered yet but already active. If no card number is provided, a new virtual card number will be assigned. |
NO | |
first_name | First name of the new user to be registered |
YES | |
last_name | Last name of the new user to be registered |
YES | |
Email address of the user |
YES | ||
password | Password for the user to also login from website |
YES | |
address | Street address of the user (max number of 100 characters) |
YES | |
city | City name as part of the full address |
YES | |
state | Postal code of the state as part of the full address, such as CA for California. For complete list of postal code name for US states please see: http://www.infoplease.com/ipa/A0110468.html |
YES | |
zip | Zip code as part of the full address |
YES | |
phone | Phone number of the user |
YES | |
group_code | Optional group code |
NO | |
phone_type | Type of phone: cell, home, or work. |
NO | |
language | string | Language |
NO |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json |
Body
Example request: { "card_number": "123456789012" "first_name": "John", "last_name": "Doe", "email": "test@test.com", "password": "abc123", "address": "123 test st", "city": "new york", "state": "NY", "zip": "10001" "phone": "5555555555" "group_code": "usconnect", "phone_type": "C" }
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
Example response: { "success": true, "errors": [], "id": 123 }
POST /mobile/v:version/user/register[/]
Fields
Field | Type | Description | Required |
---|---|---|---|
card_number | Any existing card number that is not registered yet but already active. If no card number is provided, a new virtual card number will be assigned. |
NO | |
first_name | First name of the new user to be registered |
YES | |
last_name | Last name of the new user to be registered |
YES | |
Email address of the user |
YES | ||
password | Password for the user to also login from website |
YES | |
address | Street address of the user (max number of 100 characters) |
YES | |
city | City name as part of the full address |
YES | |
state | Postal code of the state as part of the full address, such as CA for California. For complete list of postal code name for US states please see: http://www.infoplease.com/ipa/A0110468.html |
YES | |
zip | Zip code as part of the full address |
YES | |
phone | Phone number of the user |
YES | |
group_code | Optional group code |
NO | |
phone_type | Type of phone: cell, home, or work. |
NO | |
language | string | Language |
NO |
card_number | Any existing card number that is not registered yet but already active. If no card number is provided, a new virtual card number will be assigned. |
NO | |
first_name | First name of the new user to be registered |
YES | |
last_name | Last name of the new user to be registered |
YES | |
Email address of the user |
YES | ||
password | Password for the user to also login from website |
YES | |
address | Street address of the user (max number of 100 characters) |
YES | |
city | City name as part of the full address |
YES | |
state | Postal code of the state as part of the full address, such as CA for California. For complete list of postal code name for US states please see: http://www.infoplease.com/ipa/A0110468.html |
YES | |
zip | Zip code as part of the full address |
YES | |
phone | Phone number of the user |
YES | |
group_code | Optional group code |
NO | |
phone_type | Type of phone: cell, home, or work. |
NO | |
language | string | Language |
NO |
card_number | Any existing card number that is not registered yet but already active. If no card number is provided, a new virtual card number will be assigned. |
NO | |
first_name | First name of the new user to be registered |
YES | |
last_name | Last name of the new user to be registered |
YES | |
Email address of the user |
YES | ||
password | Password for the user to also login from website |
YES | |
address | Street address of the user (max number of 100 characters) |
YES | |
city | City name as part of the full address |
YES | |
state | Postal code of the state as part of the full address, such as CA for California. For complete list of postal code name for US states please see: http://www.infoplease.com/ipa/A0110468.html |
YES | |
zip | Zip code as part of the full address |
YES | |
phone | Phone number of the user |
YES | |
group_code | Optional group code |
NO | |
phone_type | Type of phone: cell, home, or work. |
NO | |
language | string | Language |
NO |
card_number | Any existing card number that is not registered yet but already active. If no card number is provided, a new virtual card number will be assigned. |
NO | |
first_name | First name of the new user to be registered |
YES | |
last_name | Last name of the new user to be registered |
YES | |
Email address of the user |
YES | ||
password | Password for the user to also login from website |
YES | |
address | Street address of the user (max number of 100 characters) |
YES | |
city | City name as part of the full address |
YES | |
state | Postal code of the state as part of the full address, such as CA for California. For complete list of postal code name for US states please see: http://www.infoplease.com/ipa/A0110468.html |
YES | |
zip | Zip code as part of the full address |
YES | |
phone | Phone number of the user |
YES | |
group_code | Optional group code |
NO | |
phone_type | Type of phone: cell, home, or work. |
NO | |
language | string | Language |
NO |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json |
Body
Example request: { "card_number": "123456789012" "first_name": "John", "last_name": "Doe", "email": "test@test.com", "password": "abc123", "address": "123 test st", "city": "new york", "state": "NY", "zip": "10001" "phone": "5555555555" "group_code": "usconnect", "phone_type": "C" }
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
Example response: { "success": true, "errors": [], "id": 123 }
UserRewards
This API endpoint will allow to fetch the total number of reward points has been collected by the given user through transaction activities, and available for redemption.
GET /mobile/v:version/user/rewards[/]
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
Example Response: { "id": 1, "rewards": 1000, }
GET /mobile/v:version/user/rewards[/]
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
Example Response: { "id": 1, "rewards": 1000, }
GET /mobile/v:version/user/rewards[/]
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
Example Response: { "id": 1, "rewards": 1000, }
GET /mobile/v:version/user/rewards[/]
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
Example Response: { "id": 1, "rewards": 1000, }
UserTransferBalance
This API endpoint will allow to transfer balance between different OAN cards owned by the user.
POST /mobile/v:version/user/transfer-balance[/]
Fields
Field | Type | Description | Required |
---|---|---|---|
from_oan | OAN card number that belongs to the user and from which you want to transfer the balance. |
YES | |
to_oan | OAN card number that belongs to the user and to which you want to transfer the balance. |
YES | |
amount | Amount to transfer. |
YES | |
from_oan | OAN card number that belongs to the user and from which you want to transfer the balance. |
YES | |
to_oan | OAN card number that belongs to the user and to which you want to transfer the balance. |
YES | |
amount | Amount to transfer. |
YES | |
from_oan | OAN card number that belongs to the user and from which you want to transfer the balance. |
YES | |
to_oan | OAN card number that belongs to the user and to which you want to transfer the balance. |
YES | |
amount | Amount to transfer. |
YES | |
from_oan | OAN card number that belongs to the user and from which you want to transfer the balance. |
YES | |
to_oan | OAN card number that belongs to the user and to which you want to transfer the balance. |
YES | |
amount | Amount to transfer. |
YES |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json |
Body
Example Request: { "from_oan": "20200000085821", "to_oan": "91234567891234", "amount": 10.00 }
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
Example Response: { "success": true, "from_transaction_id": 1, "to_transaction_id": 2, "amount": 10.00, "from_oan_balance": 90.00, "to_oan_balance": 100.00, "timestamp": 1459891476 }
POST /mobile/v:version/user/transfer-balance[/]
Fields
Field | Type | Description | Required |
---|---|---|---|
from_oan | OAN card number that belongs to the user and from which you want to transfer the balance. |
YES | |
to_oan | OAN card number that belongs to the user and to which you want to transfer the balance. |
YES | |
amount | Amount to transfer. |
YES | |
from_oan | OAN card number that belongs to the user and from which you want to transfer the balance. |
YES | |
to_oan | OAN card number that belongs to the user and to which you want to transfer the balance. |
YES | |
amount | Amount to transfer. |
YES | |
from_oan | OAN card number that belongs to the user and from which you want to transfer the balance. |
YES | |
to_oan | OAN card number that belongs to the user and to which you want to transfer the balance. |
YES | |
amount | Amount to transfer. |
YES | |
from_oan | OAN card number that belongs to the user and from which you want to transfer the balance. |
YES | |
to_oan | OAN card number that belongs to the user and to which you want to transfer the balance. |
YES | |
amount | Amount to transfer. |
YES |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json |
Body
Example Request: { "from_oan": "20200000085821", "to_oan": "91234567891234", "amount": 10.00 }
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
Example Response: { "success": true, "from_transaction_id": 1, "to_transaction_id": 2, "amount": 10.00, "from_oan_balance": 90.00, "to_oan_balance": 100.00, "timestamp": 1459891476 }
POST /mobile/v:version/user/transfer-balance[/]
Fields
Field | Type | Description | Required |
---|---|---|---|
from_oan | OAN card number that belongs to the user and from which you want to transfer the balance. |
YES | |
to_oan | OAN card number that belongs to the user and to which you want to transfer the balance. |
YES | |
amount | Amount to transfer. |
YES | |
from_oan | OAN card number that belongs to the user and from which you want to transfer the balance. |
YES | |
to_oan | OAN card number that belongs to the user and to which you want to transfer the balance. |
YES | |
amount | Amount to transfer. |
YES | |
from_oan | OAN card number that belongs to the user and from which you want to transfer the balance. |
YES | |
to_oan | OAN card number that belongs to the user and to which you want to transfer the balance. |
YES | |
amount | Amount to transfer. |
YES | |
from_oan | OAN card number that belongs to the user and from which you want to transfer the balance. |
YES | |
to_oan | OAN card number that belongs to the user and to which you want to transfer the balance. |
YES | |
amount | Amount to transfer. |
YES |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json |
Body
Example Request: { "from_oan": "20200000085821", "to_oan": "91234567891234", "amount": 10.00 }
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
Example Response: { "success": true, "from_transaction_id": 1, "to_transaction_id": 2, "amount": 10.00, "from_oan_balance": 90.00, "to_oan_balance": 100.00, "timestamp": 1459891476 }
POST /mobile/v:version/user/transfer-balance[/]
Fields
Field | Type | Description | Required |
---|---|---|---|
from_oan | OAN card number that belongs to the user and from which you want to transfer the balance. |
YES | |
to_oan | OAN card number that belongs to the user and to which you want to transfer the balance. |
YES | |
amount | Amount to transfer. |
YES | |
from_oan | OAN card number that belongs to the user and from which you want to transfer the balance. |
YES | |
to_oan | OAN card number that belongs to the user and to which you want to transfer the balance. |
YES | |
amount | Amount to transfer. |
YES | |
from_oan | OAN card number that belongs to the user and from which you want to transfer the balance. |
YES | |
to_oan | OAN card number that belongs to the user and to which you want to transfer the balance. |
YES | |
amount | Amount to transfer. |
YES | |
from_oan | OAN card number that belongs to the user and from which you want to transfer the balance. |
YES | |
to_oan | OAN card number that belongs to the user and to which you want to transfer the balance. |
YES | |
amount | Amount to transfer. |
YES |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json
application/vnd.mobile-api.v4+json
application/json |
Body
Example Request: { "from_oan": "20200000085821", "to_oan": "91234567891234", "amount": 10.00 }
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
Header | Value |
---|---|
Content-Type | application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json
application/vnd.mobile-api.v4+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
Example Response: { "success": true, "from_transaction_id": 1, "to_transaction_id": 2, "amount": 10.00, "from_oan_balance": 90.00, "to_oan_balance": 100.00, "timestamp": 1459891476 }