v2

latestOpenAPI 3.1.12026-08-06856719.6 KB

Update Payment Request

This endpoint is to update the payment request.

put/v1/payment-requests/{request_id}

Path parameters

request_idstring required

It's payment request id

Headers

X-BUSINESS-API-KEYstring required

Example:b286daabf9921b5a01a4621f026c111e046f8911feba212996c92159b98427d

Request body

amountnumber double required

It's required field. Amount related to the payment.

currencystring required

Currency related to the payment.

payment_methodsstring[]

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

emailstring email

Buyer’s email

namestring

Buyer’s name

phonestring phone

Buyer’s phone number

wifi_terminal_idstring

It's terminal id and it's required if payment method is wifi_card_reader

staff_idstring uuid

It's active staff id from the dashboard

purposestring

Purpose of the Payment request.

reference_numberstring

Arbitrary reference number that you can map to your internal reference number. This value cannot be edited by the customer

redirect_urlstring uri

URL where we redirect the user after a payment. Query arguments reference (payment request id) and status are sent along

webhookstring 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_datestring

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_afterstring

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

generate_qrboolean

Only valid for payment methods: paynow_online, qrph_netbank, doku_qris and shopee_pay if generate_qr was true

Example request

{
  "amount": 100,
  "currency": "SGD",
  "staff_id": "98888a24-d6b2-430d-9063-d2be76d443cd",
  "redirect_url": "https://www.google.com",
  "webhook": "https://www.google.com",
  "expires_after": "5 minutes"
}

Response

200