POST
/
v1
/
payment-requests

Headers

X-BUSINESS-API-KEY
string
required

Body

application/json
amount
number
required

It's required field. Amount related to the payment. Example: 2500

Required range: 0.3 < x < 999999999.99
currency
string
required

It's required field. Currency related to the payment. Example:

Maximum length: 3
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

Buyer’s email

name
string

Buyer’s name

phone
string

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

It's active staff id from the dashboard

purpose
string

Purpose of the Payment request.

Maximum length: 255
reference_number
string

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

Maximum length: 255
redirect_url
string

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

Maximum length: 1028
webhook
string

URL where our server do POST request after a payment If done

allow_repeated_payments
enum<string>
default: false

If set to true, multiple payments can be paid on a payment request link. Default value is false

Available options:
true,
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
enum<string>
default: false

If set to true, the admin fee will be included in total.

Available options:
true,
false
send_email
enum<string>
default: 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

Available options:
true,
false
send_sms
enum<string>
default: true

It's "true" or "false". If set to "true", SMS will be sent to the customer after the payment is completed. Default is false

Available options:
true,
false
address
object
generate_qr
boolean
default: false

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

Response

200 - application/json
id
string
name
string
email
string
phone
string
amount
string
currency
string
status
string
purpose
string
reference_number
string
payment_methods
string[]
url
string
redirect_url
string
webhook
string
send_sms
boolean
default: true
send_email
boolean
default: true
sms_status
string
email_status
string
allow_repeated_payments
boolean
default: true
expiry_date
string
created_at
string
updated_at
string

Was this page helpful?

Payout NetworkGet Payment Request Status