Partial update payment request

patch

https://api.wafeq.com/v1/payment_requests/{id}/

Endpoint for partially updating an existing payment request.

Path Params

string

required

Body Params

amount

double | null

≥ 0

The amount to transfer to the beneficiary. Must be a non-negative value.

attachments

array of strings

The attachments linked to this payment request.

attachments

bank_account

string

The bank account associated with this payment request.

beneficiary

string

The beneficiary associated with this payment request.

bills

array of strings

The bills associated with this payment request. Only one bill can be assigned.

bills

charge_type

string

enum

OUR - Ours
BEN - Beneficiary
SHA - Shared

Full information for ChargeTypeEnum

Allowed:

contact

string

The contact associated with this payment request.

cost_center

string | null

The cost center associated with this payment request.

currency

string

enum

AED - AED ⃱
SAR - SAR ⃁
USD - USD $
EUR - EUR €
CAD - CAD $
AFN - AFN ؋
ALL - ALL Lek
AMD - AMD դր.
ARS - ARS $
AUD - AUD $
...

Full information for CurrencyEnum

details_of_payment

string

length ≤ 200

The details of the payment to be displayed. Provide a clear description of the payment purpose.

reference

string

The unique reference of the payment request. Used for tracking and identification.

send_payment_advice

boolean

Boolean indicating whether to send a payment advice by email or not.

Headers

X-Wafeq-Idempotency-Key

string

Client-provided UUID to uniquely identify a request

Response

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json