API Reference
Log In
API Reference

Initiate a payment request

post
https://api.chimoney.io/v0.2.4/payment/initiate

Initiates a payment request which is sent to the payer's email address specified.

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

Amount in USD to collect.

string
required

Email of the one making the payment.

string
enum

ISO Currency String like CAD, USD, NGN etc.

Allowed:
string

Amount in specified "currency" to collect. Required if currency is set.

string

URL to redirect to after payment is confirmed.

string

ID of the wallet to settle the payment to (optional)

string

Narration for the payment (optional)

string

Subaccount if any.

meta
object

Object containing metadata you want to pass to the request to use later.

boolean

Disables email and other notifications from Chimoney.

redeemData
object

Object containing redeem data.

paymentMethod

Payment method configuration to direct users to specific payment options

Responses

Updated about 1 year ago

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

Updated about 1 year ago