Create a payment request

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Create a payment request

customer
object
required

Information about the customer associated to the entity for whom this schedule setting was created.

string
required
length between 0 and 200

A short description or summary of the payment request.

number
required
≥ 0.01

The payment request amount.

string
required

The default currency of the biller..
Possible values (non-exclusive): AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTN, BWP, BYR, BZD, CAD, CDF, CHF, CLP, CNY, COP, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GGP, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, IMP, INR, IQD, IRR, ISK, JEP, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SPL, SRD, STD, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TVD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VEF, VND, VUV, WST, XAF, XCD, XDR, XOF, XPF, YER, ZAR, ZMW, ZWD

number
0 to 100

Optional tax rate percentage applied on the payment request amount.

string
length between 0 and 18
^[a-zA-Z0-9 .]*$

Optional reference for the payment request.

date-time

The date by which the payment request should be paid

distribution
object

Information about how a payment request is distributed and collected.

string

The (optional) redirect URL to redirect the user after they complete the payment

Responses

400

A problem reading or understanding the request. Ensure that the request complies with the required format and includes all necessary parameters.

401

Authentication required.

404

Customer does not exist.

422

A request validation error.

500

The server could not process the request.

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json