Create a Request

post

https://www.instamojo.com/api/1.1/payment-requests/

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Required Headers:

X-Api-Key
X-Auth-Token

Highly Recommended fields:

The following 3 fields are details of the person making the payment. If not sent when creating a payment request, the payer will have to fill it in while paying. Supplying these fields will speed up the payment process for your customers


buyer_name	Name of payer
email	Email of the payer
phone	Phone number of payer

Note that the shorturl is not available right away, hence to get its value you can query our Get Request Info endpoint.

Few other fields that can change with this request are:

status
sms_status
email_status

status field can have one of these values:

Pending: Both email and SMS(whichever applicable) are not yet sent.
Sent: Either email or SMS(whichever applicable) is sent to the payer.
Failed: Both email and SMS(whichever applicable) failed to deliver to the user.
Completed: Payment was made by a payer.

sms_status and email_status fields can have one of these values:

Pending: Request not yet sent from our end.
Failed: Request failed.
Sent: Request sent to the payer.
Null: Field not applicable, i.e when send_email and/or send_sms is set to false

Form Data

amount

string

required

Amount to be paid in XX.YY format

purpose

string

required

Purpose of payment

buyer_name

string

Name of payer

string

Email of payer

phone

string

Phone number of person paying

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 true

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

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.

expires_at

date

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

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

201201

400400

401401