To initiate a recall payment, you should call Recall Payment API.
Tip! Make sure your Access token as a BaaS Partner has ob-baas-ps and ob-baas-ps:authz-nosca scopes in it.
Parameters and their descriptions are mentioned below.
Parameter | Description |
---|---|
paymentOrderNo | payment order number which should be recalled (refunded) |
Response body of Recall Payment API will return “paymentOrderNo”, “paymentRail”, “transactionStatus”, and “transactionFees”
{
"paymentOrderNo": "s-70752374481170997670",
"paymentRail": "INTERNAL",
"transactionStatus": "RCVD",
"transactionFeeIndicator": true,
"transactionFees": {
"amount": "0.00",
"currency": "EUR"
}
}
Tip! "paymentOrderNo"
received in the response body of Recall payment API is a new paymentOrderNo of a payment, which is a recall payment!
Please note that it’s not the original paymentOrderNo (sent in the Recall payment API request body).