Sign in

v1

latestOpenAPI 3.0.02026-07-2411724301.7 KB
Payments

Process Refund

The Process Refund API allows you to initiate a refund for a successfully completed payment.

post/v2/{sid}/whatsapp/{phone_number}/payments_refund

Path parameters

sidstring required

Account SID (Security Identifier).

phone_numberstring required

The phone number (e.g., +918XXXXX5920) of the ed user.

Request body

reference_idstring required

Unique reference ID for the order sent in order_details message.

speedstring

Speed by which refund should be processed. Optional field. Can be one of instant or normal.

payment_config_idstring required

Payment configuration for the order sent in order_details message.

Example request

{
  "speed": "instant",
  "amount": {
    "currency": "INR"
  }
}

Response

Successful refund initiation

codestring required
messagestring required
errorobject