Get a payment link

The method allows you to get payment link data

Get a payment link

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

Header parameters

Body

application/json

id*string

Payment link ID

Example: "ca1763a5-1ff3-42c1-9673-a3cffe66cd89"

merchantId*string

Merchant ID in the system

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

Response

200

Body

application/json

success*boolean

Request success indicator

response*SubscriptionBillingLinkResponse (object)

Body of the response to the request for obtaining data on the payment link

Request

JavaScriptCurlPython

const response = await fetch('https://ocp.onchainpay.io/api-gateway/recurrents/get-billing-link', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "id": "ca1763a5-1ff3-42c1-9673-a3cffe66cd89",
      "merchantId": "7d84b681-d1ea-431e-b479-4834577a33ae"
    }),
});
const data = await response.json();

Response

200

{
  "success": false,
  "response": {
    "id": "ca1763a5-1ff3-42c1-9673-a3cffe66cd89",
    "merchantId": "7d84b681-d1ea-431e-b479-4834577a33ae",
    "clientId": "merchant_client_unique_id",
    "clientName": "John Doe",
    "clientEmail": "[e-mail]",
    "webhookUrl": "https://merchant.domain/webhooks/subscription",
    "returnUrl": "https://merchant.domain/",
    "address": "0x00000005707Bf50EfA35a2db020eDe9Ac0780b9f",
    "currency": "USDT",
    "network": "ethereum",
    "status": "PENDING",
    "createdAt": "2024-11-07T12:41:09.831Z",
    "updatedAt": "2024-11-07T12:41:09.831Z"
  }
}