CardDetails
GET /mobile/v:version/card/:oan_number[/]
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v6+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.v6+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
CardListTransaction
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 |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v6+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.v6+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
EmailVerificationStatus
This API endpoint checks if an email has been verified.
POST /mobile/v:version/user/emailVerificationStatus[/]
Fields
Field | Type | Description | Required |
---|---|---|---|
Email address of the user. |
YES |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v6+json
application/json
application/*+json |
Content-Type | application/vnd.mobile-api.v6+json
application/json |
Body
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.v6+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
MigratePurchase
POST /mobile/v:version/migrate/purchase[/]
Fields
Field | Type | Description | Required |
---|---|---|---|
device_serial_number | String | Serial number of device making request or pos_id |
NO |
card_number | integer | Field id can be card_number | card_info OAN or Card number being using to make purchase |
NO |
external_reference_id | string | Supplier generated ID of the original call |
NO |
items | Array | Array of items that are to be purchased. |
NO |
card_info | The card number or OAN. |
NO | |
account_info | string | The account identifier. This could be the account ID, card OAN, card number, or other account alias. |
NO |
account_id | The account ID. |
NO | |
method | string | regular or apple_pay (default is regular) |
NO |
country_code | string | Country code. Possible values: USA | CAN. Defaults to USA. Required if currency_type is present. |
NO |
currency_type | string | Currency code. Possible values: USD | CAD. Defaults to USD. Required if country_code is present. |
NO |
affiliate_name | string | Affiliate name. |
NO |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v6+json
application/json
application/*+json |
Content-Type | application/vnd.mobile-api.v6+json
application/json |
Body
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.v6+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
MigrateReversal
POST /mobile/v:version/migrate/reversal[/]
Fields
Field | Type | Description | Required |
---|---|---|---|
external_reference_id | string | External reference ID that will be saved with the transaction. |
NO |
original_external_reference_id | string | If the original transaction ID is unknown, the transaction may be reversed by specifying the external_reference_id that was used in the transaction. |
NO |
original_transaction_id | string | Transaction ID of the transaction you want to reverse. |
NO |
original_transaction_type | string | The type of the original transaction. |
YES |
device_serial_number | string | device_serial_number |
YES |
country_code | string | Country code. Possible values: USA | CAN. Defaults to USA. Required if currency_type is present. |
NO |
currency_type | string | Currency code. Possible values: USD | CAD. Defaults to USD. Required if country_code is present. |
NO |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v6+json
application/json
application/*+json |
Content-Type | application/vnd.mobile-api.v6+json
application/json |
Body
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.v6+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
ProcessPayment
POST /mobile/v:version/user/processPayment[/]
Fields
Field | Type | Description | Required |
---|---|---|---|
device_serial_number | Device Serial Number |
YES | |
oan | OAN |
YES |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v6+json
application/json
application/*+json |
Content-Type | application/vnd.mobile-api.v6+json
application/json |
Body
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.v6+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
SendEmailVerification
This API endpoint resends the verification email if the given email is not already authenticated.
POST /mobile/v:version/user/sendEmailVerification[/]
Fields
Field | Type | Description | Required |
---|---|---|---|
Email address of the user. |
YES |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v6+json
application/json
application/*+json |
Content-Type | application/vnd.mobile-api.v6+json
application/json |
Body
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.v6+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
TouchlessDeviceSerialNumber
GET /mobile/v:version/touchlessDeviceSN/:mac_address[/]
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v6+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.v6+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
UserAccountDelete
DELETE /mobile/v:version/user/delete-account[/]
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v6+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.v6+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
UserAddAdpPayroll
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 |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v6+json
application/json
application/*+json |
Content-Type | application/vnd.mobile-api.v6+json
application/json |
Body
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.v6+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
UserAdpDelete
DELETE /mobile/v:version/user/adp/:funding_source_id[/]
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v6+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.v6+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
UserAppleWallet
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 |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v6+json
application/json
application/*+json |
Content-Type | application/vnd.mobile-api.v6+json
application/json |
Body
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.v6+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
UserAutoReloadSetup
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 |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v6+json
application/json
application/*+json |
Content-Type | application/vnd.mobile-api.v6+json
application/json |
Body
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.v6+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
UserCardNew
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 |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v6+json
application/json
application/*+json |
Content-Type | application/vnd.mobile-api.v6+json
application/json |
Body
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.v6+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
UserCardSetPrimary
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 |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v6+json
application/json
application/*+json |
Content-Type | application/vnd.mobile-api.v6+json
application/json |
Body
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.v6+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
UserCharities
GET /mobile/v:version/user/charities
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v6+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.v6+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
UserCharityDetails
GET /mobile/v:version/user/charities/:charity_id[/]
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v6+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.v6+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
UserDetails
GET /mobile/v:version/user[/]
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v6+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.v6+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
UserEditProfile
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 |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v6+json
application/json
application/*+json |
Content-Type | application/vnd.mobile-api.v6+json
application/json |
Body
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.v6+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
UserFrame
GET /mobile/v:version/userframe[/]
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v6+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.v6+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
UserFundingDelete
DELETE /mobile/v:version/user/funding/:funding_source_id[/]
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v6+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.v6+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
UserFundingEdit
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 |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v6+json
application/json
application/*+json |
Content-Type | application/vnd.mobile-api.v6+json
application/json |
Body
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.v6+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
UserFundingNew
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. |
NO | |
zipcode | Zip code associated with the card. |
NO | |
number | Last 4 of Credit Card number. |
NO | |
address | Billing address of the credit/debit card you are adding as a funding source. |
NO | |
city | Billing city of the credit/debit card you are adding as a funding source. |
NO | |
state | Billing state of the credit/debit card you are adding as a funding source. |
NO | |
token | Token from the Heartland iframe |
NO | |
type | Card Type |
NO | |
exp_year | Card Type |
NO | |
exp_month | Card Type |
NO | |
uid | UID |
NO |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v6+json
application/json
application/*+json |
Content-Type | application/vnd.mobile-api.v6+json
application/json |
Body
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.v6+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
UserListAutoReload
GET /mobile/v:version/user/cards/:oan_number/auto-reload[/]
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v6+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.v6+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
UserListCards
GET /mobile/v:version/user/cards[/]
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v6+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.v6+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
UserListFunding
GET /mobile/v:version/user/funding[/]
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v6+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.v6+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
UserLoad
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 |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v6+json
application/json
application/*+json |
Content-Type | application/vnd.mobile-api.v6+json
application/json |
Body
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.v6+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
UserLogin
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 |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v6+json
application/json
application/*+json |
Content-Type | application/vnd.mobile-api.v6+json
application/json |
Body
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.v6+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
UserPasswordReset
POST /mobile/v:version/user/request-temp-password
Fields
Field | Type | Description | Required |
---|---|---|---|
username | Email address of the user. |
YES |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v6+json
application/json
application/*+json |
Content-Type | application/vnd.mobile-api.v6+json
application/json |
Body
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.v6+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
UserPickCharity
POST /mobile/v:version/user/pick-charity
Fields
Field | Type | Description | Required |
---|---|---|---|
charity_id | Unique ID of the charity to be selected. |
YES |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v6+json
application/json
application/*+json |
Content-Type | application/vnd.mobile-api.v6+json
application/json |
Body
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.v6+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
UserPromotionDetails
GET /mobile/v:version/user/promotions/:promotion_id[/]
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v6+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.v6+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
UserPromotions
GET /mobile/v:version/user/promotions[/]
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v6+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.v6+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
UserRedeemPromotion
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 |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v6+json
application/json
application/*+json |
Content-Type | application/vnd.mobile-api.v6+json
application/json |
Body
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.v6+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
UserRedeem
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 |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v6+json
application/json
application/*+json |
Content-Type | application/vnd.mobile-api.v6+json
application/json |
Body
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.v6+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
UserRegistration
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 |
uniqueDeviceID | string | Unique Device ID, may also be sent as a header |
NO |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v6+json
application/json
application/*+json |
Content-Type | application/vnd.mobile-api.v6+json
application/json |
Body
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.v6+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
UserRewards
GET /mobile/v:version/user/rewards[/]
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v6+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.v6+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
UserTransferBalance
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 |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.mobile-api.v6+json
application/json
application/*+json |
Content-Type | application/vnd.mobile-api.v6+json
application/json |
Body
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.v6+json
application/json
application/*+json |
Allow | Comma-separated list of all HTTP methods allowed |