Refund Status API

Refund Status API

Purpose

To confirm whether a refund to the customer was successfully processed, Nuclei uses the partner's refund status API. This API checks the status of the refund that was initiated through the refund API.

API Contract

Environment	Endpoint
UAT	https://bank.uat.com/payment-service/partner/refund/status
Production (CUG)	https://bank.prod.com/payment-service/partner/refund/status

Headers

• X-Body-Signature: Checksum (HMAC-SHA256), generated using the partner-secret-key.
• partner-key: <NUCLEI-SDK-KEY>

Request Body (Parameters)

• Request Structure:

  {
    "payload": "<encrypted message body AES>"
  }

• Message body example (Decoded payload):

  {
    "refundTransactionId": "N-HBA14RA-FUI9QWO-CAIVDEK",
    "orderId": "N-FFKKKRA-FUI9QWO-CAIVDEE",
    "requestDate": "20170911115412"
  }

Response Body (from Partner)

• Response Structure:

  {
    "payload": "<encrypted message body AES>"
  }

• Message body example (Decoded payload):

  {
    "status": "SUCCESS" <string>,
    "amount": “5” <string>,
    "refundTransactionId": "N-HBA14RA-FUI9QWO-CAIVDEK" <string>,
    “partnerTransactionId": "ZREF0123456ABC" <string>,
    "createdAt": “1504010130” <milliseconds value in string>,
    "errorMessage": "NA" <string>,
    "statusCode": “00”,
  }

Status Codes and Descriptions

• statusCode:

  • "00": Success
  • "01": Error

• refundStatus:

  • SUCCESS: Refund successful
  • FAILURE: Refund failed
  • IN-PROGRESS: Refund in progress
  • NOT FOUND: Transaction not found