Page Comparison

POST /pay/v1/transactions/{transaction_id}/refunds

Headers

Content-Typestring
Content type.

Authorizationstring
Access token generated from create token request.

Attributes

partial_refundboolean

If the transaction is a partial refund, then it set to be true. Default value is false.

refund_amountfloat (optional)

Refund amount Amount is required if it’s a partial refund. The amount must not be greater than the original received amount minus any already refunded amount.

referencestring (optional)
Refund note (if any).

Request

POST https://secure.blinkpayment.co.uk/api/pay/v1/transactions/BL-2349AGB/refunds HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbG...

{
    "partial_refund": true,
    "refund_amount": 1.01,
    "reference": "refund note"
}

Response

HTTP/1.1 200 OK
Content-Type: application/json

{
    "success": true,
    "message": "Refunded successfully",
    "amount" : "1.01",
    "reference": "refund note",
    "transaction_id": "BL-2349AGB"
}