Key | Expected Values | Description |
billing_first_name | String | The customer's billing first name. |
billing_last_name | String | The customer's billing last name. |
billing_company | String | The customer's billing company. |
billing_country | String | The customer's billing country name or billing country ISO-Alpha2. (EG: United States or US) |
billing_address_1 | String | The customer's billing street address part 1. |
billing_address_2 | String | The customer's billing street address part 2. |
billing_city | String | The customer's billing city. |
billing_region | String | The customer's billing region or state. |
billing_postcode | String / Number | The customer's billing postal code or zip code. |
billing_email | String | The customer's billing email address. |
billing_phone | Number | The customer's billing is 11 to 14-digit phone number. (If less than 10 digits are provided, our AI will guess the country code.) |
shipping_first_name | String | The customer's shipping first name. |
shipping_last_name | String | The customer's shipping last name. |
shipping_company | String | The customer's shipping company. |
shipping_country | String | The customer's shipping country name or shipping country ISO-Alpha2. (EG: United States or US) |
shipping_address_1 | String | The customer's shipping street address part 1. |
shipping_address_2 | String | The customer's shipping street address part 2. |
shipping_city | String | The customer's shipping city. |
shipping_region | String | The customer's shipping region or state. |
shipping_postcode | String / Number | The customer's shipping postal code or zip code. |
shipping_email | String | The customer's shipping email address. |
shipping_phone | Number | The customer's shipping 11 to 14-digit phone number. (If less than 10 digits are provided, our AI will guess the country code.) |
username | String | The customer's username. |
password_hash | SHA256 / string | For security reasons and following industry best practices, a SHA256 hash of the user's password for better user analysis. |
credit_card_bin | Number | The first six digits of the credit or debit card referred to as the Bank Identification Number. |
credit_card_hash | SHA256 / string | For security reasons and following industry best practices, a SHA256 hash of the credit card number is accepted to check against blocklisted cards. |
credit_card_expiration_month | Number | Two-number format of the credit card's expiration month. For example, May would be "05". |
credit_card_expiration_year | Number | Two-number format of the credit card's expiration year. For example, 2022 would be "22". |
avs_code | Number | One-character Address Verification Service (AVS) response code provided by the credit card processor or bank. |
cvv_code | Number | One-character Card Verification Value (CVV2) response code provided by the credit card processor or bank. |
order_amount | Number | The total balance of the entire order without currency symbols. |
order_quantity | Number | Quantity of items for this order. |
recurring | boolean | Is this a recurring order that automatically rebills? |
recurring_times | Number | If this is a recurring order, how many times has this recurring order been rebilled? For example, if this is the third time the user is being billed, please enter this value as "3". If this is the initial recurring order, please leave the value as blank or enter "1". |
Advanced Options
Additional Request Parameters