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 in your request, our gateway generates one. | Sale |
| check | account_type | String | 1-8 | Required | Type of checking account that the customer uses to pay for the goods or services. Possible values are: Checking or Savings. | Sale |
| check | account_number | String | 1-17 | Required | Customer's checking account number. | Sale |
| check | bank_number | String | 6 | Optional | The bank number is a six-digit number that identifies the specific bank branch of an New Zealand financial institution used for a check/direct debit transaction. The bank number needs to be passed in a 000000 format. The bank number id the first six digits of the full bank account number. | Sale |
| check | routing_number | String | 9 | Required | Number that identifies the customer's bank and branch. | Sale |
| check | branch_transit_number | String | 5 | Conditional | For Canadian checking accounts, this number identifies that customer's branch. This number is the first 5 digits at the bottom of a check. | Sale |
| check | bsb_number | String | 7 | Optional | The BSB (Bank State Branch) number is a six-digit number that identifies the specific bank branch of an Australian financial institution used for a check/direct debit transaction. The BSB number needs to be passed in a XXY-ZZZ format. | Sale |
| check | financial_institution_number | String | 3 | Optional | For Canadian checking accounts, this number identifies the customer's bank. | Sale |
| check | check_number | String | 1-15 | Optional | Number that identifies a physical check. | Sale |
| customer | first_name | String | 1-50 | Required | Customer's first name. | Sale |
| customer | last_name | String | 1-50 | Required | 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 first_name, last_name, and middle_name fields. | Sale |
| payment | amount | String | 4-9 | Required | Total dollar amount for the transaction. Value must be between 0.01 and 999999.99. | Sale |
| payment | currency_code | String | 3 | Required | ISO currency code for the transaction. | Sale |
| payment | invoice_number | String | 1-25 | Optional | Invoice number or order number that the merchant assigns to the transaction. | Sale |
| transaction | country_code | String | 3 | Required | Code that represents the country where the transaction originated from. | Sale |
| transaction | entry_class | String | 1-3 | Required | Standard Entry Class (SEC) that identifies how the customer submitted the check details. For a list of possible values, see the entry_class enumeration. | Sale |
| transaction | payment_purpose_code | String | 3 | Conditional | Identifies the payment type to the customer. This applies only to Canadian check transactions. | Sale |
| transaction | language | String | 1-5 | Optional | Language for the text that displays on your payment page and receipts. | Sale |
| transaction | processing_indicators | Oject | - | Optional | Object that includes indicators for additional actions. See the processing_indicators object. | Sale |
| Field | Type | Size | Required | Description | Used By |
|---|---|---|---|---|---|
| check_verify | Boolean | - | Optional | If set to true, we verify the checking account details. | Sale |
| create_token | Boolean | - | Optional | If set to true, we save the customer's checking account details to our vault. Our gateway creates a token and send it in the response. | Sale |
| Object | Field | Type | Description | Returned By |
|---|---|---|---|---|
| - | checksale_id | String | Unique id identifying a check sales transaction. | Sale |
| - | status | String | Indicates the status of the transaction. Possible values:
| Sale |
| - | 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. This is the reference_id that you can include in the endpoint URL for follow-on transactions. | Sale |
| check | masked_account_number | String | Masked account number used for a check transaction. | Sale |
| check | routing_number | String | Routing number used for a check transaction. | Sale |
| check | branch_transit_number | String | For Canadian checking accounts, this number identifies that customer's branch. This number is the first 5 digits at the bottom of a check. | Sale |
| check | bsb_number | String | The BSB (Bank State Branch) number is a six-digit number that identifies the specific bank branch of an Australian financial institution used for a check/direct debit transaction. The BSB number needs to be passed in a XXY-ZZZ format. | Sale |
| check | bank_number | String | The bank number is a six-digit number that identifies the specific bank branch of an New Zealand financial institution used for a check/direct debit transaction. The bank number needs to be passed in a 000000 format. The bank number id the first six digits of the full bank account number. | Sale |
| check | check_number | String | The check number used for the transaction. | Sale |
| check | financial_institution_number | String | For Canadian checking accounts, this number identifies the customer's bank. | Sale |
| check | token |
| Field | Type | Description | Returned By |
|---|---|---|---|
| href | String | Endpoint URL for the follow-on transaction using the checksale_id. | Sale |
| relation | String | Relationship between the endpoint you sent the original request to and the endpoint for the follow-on transaction. The value is one of the following:
| Sale |
| method | String | HTTP method for sending the request. The value is one of the following:
| Sale |
| 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 check sales transaction using a sale id. | Sale |
| Field | Type | Description | Returned By |
|---|---|---|---|
| href | String | Endpoint URL for the follow-on transaction using the reference_id. | Sale |
| relation | String | Relationship between the endpoint you sent the original request to and the endpoint for the follow-on transaction. The value is one of the following:
| Sale |
| method | String | HTTP method for sending the request. The value is one of the following:
| Sale |
| 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 check sales transaction using a reference id. | Sale |
| String |
| Unique reference for the customer's payment details that they stored in our vault. Do not send this token in follow-on transactions as it is not yet compliant with card brand regulations. |
| Sale |
| payment | amount | String | Total amount taken from the customer's account. | Sale |
| payment | currency_code | String | ISO currency code for the transaction. | Sale |
| payment | type | String | Type of payment for the transaction. | Sale |
| payment | invoice_number | String | Merchant-generated invoice number for transaction. | Sale |
| transaction | entry_class | String | Standard entry class to designate how the transaction was authorized by the originator. Applicable for US check transactions only. | Sale |
| transaction | language | String | Language for the text that displays on your payment page and receipts. | Sale |
| transaction | payment_purpose_code | String | Identifies the payment type to the customer. This applies only to Canadian check transactions. | Sale |
| transaction | verification_code | String | Code provided for successful check verifications. | Sale |
| links | checksale_id | Object | Object that includes HATEOAS links for follow-on transactions using the checksale_id. | Sale |
| links | reference_id | Object | Object that includes HATEOAS links for follow-on transactions using the reference_id. | Sale |