Create Charge

post

https://sandbox.piprapay.com/api/create-charge

This is your first endpoint! Edit this page to start documenting your API.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

📘
Introduction
The PipraPay Create Charge API allows you to initiate a payment. After a successful payment, an invoice_id will be sent via GET or POST request to your specified pp_url. To obtain payment data, you'll need to call the Verify Payment API.

Body Params

full_name

string

required

Defaults to Demo

User's full name.

email_mobile

string

required

Defaults to [email protected]

User's email address or mobile number.

amount

string

required

Defaults to 10

The payment amount.

metadata

object

required

Additional project-specific data in JSON format. For example: { "product_id": "5"}

redirect_url

string

required

Defaults to https://piprapay.com

The URL where the user will be redirected after a successful payment. Additionally, an pp_id will be sent via POST data, which you must validate using the Verify Payment API.

return_type

string

required

Defaults to GET

Specifies how the invoice_id is returned to the success page. It can be either "GET" or "POST."

cancel_url

string

required

Defaults to https://piprapay.com

The URL where the user will be redirected when they click the cancel button during the payment process.

webhook_url

string

required

Defaults to https://piprapay.com

A backend response URL where payment information is sent when an admin initiates a "SEND WEBHOOK REQUEST" from the admin panel.

currency

string

required

Defaults to BDT

The currency selected for payment processing

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Introduction

200Successful response

400Bad Request