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

clientId*string

Client ID in the merchant system

clientEmail*string

Client's mail in the merchant's system

clientNamestring

Client name in the merchant system

returnUrlstring

URL to be used as "Return to Store" link

webhookUrlstring

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

Response

200

Body

application/json

success*boolean

Request success indicator

response*BillingLinkResponse (object)

Request

JavaScriptCurl

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": "da72896a-2f63-40d8-840d-d1a060d8c1e9",
      "clientId": "merchant_client_unique_id",
      "clientEmail": "[e-mail]"
    }),
});
const data = await response.json();

Response

{
  "success": false,
  "response": {
    "merchantId": "da72896a-2f63-40d8-840d-d1a060d8c1e9",
    "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/e942f357-005f-44ea-9e18-86ec3f626f11"
  }
}