---
title: "Update Payment Request"
method: PUT
path: "/v1/payment-requests/{request_id}"
---

# Update Payment Request

`PUT /v1/payment-requests/{request_id}`

This endpoint is to update the payment request.

## Path parameters

- `request_id` string, required

## Headers

- `X-BUSINESS-API-KEY` string, required

## Request body

- object
  - `amount` number, double, required — It's required field. Amount related to the payment.
  - `currency` string, required — Currency related to the payment.
  - `payment_methods` string[] — Payment method type (paynow_online , card, wechat, alipay, grabpay_direct, grabpay_paylater, shopee_pay, zip, fpx). If we don't pass, use the available methods
  - `email` string, email — Buyer’s email
  - `name` string — Buyer’s name
  - `phone` string, phone — Buyer’s phone number
  - `wifi_terminal_id` string — It's terminal id and it's required if payment method is wifi_card_reader
  - `staff_id` string, uuid — It's active staff id from the dashboard
  - `purpose` string — Purpose of the Payment request.
  - `reference_number` string — Arbitrary reference number that you can map to your internal reference number. This value cannot be edited by the customer
  - `redirect_url` string, uri — URL where we redirect the user after a payment. Query arguments reference (payment request id) and status are sent along
  - `webhook` string, uri — URL where our server do POST request after a payment If done
  - `allow_repeated_payments` 'true' | 'false' — If set to true, multiple payments can be paid on a payment request link. Default value is false
  - `expiry_date` string — Time after which the payment link will be expired(time in SG with YYYY-MM-DD HH:mm:ss format). Applicable for repeated payments. Default is Null
  - `expires_after` string — E.g "30 mins" Other supported keys are "mins", "hours", "days"
  - `add_admin_fee` 'true' | 'false' — If set to true, the admin fee will be included in total.
  - `send_email` 'true' | 'false' — It's "true" or "false". If set to true, an email receipt will be sent to the customer after the payment is completed. Default is false
  - `send_sms` 'true' | 'false' — It's "true" or "false". If set to "true", SMS will be sent to the customer after the payment is completed. Default is false
  - `address` object
    - `line1` string, required
    - `line2` string
    - `city` string, required
    - `country` string, required
    - `state` string, required
    - `postal_code` string, required
  - `generate_qr` boolean — Only valid for payment methods: paynow_online, qrph_netbank, doku_qris and shopee_pay if generate_qr was true

## Response `200`

200

---

[API](https://skmtc.net/hitpayapp/apis/hitpay-api.md) · [All operations](https://skmtc.net/hitpayapp/apis/hitpay-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/hitpayapp/hitpay-api/versions/6aae1a736990/schema)