Loading...
To view the details of a sale, send a GET request to the relevant endpoint.
| Scenario | Merchant uses the POS to: |
|---|---|
| Merchant wants to view the details of a previous sale. | Search for the previous sale using the reference_id. |
The response from this endpoint doesn't provide HATEOAS links.
| Object | Field | Type | Description |
|---|---|---|---|
| N/A | invoice_number | String | Invoice number for the sale. |
| N/A | amount | String | Total dollar amount of the sale. The value includes two decimal places, for example, 10.00.Note: • If the transaction was partially approved, the amount we return is less than the dollar amount you sent in the request. • If the request included a tip, the amount we return is greater than the amount you send in the request. |
| transactions | tender_type | String | The payment type that the customer used for the sale. The value is one of the following: • credit• debit |
| entry_type | String | Indicates how the user entered the card details. The value is one of the following: • Contact• Contactless• Manual• Swipe | |
| id | String | Unique identifier that our gateway generated for the sale. Note: This is the creditsale_id or debitsale_id that you can include in the endpoint URL for follow-on transactions. | |
| reference_id | String | Unique identifier for the sale that the merchant created. Note: This is the reference_id that you can include in the endpoint URL for follow-on transactions. | |
| status | String | Indicates the status of the sale. For a list of possible values, see the transaction status enumeration. | |
| status_code | String | Indicates the status of the original request. For a list of status codes, see Handling responses. | |
| transaction_datetime | String | Date and time of the transaction that the processor returns in YYYY-MM-DDThh:mm:ssZ format, for example, 2019-12-15T13:00:00Z. | |
| credit_attributes | Object | Object that contains details of credit card transactions. See the credit_attributes object. | |
| debit_attributes | Object | Object that contains details of debit card transactions. See the debit_attributes object. |
credit_attributes object
| Object | Field | Type | Description |
|---|---|---|---|
| N/A | approval_code | String | Approval code for the sale from the processor. |
| N/A | avs_response | String | Response code from an address verification service (AVS) lookup. For a list of possible values, see the AVS response enumeration. |
| N/A | avs_response_description | String | Text that describes the response code that the processor returned in the avs_response field. |
| N/A | cardsecurity_response | String | Indicates if the card security code (CSC) that the customer entered matches the CSC of the card. For a list of possible values, see the card security response enumeration. |
| payment | amount | String | Total dollar amount for the sale. |
| cashback_amount | String | Dollar amount of cashback for the sale. | |
| type | String | Type of payment for the sale. For a list of possible values, see the payment type enumeration. | |
| fees | Object | Object that contains details of the fees that the customer paid. For a list of parameters, see the fees object. | |
| card | masked_card_number | String | Masked card number of the card that the customer used for the sale. We mask all digits except the first six and the last four. |
| cardholder_name | String | Name that appears on the customer’s card. | |
| expiry_month | String | Month that the card expires in MM format. | |
| expiry_year | String | Year that the card expires in YY format. | |
| token | String | Unique reference for the customer's payment details that they stored on our vault. | |
| type | String | Name of the card brand that issued the card. For a list of possible values, see the card type enumeration. | |
| balance | String | Dollar amount that remains on the card. | |
| postal_code | String | Postal code that the card is registered to. | |
| rfmiq | String | Unique token that tracks the customer’s spending habits. | |
| card_on_file_attributes | Object | If our gateway was unable to create a token, this object contains error details. See the object. |
fees object
| Field | Type | Size | Description |
|---|---|---|---|
| surcharge_amount | Numeric | Variable | For US credit transactions, this is the surcharge amount applied to the amount submitted in the transaction request if surcharge fees have been configured for the merchant in the gateway. It is a dollar amount the merchant charged the cardholder as a surcharge for paying using a credit card. |
debit_attributes object
| Object | Field | Type | Description |
|---|---|---|---|
| N/A | approval_code | String | Approval code for the sale from the processor. |
| N/A | avs_response | String | Response code from an address verification service (AVS) lookup. For a list of possible values, see the AVS response enumeration. |
| N/A | avs_response_description | String | Text that describes the response code that the processor returned in the avs_response field. |
| N/A | cardsecurity_response | String | Indicates if the card security code (CSC) that the customer entered matches the CSC of the card. For a list of possible values, see the card security response enumeration. |
| payment | amount | String | Total dollar amount for the sale. |
| cashback_amount | String | Dollar amount of cashback for the sale. | |
| type | String | Type of payment for the sale. For a list of possible values, see the payment type enumeration. | |
| card | masked_card_number | String | Masked card number of the card that the customer used for the sale. We mask all digits except the first six and the last four. |
| cardholder_name | String | Name that appears on the customer’s card. | |
| expiry_month | String | Month that the card expires in MM format. | |
| expiry_year | String | Year that the card expires in YY format. | |
| token | String | Unique reference for the customer's payment details that they stored on our vault. | |
| type | String | Name of the card brand that issued the card. For a list of possible values, see the card type enumeration. | |
| balance | String | Dollar amount that remains on the card. | |
| postal_code | String | Postal code that the card is registered to. | |
| debit_trace_number | String | Unique number that banks can use to track transactions. We return this for debit transactions. | |
| rfmiq | String | Unique token that tracks the customer’s spending habits. | |
| card_on_file_attributes | String | If our gateway was unable to create a token, this object contains error details. See the object. |
card_on_file_attributes object
| Field | Type | Description |
|---|---|---|
| tokenization_error_code | String | Response code from our gateway. |
| tokenization_error_message | String | Text that describes why our gateway could not store the card details. |