Skip to main content
Custom ProviderVersion: v3

Create new integration

POST/payments/custom-provider/provider

API to create a new association for an app and location

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your access token.

Scope:payments/custom-provider.write
Auth methods:OAuthPrivate Integration
Token type:Sub-Account Token

Request​

Headers

Versionstringrequired

API Version

Available optionsv3

Query Parameters

locationIdstringrequired

Location id

Example:Lk3nlfk4lxlelVEwcW

Body

namestringrequired

The name of the custom provider

Example:Company Paypal Integration
descriptionstringrequired

Description of payment gateway. Shown on the payments integrations page as subtext

Example:This payment gateway supports payments in India via UPI, Net banking, cards and wallets.
paymentsUrlstringrequired

This url will be loaded in iFrame to start a payment session.

Example:https://testpayment.paypal.com
queryUrlstringrequired

The url used for querying payments related events. Ex. verify, refund, subscription etc.

Example:https://testsubscription.paypal.com
imageUrlstringrequired

Public image url for logo of the payment gateway displayed on the payments integrations page.

Example:https://testsubscription.paypal.com
supportsSubscriptionSchedulebooleanrequired

Whether the config supports subscription schedule or not. true represents config supports subscription schedule

Example:true

Response

Successful response

namestringrequired

The name of the custom provider

Example:Company Paypal Integration
descriptionstringrequired

Description of payment gateway. Shown on the payments integrations page as subtext

Example:This payment gateway supports payments in India via UPI, Net banking, cards and wallets.
paymentsUrlstringrequired

This url will be loaded in iFrame to start a payment session.

Example:https://testpayment.paypal.com
queryUrlstringrequired

The url used for querying payments related events. Ex. verify, refund, subscription etc.

Example:https://testsubscription.paypal.com
imageUrlstringrequired

Public image url for logo of the payment gateway displayed on the payments integrations page.

Example:https://testsubscription.paypal.com
_idstringrequired

The unique identifier for the custom provider.

Example:662a44ad19a2a44d3cd9d749
locationIdstringrequired

Location id

Example:Lk3nlfk4lxlelVEwcW
marketplaceAppIdstringrequired

The application id of marketplace

Example:65f0b217a05c774da7f1efa5
paymentProviderobject

Payment provider details.

Example:{ live: { liveMode: true }, test: { liveMode: false, apiKey: "y5ZQxryRFXZHvUJZdLXXXXXX", publishableKey: "rzp_test_zPRoVMLOa0A9wo" }}
deletedbooleanrequired

Whether the config is deleted or not. true represents config is deleted

Example:true
createdAtstring<date-time>required

The creation timestamp of the custom provider.

Example:2023-11-20T10:23:36.515Z
updatedAtstring<date-time>required

The last update timestamp of the custom provider.

Example:2024-01-23T09:57:04.846Z
traceIdstring

Trace id of the custom provider.

Example:302d2cf4-1ba0-4bf5-bc3b-f8fa76fda58a