Skip to main content

Payout Callback Query

Note

Notify URL or Withdraw Callback URL to inform server on transaction status after payout is made

Danger

Please ensure you have filled up the Withdraw Callback URL in Merchant Portal

Response Parameters

Parameter Type Required Example
encryptedData String Encrypted Data that is required to be decrypted with CLIENT_SYMMETRIC_KEY. a83cf72884cbbb....3ddf0744646e0cf0b482

Example Response

{
  "encryptedData": "e4e9ac1120ed867a7af108af8b1ab918cbec6db7b4d7c29908085a73e2b29e97547da6eae91928b3330241f1fb898eebd8c3355105fdd5c68b6ceea761f41dc3085ed888d3c0473beef128ebd208c4f60299df64a622d04d21d81513c02e2d47bfcce2a6c246eabcc1c823aaf3d9133004cf7c4c08236395a05dc19a98c33a301c8b73d4e7fd33cd911619de86dfdb45",
}

Decrypt the encryptedData with CLIENT_SYMMETRIC_KEY

Symmetric decrypt the encryptedData , e4e9ac1120ed867a7af108af8b1ab918cbec6db7b4d7c29908085a73e2b29e97547da6eae91928b3330241f1fb898eebd8c3355105fdd5c68b6ceea761f41dc3085ed888d3c0473beef128ebd208c4f60299df64a622d04d21d81513c02e2d47bfcce2a6c246eabcc1c823aaf3d9133004cf7c4c08236395a05dc19a98c33a301c8b73d4e7fd33cd911619de86dfdb45
with CLIENT_SYMMETRIC_KEY, PCd1dlEmFnBXaVce06Pzp7Vike0oHnVJ

The result in plaintext is:

{
  "message": "Success",
  "data": {
    "status": "PENDING",
    "transaction": {
        "id": 10025,
        "amountWithdraw": 0,
        "confirmedAt": 0,
        "commissionFee": 0
    },
    "order": {
      "id": "10006",
      "amount": "1",
      "currencyType": "MYR"
    },
    "recipient": {
        "name": "Long Wan",
        "phone": "0123456789",
        "email": "longwan@gmail.com",
        "methodType": "CIBBMYKL",
        "methodValue": "8044591766",
        "methodRef": ""      
    }
  }
}

Decrypted Payload Parameters

Parameter Type Required Description Example
data Object Yes Top-level object returned after decrypting the payout callback payload. {...}
data.status String Yes Current transaction status. Possible values include <code>PAYING</code>, <code>PENDING</code>, <code>SUCCESS</code>, and <code>FAILED</code>. PENDING
data.transaction Object Yes Payout transaction details returned in the callback payload. {...}
data.transaction.id Number Yes SuperPay transaction ID for this callback event. 10025
data.transaction.amountWithdraw Number Yes Actual amount disbursed for the payout transaction. 0
data.transaction.confirmedAt String / Number Yes Timestamp when the payout was confirmed. This may be <code>0</code> before the transaction succeeds. 0
data.transaction.commissionFee Number Yes Transaction fee charged by SuperPay. 0
data.order Object Yes Original merchant order details linked to the transaction. {...}
data.order.id String Yes Merchant order ID submitted when the order was created. 10006
data.order.amount Number / String Yes Original order amount requested by the merchant. 1
data.order.currencyType String Yes Currency code for the order amount. MYR
data.recipient Object Yes Recipient details associated with the payout transaction. {...}
data.recipient.name String / Null Yes Recipient account holder name. Long Wan
data.recipient.phone String / Null Yes Recipient phone number. 0123456789
data.recipient.email String / Null Yes Recipient email address. longwan@gmail.com
data.recipient.methodType String / Null Yes Recipient payout method code, such as bank or channel type. CIBBMYKL
data.recipient.methodValue String / Null Yes Recipient account or destination value used for the payout. 8044591766
data.recipient.methodRef String / Null Yes Provider reference or recipient method reference value for the payout.