OPopen-finance

Refund a payment

post/payments/{paymentId}/refund

Request

  • Base URL
    https://api.open-finance.ai/v2
  • URL
    https://api.open-finance.ai/v2/payments/{paymentId}/refund
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://api.open-finance.ai/oauth/token scopes: create:payments

Path parameters

paymentIdstring required

A unique identifier for the payment

Request body

descriptionstring required

The description of the refund payment

psuIdstring

The national id of the merchant making the refund

psuCorporateIdstring

The business id of the merchant making the refund

phoneNumberstring

The phone number of the merchant making the refund

sendSMSboolean

Send an SMS to the merchant with the refund journey

amountnumber required

The refund amount

Example request

{
  "description": "Refund for TV purchase",
  "psuId": "321654544",
  "psuCorporateId": "321654544",
  "phoneNumber": "0545483765"
}

Response

Response

idstring

The payment id of the refund payment

payUrlstring

The journey url for the refund

sentMerchantSMSboolean

Was sn SMS sent to the merchant

Changes

No recorded changes to this operation across all 1 revision of this API.