Documentation Index
Fetch the complete documentation index at: https://developers.leadwaycrm.com/llms.txt
Use this file to discover all available pages before exploring further.
API to create a new payment config for given account
POST https://services.leadconnectorhq.com/payments/custom-provider/connect
Autorizacion
Bearer token generado desde el portal Leadway. Ver Autenticacion. Version
string
default:"2021-07-28"
required
Version de la API.
Query parameters
locationId
string
default:"Lk3nlfk4lxlelVEwcW"
required
Account id
Body
Live config containing api-key and publishable key for live payments
Test config containing api-key and publishable-key for test payments
Respuestas
200 - Successful response
name
string
default:"Company Paypal Integration"
required
The name of the custom provider
Description of payment gateway. Shown on the payments integrations page as subtext
paymentsUrl
string
default:"https://testpayment.paypal.com"
required
This url will be loaded in iFrame to start a payment session.
queryUrl
string
default:"https://testsubscription.paypal.com"
required
The url used for querying payments related events. Ex. verify, refund, subscription etc.
imageUrl
string
default:"https://testsubscription.paypal.com"
required
Public image url for logo of the payment gateway displayed on the payments integrations page.
_id
string
default:"662a44ad19a2a44d3cd9d749"
required
The unique identifier for the custom provider.
locationId
string
default:"Lk3nlfk4lxlelVEwcW"
required
Account id
marketplaceAppId
string
default:"65f0b217a05c774da7f1efa5"
required
The application id of marketplace
Payment provider details.
deleted
boolean
default:"True"
required
Whether the config is deleted or not. true represents config is deleted
createdAt
string
default:"2023-11-20T10:23:36.515Z"
required
The creation timestamp of the custom provider.
updatedAt
string
default:"2024-01-23T09:57:04.846Z"
required
The last update timestamp of the custom provider.
traceId
string
default:"302d2cf4-1ba0-4bf5-bc3b-f8fa76fda58a"
Trace id of the custom provider.
{
"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"
}
400 - No such config exists for given locationId and marketplaceAppId
422 - Unprocessable Entity
Ejemplo
curl -X POST 'https://services.leadconnectorhq.com/payments/custom-provider/connect' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28' \
-H 'Content-Type: application/json' \
-d '{}'
