Loading...
| Object | Field | Type | Size | Required | Description | Used By |
|---|---|---|---|---|---|---|
| - | reference_id | String | 1-50 | Required | Unique identifier for a transaction. If you do not create a reference_id, our gateway generates one. The Format is MER-UUID. For example, MER-XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX. |
|
| card | temporary_token | String | 1-34 | Required | Temporary identifier for the card details. Our gateway generates this when the customer submits their payment details. You can use this token only once. | Sale |
| customer | billing_address | Object | - | Required | Container that includes information about the customer's billing address. See the billing_address object. | Sale |
| customer | title | String | 1-10 | Optional | Customer's title. | Sale |
| customer | first_name | String | 1-50 | Optional | Customer's first name. | Sale |
| customer | last_name | String | 1-50 | Optional | Customer's last name. | Sale |
| customer | middle_name | String | 1-50 | Optional | Customer's middle name. | Sale |
| customer | business_name | String | 1-50 | Optional | Name of the customer's business. If the customer is a business, use this field instead of the title, first_name, last_name, and middle_name fields. | Sale |
| customer | String | 1-50 | Optional | Customer's email address. | Sale | |
| customer | phone | String | 2-50 | Optional | Customer's phone number. | Sale |
| customer | note | String | 1-40 | Optional | Extra information that you can add about the customer. | Sale |
| payment | amount | String | 4-9 | Required | Total dollar amount for the transaction. Value must be between 0.01 and 999999.99. |
|
| payment | currency_code | String | 3 | Required | ISO currency code for the transaction. |
|
| payment | gratuity_amount | String | 1-7 | Optional | Dollar amount to include as a tip in the transaction. |
|
| payment | invoice_number | String | 1-25 | Optional | Invoice number or order number that the merchant assigns to the transaction. |
|
| transaction | country_code | String | 3 | Required | Code that represents the country where the transaction originated. | Sale |
| transaction | processing_indicators | Object | - | Required | Object that includes indicators for additional actions. See the processing_indicators object. | Sale |
| transaction | language | String | 1-5 | Optional | Language for the text that displays on your payment page and receipts. If the customer uses an EMV card, the language registered to the card may override the language on the payment page and receipt. | Sale |
| transaction | soft_descriptor | String | 1-17 | Optional | Descriptor that displays on a customer's card statement. This field does not apply to transactions in Australia or New Zealand. | Sale |
| transaction | ecommerce_indicator | String | 1 | Optional | Identifies the type of e-Commerce transaction. For a list of possible values, see ecommerce_indicator enumeration. You must send this field for transactions in the US and Canada. Do not send for other regions. | Sale |
| shipping | date | String | 10 | Optional | Date the merchant shipped the item. | Sale |
| shipping | address | Object | - | Optional | Object that includes information about the customer's shipping address. See the address object. | Sale |
| Field | Type | Size | Required | Description | Used By |
|---|---|---|---|---|---|
| line1 | String | 1-50 | Optional | First line of the customer's address. | Sale |
| line2 | String | 1-50 | Optional | Second line of the customer's address. | Sale |
| city | String | 1-50 | Optional | City of the customer's address. | Sale |
| state | String | 1-50 | Optional | State or province of the customer's address. Do not include this in your request for New Zealand addresses. | Sale |
| country | String | 1-50 | Optional | Country of the customer's address. | Sale |
| postal_code | String | 1-9 | Optional | Postal code of the customer's address. | Sale |
| Field | Type | Size | Required | Description | Used By |
|---|---|---|---|---|---|
| line1 | String | 1-50 | Required | First line of the customer's address. | Sale |
| line2 | String | 1-50 | Optional | Second line of the customer's address. | Sale |
| city | String | 1-50 | Optional | City of the customer's address. | Sale |
| state | String | 1-50 | Optional | State or province of the customer's address. Do not include this in your request for New Zealand addresses. | Sale |
| postal_code | String | 1-9 | Required | Postal code of the customer's address. | Sale |
| country | String | 1-50 | Optional | Country of the customer's address. | Sale |
| Field | Type | Size | Required | Description | Used By |
|---|---|---|---|---|---|
| address_verification_service | Boolean | - | Required | If set to true, we run AVS on the transaction. Our gateway returns the AVS information in the response. | Sale |
| generate_receipt | Boolean | - | Required | If set to true, the POS generates a customer copy and a merchant copy of the receipt for the transaction. | Sale |
| allow_duplicate | Boolean | - | Optional | If set to true, we allow you to send duplicate transactions. The default time frame to block duplicate transactions is 15 minutes. | Sale |
| create_token | Boolean | - | Optional | If set to true, we save the card details to our vault. Our gateway creates a token and returns it in the response. | Sale |
| partial_approval | Boolean | - | Optional | If set to true, we allow you to accept partial approvals. | Sale |
| Object | Field | Type | Description | Returned By |
|---|---|---|---|---|
| - | creditsale_id | String | Unique identifier that our gateway generated for the sale. |
|
| - | status | String | Indicates the status of the sale. For a list of possible values, see the status enumeration. |
|
| - | approval_code | String | Approval code for the sale from the processor. | Sale |
| - | avs_response | String | Response code from an address verification service (AVS) lookup. | Sale |
| - | avs_response_description | String | Text that describes the response code that the processor returned in the avs_response field. | Sale |
| - | processor_response | String | Masked card number of the card that the customer used for the sale. | Sale |
| card | cardholder_name | String | Name that appears on the customer’s card. | Sale |
| card | masked_card_number | String | Masked card number of the card that the customer used for the transaction. |
|
| card | expiry_month | String | Month that the card expires, in MM format. If our gateway cannot return an expiry month, it returns a value of NA. |
|
| card | expiry_year | String | Year that the card expires, in YY format. If our gateway cannot return an expiry year, it returns a value of NA. |
|
| card | type | String | Name of the card brand that issued the card. |
|
| payment | amount | String | Total amount taken from the customer’s account. |
|
| payment | currency_code | String | ISO currency code for the sale. For a list of possible values, see the card type enumeration. | Sale |
| payment | type | String | Type of payment for the sale. For a list of possible values, see the payment type enumeration. |
| Field | Type | Description | Returned By |
|---|---|---|---|
| customer_receipt | String | Text for the customer’s receipt, which contains the details of the sale. |
|
| merchant_receipt | String | Text for the merchant’s receipt, which contains the details of the sale. |
|
| approval_code | String | Approval code for the transaction from the processor. |
|
Our gateway returns a label field and a value field for each object. For example, our gateway returns the following for the amount object:
"amount":
{
"label": "Total Amount",
"value": "99.45"
}| Object | Type | Description | Returned By |
|---|---|---|---|
| amount | String | Total amount of the transaction. |
|
| approval_code | String | Approval code for the transaction from the processor. | Sale |
| batch_number | String | Unique identifier of the batch. |
|
| card_type | String | Type of card the customer used for the sale. |
|
| entry_method | String | Indicates how the user entered the card details. |
|
| masked_card_number | String | Masked card number of the card that the customer used for the transaction. |
|
| original_auth_code | String | ----------- | Void |
| reference_id | String | Unique identifier that the merchant created for the transaction. If the merchant does not send this in the request, our gateway automatically creates the reference_id instead. |
|
| total_amount | String | Total amount of the transaction. Our gateway returns either a value or a blank line. |
|
| transaction_datetime | String | Date and time of the updated sale that the processor returns, in YYYY-MM-DDThh:mm:ssZ format, for example, 2019-12-15T13:00:00Z. |
|
| transaction_id | String | Unique ID our gateway assigned to the transaction. |
|
| transaction_type | String | Type of transaction the merchant ran. |
|
| Field | Type | Description | Returned By |
|---|---|---|---|
| authorization_agreement | String | Text that describes the merchant's authorization agreement, for example, I agree to pay the total amount according to the card issuer agreement. | Sale |
| copy_label_customer | String | Text that identifies the receipt as the customer's copy |
|
| copy_label_merchant | String | Text that identifies the receipt as the merchant's copy. |
|
| verbiage | String | Additional text that the merchant can include on the receipt, for example, Approved - Thank You |
|
| Field | Type | Description | Returned By |
|---|---|---|---|
| href | String | Endpoint URL for the follow-on transaction using the capture_id. |
|
| relation | String | Relationship between the endpoint you sent the original request to and the endpoint for the follow-on transaction. |
|
| method | String | HTTP method for sending the request. |
|
| description | String | Text that describes how to use the endpoint URL our gateway provided in the href field. For example, use this endpoint to retrieve a previous sales transaction using a sale id. |
|
| Field | Type | Description | Returned By |
|---|---|---|---|
| href | String | Endpoint URL for the follow-on transaction using the reference_id. |
|
| relation | String | Relationship between the endpoint you sent the original request to and the endpoint for the follow-on transaction. |
|
| method | String | HTTP method for sending the request. |
|
| description | String | Text that describes how to use the endpoint URL our gateway provided in the href field. For example, use this endpoint to retrieve a previous sales transaction using a sale id. |
|
| transaction | batch_amount | String | Amount in the open batch. |
|
| transaction | batch_number | String | Identifier for the open batch. |
|
| transaction | entry_type | String | Indicates how the user entered the card details | Sale |
| transaction | language | String | Language for the text that displays on the device and receipts. | Sale |
| receipt | text | Object | Object that contains text for the customer copy of the receipt and the merchant copy of the receipt. For a list of fields, See text object. |
|
| receipt | id | String | Unique alphanumeric value that our gateway assigns to the receipt. |
|
| receipt | attributes | Object | Object that contains details of text that the receipt can include. For a list of fields, See attributes object. |
|
| receipt | labeled_attributes | Object | Object that contains details of the sale. For a list of fields, See labeled_attributes object. |
|
| links | creditsale_id | Object | Object that includes HATEOAS links for follow-on transactions using the creditsale_id. For a list of fields, See creditsale_id object. | Sale |
| links | reference_id | Object | Object that includes HATEOAS links for follow-on transactions using the reference_id. For a list of fields, See reference_id object. |
|
| - | reference_id | String | Unique identifier that the merchant created for the transaction. If the merchant does not send this in the request, our gateway automatically creates the reference_id instead. |
|