Create a Payment Request

post

https://api.instamojo.com/v2/payment_requests/

This will create a payment request on Instamojo. You need to use a token that is obtained using the User Based Authentication.

Form Data

amount

double

required

The amount for the request. The minimum amount is 9. And the maximum is 200000.

purpose

string

required

Purpose of the payment request.

buyer_name

string

Name of payer

string

Email of payer

phone

string

Phone number of payer

redirect_url

string

URL where we redirect the user after a payment. If provided, we will redirect the user to redirect_url immediately after the payment has been processed. Three additional query arguments payment_request_id, payment_status and payment_id are also sent with the redirect URL.

webhook

string

URL where our server do POST request after a payment If provided, we will do a the POST request to the webhook (url) with full details of the payment

allow_repeated_payments

boolean

Defaults to false

If allow_repeated_payments is false, only one payment can be paid on a payment request link. allow_repeated_payments is true by default.

partner_fee_type

string

Allows you to receive a cut from from payments you facilitate. For fixed fee set this to fixed, or for percentage fee set it to percent.

partner_fee

double

This describes the fee that you would collect. It can be either a fixed amount, or a percentage of the original amount, depending on the value of partner_fee_type.

send_email

boolean

Defaults to false

Flag to send request link via email. If send_email is true, a request email will be sent to the email supplied. If send_email is true but no email is supplied, request creation will throw an error.

send_sms

boolean

Defaults to false

Flag to send request link via SMS. If send_sms is true, a request SMS will be sent to the phone number supplied. If send_sms is true but no phone number is supplied, request creation will throw an error.

mark_fulfilled

boolean

Defaults to false

Flag to determine if you want to put the payment on hold until you explicitly fulfil it. If mark_fulfilled is True the payment will be paid out to the merchant. If mark_fulfilled is False, then the payment will be put on hold until you explicitly fulfil the payment. See Fulfil a Payment below on how to fulfil a payment.

expires_at

date

Time after which the payment request will be expired in UTC timestamp. Max value is 600 seconds. Default is Null

Responses

200200

400400

401401