Skip to main content
POST
Create a payment setup

Authorizations

Authorization
string
header
required

Your API key, e.g. sk_live_... or sk_test_....

Headers

Idempotency-Key
string

Optional. Makes this write safe to retry: the same key replays the first response instead of acting twice.

Maximum string length: 255

Body

application/json
configuration_name
string
required
Maximum string length: 60
Pattern: ^[A-Za-z0-9_\-]+$
provider_name
enum<string>
required
Available options:
razorpay,
payu,
zaakpay,
billdesk,
upi_vpa
phone_number_id
string
merchant_vpa
string

Required for upi_vpa.

merchant_category_code
string
Pattern: ^\d{4}$
purpose_code
string
Maximum string length: 4
redirect_url
string<uri>

Response

The payment setup.

id
string<uuid>
configuration_name
string
provider
enum<string>
Available options:
razorpay,
payu,
zaakpay,
billdesk,
upi_vpa
provider_label
string
status
enum<string>
Available options:
active,
needs_connecting,
needs_testing
status_label
string
provider_mid
string | null
merchant_vpa
string | null
merchant_category_code
string | null
purpose_code
string | null
data_endpoint_url
string | null

Open it to link the gateway, while it is valid.

phone_number_id
string | null
waba_id
string
synced_at
string<date-time> | null