Creating a payment link

The method creates a temporary link to connect the user. The user must follow the link and give permission to spend coins from his address. After that, you will receive a webhook with the status and payment link ID

Creating a payment link

POSThttps://ocp.onchainpay.io/api-gateway/recurrents/create-subscriber-billing-link

Header parameters

Body

application/json

merchantId*string

Merchant ID in the system

Example: "7d84b681-d1ea-431e-b479-4834577a33ae"

clientId*string

Client ID in the merchant system

Example: "merchant_client_unique_id"

clientEmail*string

Client's mail in the merchant's system

Example: "[e-mail]"

clientNamestring

Client name in the merchant system

Example: "John Doe"

returnUrlstring

URL to be used as "Return to Store" link

Example: "https://merchant.domain/"

webhookUrlstring

URL to notify about connecting or denying a client's connection request

Example: "https://merchant.domain/webhooks/subscription"

Response

200

Body

application/json

success*boolean

Request success indicator

response*BillingLinkResponse (object)

Request

JavaScriptCurlPython

const response = await fetch('https://ocp.onchainpay.io/api-gateway/recurrents/create-subscriber-billing-link', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "merchantId": "7d84b681-d1ea-431e-b479-4834577a33ae",
      "clientId": "merchant_client_unique_id",
      "clientEmail": "[e-mail]"
    }),
});
const data = await response.json();

Response

200

{
  "success": false,
  "response": {
    "merchantId": "7d84b681-d1ea-431e-b479-4834577a33ae",
    "clientId": "merchant_client_unique_id",
    "clientEmail": "[e-mail]",
    "clientName": "John Doe",
    "returnUrl": "https://merchant.domain/",
    "webhookUrl": "https://merchant.domain/webhooks/subscription",
    "link": "https://subscriptions.domain/ca1763a5-1ff3-42c1-9673-a3cffe66cd89"
  }
}