---
title: "Partial update payment request"
method: PATCH
path: "/payment_requests/{id}/"
tags: ["Payment Requests"]
---

# Partial update payment request

`PATCH /payment_requests/{id}/`

Endpoint for partially updating an existing payment request.

## Path parameters

- `id` string, required

## Headers

- `X-Wafeq-Idempotency-Key` string

## Request body

- PatchedPaymentRequest — An entity that can have attachments.
  - `amount` number, double, nullable — The amount to transfer to the beneficiary. Must be a non-negative value.
  - `attachments` string[] — The attachments linked to this payment request.
  - `bank_account` string — The bank account associated with this payment request.
  - `beneficiary` string — The beneficiary associated with this payment request.
  - `beneficiary_address` string — The full address of the beneficiary.
  - `beneficiary_name` string — The full name of the beneficiary.
  - `bills` string[] — The bills associated with this payment request. Only one bill can be assigned.
  - `charge_type` 'OUR' | 'BEN' | 'SHA' — * `OUR` - Ours * `BEN` - Beneficiary * `SHA` - Shared Full information for [ChargeTypeEnum](chargetypeenum)
  - `contact` string — The contact associated with this payment request.
  - `cost_center` string, nullable — The cost center associated with this payment request.
  - `created_ts` string, date-time — The timestamp in UTC when the payment request was created
  - `currency` 'AED' | 'SAR' | 'USD' | 'EUR' | 'CAD' | 'AFN' | 'ALL' | 'AMD' | 'ARS' | 'AUD' | 'AZN' | 'BAM' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BND' | 'BOB' | 'BRL' | 'BWP' | 'BYN' | 'BZD' | 'CDF' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'GBP' | 'GEL' | 'GHS' | 'GNF' | 'GTQ' | 'HKD' | 'HNL' | 'HRK' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KHR' | 'KMF' | 'KRW' | 'KWD' | 'KZT' | 'LBP' | 'LKR' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MOP' | 'MUR' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SDG' | 'SEK' | 'SGD' | 'SOS' | 'SYP' | 'THB' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'UYU' | 'UZS' | 'VES' | 'VND' | 'XAF' | 'XOF' | 'YER' | 'ZAR' | 'ZMW' — * `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](currencyenum)
  - `date` string, date — The date when the Payment Request was created. Automatically set and read-only.
  - `details_of_payment` string — The details of the payment to be displayed. Provide a clear description of the payment purpose.
  - `iban` string — The International Bank Account Number (IBAN) for the transfer.
  - `id` string — The unique identifier of the payment request.
  - `legacy_id` string — [Deprecated] The legacy identifier of the payment request.
  - `modified_ts` string, date-time — The timestamp in UTC when the payment request was last modified
  - `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.
  - `status` 'DELETED' | 'DRAFT' | 'ERROR' | 'FETCHING_STATUS' | 'NOT_FOUND' | 'PENDING_APPROVAL' | 'PENDING_RELEASE' | 'PROCESSED' | 'PROCESSING' | 'QUEUED' | 'REJECTED' | 'RELEASED' | 'VALIDATED' — * `DELETED` - Deleted * `DRAFT` - Draft * `ERROR` - Error * `FETCHING_STATUS` - Fetching status * `NOT_FOUND` - Not found * `PENDING_APPROVAL` - Pending approval * `PENDING_RELEASE` - Pending release * `PROCESSED` - Processed * `PROCESSING` - Processing * `QUEUED` - Queued * `...` Full information for [PaymentRequestStatusEnum](paymentrequeststatusenum)
  - `swift` string — SWIFT/BIC code of the destination bank account for international transfers.

## Response `200`

- PaymentRequest — An entity that can have attachments.
  - `amount` number, double, nullable, required — The amount to transfer to the beneficiary. Must be a non-negative value.
  - `attachments` string[] — The attachments linked to this payment request.
  - `bank_account` string, required — The bank account associated with this payment request.
  - `beneficiary` string, required — The beneficiary associated with this payment request.
  - `beneficiary_address` string, required — The full address of the beneficiary.
  - `beneficiary_name` string, required — The full name of the beneficiary.
  - `bills` string[] — The bills associated with this payment request. Only one bill can be assigned.
  - `charge_type` 'OUR' | 'BEN' | 'SHA', required — * `OUR` - Ours * `BEN` - Beneficiary * `SHA` - Shared Full information for [ChargeTypeEnum](chargetypeenum)
  - `contact` string, required — The contact associated with this payment request.
  - `cost_center` string, nullable — The cost center associated with this payment request.
  - `created_ts` string, date-time, required — The timestamp in UTC when the payment request was created
  - `currency` 'AED' | 'SAR' | 'USD' | 'EUR' | 'CAD' | 'AFN' | 'ALL' | 'AMD' | 'ARS' | 'AUD' | 'AZN' | 'BAM' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BND' | 'BOB' | 'BRL' | 'BWP' | 'BYN' | 'BZD' | 'CDF' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'GBP' | 'GEL' | 'GHS' | 'GNF' | 'GTQ' | 'HKD' | 'HNL' | 'HRK' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KHR' | 'KMF' | 'KRW' | 'KWD' | 'KZT' | 'LBP' | 'LKR' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MOP' | 'MUR' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SDG' | 'SEK' | 'SGD' | 'SOS' | 'SYP' | 'THB' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'UYU' | 'UZS' | 'VES' | 'VND' | 'XAF' | 'XOF' | 'YER' | 'ZAR' | 'ZMW', required — * `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](currencyenum)
  - `date` string, date, required — The date when the Payment Request was created. Automatically set and read-only.
  - `details_of_payment` string, required — The details of the payment to be displayed. Provide a clear description of the payment purpose.
  - `iban` string, required — The International Bank Account Number (IBAN) for the transfer.
  - `id` string, required — The unique identifier of the payment request.
  - `legacy_id` string, required — [Deprecated] The legacy identifier of the payment request.
  - `modified_ts` string, date-time, required — The timestamp in UTC when the payment request was last modified
  - `reference` string, required — The unique reference of the payment request. Used for tracking and identification.
  - `send_payment_advice` boolean, required — Boolean indicating whether to send a payment advice by email or not.
  - `status` 'DELETED' | 'DRAFT' | 'ERROR' | 'FETCHING_STATUS' | 'NOT_FOUND' | 'PENDING_APPROVAL' | 'PENDING_RELEASE' | 'PROCESSED' | 'PROCESSING' | 'QUEUED' | 'REJECTED' | 'RELEASED' | 'VALIDATED', required — * `DELETED` - Deleted * `DRAFT` - Draft * `ERROR` - Error * `FETCHING_STATUS` - Fetching status * `NOT_FOUND` - Not found * `PENDING_APPROVAL` - Pending approval * `PENDING_RELEASE` - Pending release * `PROCESSED` - Processed * `PROCESSING` - Processing * `QUEUED` - Queued * `...` Full information for [PaymentRequestStatusEnum](paymentrequeststatusenum)
  - `swift` string, required — SWIFT/BIC code of the destination bank account for international transfers.

---

[API](https://skmtc.net/wafeq/apis/wafeq-public-api.md) · [All operations](https://skmtc.net/wafeq/apis/wafeq-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/wafeq/wafeq-public-api/revisions/36816b4fce7f/schema)