Refund or Return
Please note that merchants cannot send full card numbers via API unless they have obtained an exception.
This API call lets you process a refund. The response is an XML of the processed refund.
Request Fields
| Field Name | Type | Required | Description |
|---|---|---|---|
| transactionType | String | Yes | refund |
| accountId | Integer | Yes | The Helcim Commerce account ID. |
| apiToken | String | Yes | API token used for authentication and access control. |
| amount | Decimal | Yes | The amount of the transaction. |
| cardHolderName | String | No | The cardholder names. |
| cardNumber | Integer | Yes | The credit card number. |
| cardExpiry | Integer | Yes | The credit card expiration date. |
| cardCVV | Integer | No | The credit card CVV (digits on back of credit card). |
Response Fields (XML)
| Field Name | Type | Description |
|---|---|---|
| message | - | XML structure |
| response | Integer | 1 or 0. Whether the transaction was approved or declined. |
| responseMessage | String | Result of transaction (Approved/Denied). |
| notice | String | Error/warning message from Helcim. |
| transaction | - | XML structure. |
| transactionId | Integer | The transaction ID. |
| type | String | The transaction type (purchase, refund, pre-auth, capture). |
| date | String | The date of the transactions |
| time | String | The time of the transaction. |
| cardHolderName | String | The card holder's name. |
| amount | Decimal | The amount of the transactions. |
| currency | String | The currency of the transaction. |
| cardnumber | String | The credit card number (first 4 and last 4 digits only). |
| cardToken | String | The credit card token. |
| expiryDate | Integer | The credit card expiry date. |
| cardType | String | The credit card type (Visa, Mastercard, Amex, Discovery). |
| avsResponse | String | The address verification response. |
| cvvResponse | String | The CVV verification response. |
| approvalCode | String | The approval code. |
| orderNumber | String | The order number. |
| customerCode | String | The customer code. |
Errors
For all API requests, there are also generic API authentication and user access restriction errors.
| Response Code | Error Code | Message | Description |
|---|---|---|---|
| 0 | - | Invalid Amount | The transaction amount was not entered. |
| 0 | - | Declined - Invalid Card Number Invalid Expiry Date | The credit card number and/or expiry date was not entered or is invalid. |