API Reference
Log In

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_nameName of payer
emailEmail of the payer
phonePhone 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
Language
Click Try It! to start a request and see the response here!