Create Charge

Log in to see full request history

📘

Introduction

The UddoktaPay 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 redirect_url. To obtain payment data, you'll need to call the Verify Payment API.

Request URL

To create a payment request, use the following API endpoint:

{base_URL}/api/checkout-v2

Replace {base_URL} with the location of your UddoktaPay installation, such as https://pay.your-domain.com.

Request Headers

Include the following request header:

RT-UDDOKTAPAY-API-KEY (required): Your API key. For the sandbox environment, use the provided key:

982d381360a69d419689740d9f2e26ce36fb7a50
Body Params
string
required

User's full name.

string
required

User's email address.

string
required

The payment amount.

json
required

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

string
required

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

string
required

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

string
required

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

string

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

Headers
string
required
Defaults to 982d381360a69d419689740d9f2e26ce36fb7a50

API KEY

Responses

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