Loading...
To view the details of a refund, send a GET request to the relevant endpoint.
| Scenario | Merchant uses the POS to: |
|---|---|
| Merchant wants to view the details of a previous refund. | Search for the previous refund 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 transaction. |
| N/A | amount | String | Total dollar amount of the transaction. 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 transaction. 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 transaction. Note: This is the creditreturn_id or debitreturn_id that you can include in the endpoint URL for follow-on transactions. | |
| reference_id | String | Unique identifier for the transaction 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 transaction. For a list of possible values, see the transaction status enumeration. | |
| status_code | String | Indicates the status of the 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 transaction 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 transaction . |
| type | String | Type of payment for the transaction. 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 transaction. 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. | |
| 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. |
debit_attributes object
| Object | Field | Type | Description |
|---|---|---|---|
| N/A | approval_code | String | Approval code for the transaction 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 transaction. |
| type | String | Type of payment for the transaction. 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 transaction. 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. | |
| 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. |