Developer Documentations

Refunds

You can request a refund for a successful transaction. You have the option to request a partial or full refund. After initiating a refund, your request will be reviewed by our accounts department and will be processed manually within three working days.

Request Refund

API Request

transactionIdThe transactionId of the transaction you want to get refund.
isPartial (optional)You can refund a transaction, either partial or complete. Send "1" for Partial and "0" or null for Complete refund.
amountIf you choose "isPartial" refund then you need to specify the amount here. The amount must be less than the transaction full amount.
callbackHookUrl (Optional)VaultsPay will hit this POST callback hook URL at your application server whenever the VaultsPay finance team process this refund request.
  • SUCCESS – The refund was successful.
  • REJECTED – The refund was not approved.
POST: https://testapi.vaultspay.com/public/external/v1/create-refund-request
{
    "transactionId": "PL_xyz",
    "isPartial": "1",
    "amount": "50.50",
    "callbackHookUrl": "https://mywebsite.com/refund-request-hook"
}

API Response

uuidUnique ID of the refund request.
transaction_idThe transaction ID of the transaction we requested the refund for.
is_partialResponse for partial will be "1" and for full "0"
amountThis amount will be refunded to the cusotmer.
{
    "message": "Successful.",
    "code": "200",
    "data": {
        "id": "1122",
        "uuid": "RFRQ_xyz",
        "transaction_id": "PL_xyz",
        "is_partial": "1",
        "amount": "50.50",
        "description": "null",
        "created_at": "2021-10-05T10:42:48.000000Z"
    }
}

Callback Hook Body:

{
    "vpTransactionId": "RF_C1KXG2T9H0RMK.",
    "clientReference": "Refund request Id",
    "amount": "10",
    "fee": "0.5",
    "vat": "0",
    "status": "SUCCESS",
    "referenceId": "RFRQ_...."
}

Check Refund Request Status

You can check the status of a refund request or trace your refund process.

API Request

uuidThe uuid of the refund request.
POST: https://testapi.vaultspay.com/public/external/v1/get-refund-request
{
    "uuid": "RFRQ_57A4FCBC-60B7-4C32-AD90-9FD3C06F3B59"
}

API Response

uuidUnique ID of the refund request.
transaction_idThe transaction ID of the transaction we requested the refund for.
status0 for pending, 1 for initiated, 2 for processed, 3 for cancelled, 4 for rejected
{
    "message": "Successful.",
    "code": "200",
    "data": {
        "uuid": "RFRQ_xyz",
        "transaction_id": "PL_xyz",
        "amount": "50.50",
        "status": 2,
        "description": "null",
        "status_str": "Processed",
        "created_at": "2021-10-05T10:42:48.000000Z"
    }
}