You may refund all or a part of the value of a captured payment, which will return the funds previously settled to you from your customer, by identifying the appropriate capture you wish to refund, and executing the following operation against its /[capture-reference]/refund endpoint.
HTTP Request Method: POST
Resource (URI): https://api-gateway.sandbox.ngenius-payments.com/transactions/outlets/[outlet-reference]/orders/[order-reference]/payments/[payment-reference]/captures/[capture-reference]/refund
Dynamic resource from order object:
response._embedded.payment[index]._embedded.[“cnp:capture”][index]._links.[“cnp:refund”].href
Headers:
Header | Key |
---|---|
Authorization | Bearer [access_token] |
Content-Type | application/vnd.ni-payment.v2+json |
Accept | application/vnd.ni-payment.v2+json |
Body / Form Data:
Key | Value |
---|---|
amount { } | N/A |
amount.currencyCode | AED, GBP, USD, ZAR |
amount.value | Minor units (i.e. 100 = 1.00 AED) |
Example request (body):
{
"amount": {
"currencyCode": "AED",
"value": 100
}
}