Credit

Refund API is designed to issue refunds on an existing transaction. This API can't be used to issue standalone refunds or credits. 
post
https://<PayEngine-host>
/api/payment/credit
Sample Request / Response
Request
Response
Example Request
{
    "id": "9a0df7ef-b77f-4525-97e1-f41a98ad7f75",
    "data": {
        "transactionAmount": "110.00",
        "cardToken": "card_sandbox_xxxx"
    }
}
Example Response
{
    "data": {
        "ID": "f34de6f6-233c-42e0-8c52-002ca76fa9ee",
        "MerchantID": "8357832f-79c9-48fd-9647-d1dae251e434",
        "TransactionID": "dcc9fc7b-9ab9-4e35-8f95-db61efcb3423",
        "ReturnResponse": {
            "status": "PASS",
            "responseCode": "1",
            "responseMessage": "SUCCESS",
            "authCode": "",
            "hostReferenceNumber": "7103469687",
            "hostResponseCode": "100",
            "taskID": "7103469687",
            "transactionID": "7103469687",
            "transactionTimestamp": "2022-03-30T15:04:29",
            "transactionAmount": "3.00",
            "processedAmount": "3.00",
            "totalAmount": "3.00",
            "addressVerificationCode": "",
            "cardHolderVerificationCode": "N",
            "cardType": "Visa",
            "maskedCardNumber": "4xxxxxxxxxxx1111",
            "customerReceipt": "",
            "merchantReceipt": ""
        }
    }
}
Webhook event: PAYMENT_REFUNDED
Webhook Payload Example
{
  event_uid: '3219ebc7e112790b88c3b619a4223967',
  event: 'PAYMENT_REFUNDED',
  data: {
    account_id: 'e90c1de6-4e87-4c9e-bcbc-c535d6e349ec',
    transaction_id: '415d9e62-1725-41e3-a6c0-1b7cc3153398',
    return_response: {
      status: 'PASS',
      taskID: '57362230',
      authCode: 'DSC633',
      orderNumber: '70150570',
      responseCode: 'A0000',
      transactionID: '67574212',
      returnedAmount: '10.00',
      customerReceipt: '<Printable Customer Receipt>',
      merchantReceipt: '<Printable Customer Receipt>',
      responseMessage: 'Success',
      hostResponseCode: '00',
      externalReferenceID: '70150570',
      hostReferenceNumber: '690753969761',
      transactionTimestamp: '2022-02-04T21:10:49'
    },
    original_transaction_id: '353d6f10-c493-4606-9b34-dc864a7cedc9'
  }
​

Transactions - Previous

Refund

Next - Transactions

Offline

Last modified 6mo ago

Copy link

On this page

post

Sample Request / Response