Create new integration

POST 
/payments/custom-provider/provider

API to create a new association for an app and location

Request

Version stringrequired

API Version

Available optionsv3

locationId stringrequired

Location id

application/json

application/json

Body

Bodyrequired

namestringrequired

The name of the custom provider

descriptionstringrequired

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

paymentsUrlstringrequired

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

queryUrlstringrequired

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

imageUrlstringrequired

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

supportsSubscriptionSchedulebooleanrequired

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

Example (auto)

{
  "name": "Company Paypal Integration",
  "description": "This payment gateway supports payments in India via UPI, Net banking, cards and wallets.",
  "paymentsUrl": "https://testpayment.paypal.com",
  "queryUrl": "https://testsubscription.paypal.com",
  "imageUrl": "https://testsubscription.paypal.com",
  "supportsSubscriptionSchedule": true
}

application/json

Successful response

application/json

Schema

Schema

namestringrequired

The name of the custom provider

descriptionstringrequired

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

paymentsUrlstringrequired

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

queryUrlstringrequired

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

imageUrlstringrequired

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

_idstringrequired

The unique identifier for the custom provider.

locationIdstringrequired

Location id

marketplaceAppIdstringrequired

The application id of marketplace

paymentProviderobject

Payment provider details.

deletedbooleanrequired

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

createdAtstring<date-time>required

The creation timestamp of the custom provider.

updatedAtstring<date-time>required

The last update timestamp of the custom provider.

traceIdstring

Trace id of the custom provider.

Example (auto)

{
  "name": "Company Paypal Integration",
  "description": "This payment gateway supports payments in India via UPI, Net banking, cards and wallets.",
  "paymentsUrl": "https://testpayment.paypal.com",
  "queryUrl": "https://testsubscription.paypal.com",
  "imageUrl": "https://testsubscription.paypal.com",
  "_id": "662a44ad19a2a44d3cd9d749",
  "locationId": "Lk3nlfk4lxlelVEwcW",
  "marketplaceAppId": "65f0b217a05c774da7f1efa5",
  "paymentProvider": "{ live: { liveMode: true }, test: { liveMode: false, apiKey: \"y5ZQxryRFXZHvUJZdLXXXXXX\", publishableKey: \"rzp_test_zPRoVMLOa0A9wo\" }}",
  "deleted": true,
  "createdAt": "2023-11-20T10:23:36.515Z",
  "updatedAt": "2024-01-23T09:57:04.846Z",
  "traceId": "302d2cf4-1ba0-4bf5-bc3b-f8fa76fda58a"
}