Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

User can refund any existing transaction after being settled. It can only be performed on transactions, which have been authorised and settled. Authenticate this request using HTTP Basic Auth by adding a bearer token to the header, e.g. Authentication: Bearer {{access_token}}. You can get the {{access_token}} from the create token request.


Anchor
refund-transactions
refund-transactions

Refund Transactions

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.

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

Code Block
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,
    "amount": 1.01,
    "reference": "refund note"
}

Response

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

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