Get a payment link

The method allows you to get payment link data

Get a payment link

post

Header parameters

x-api-public-keystringOptional

Public API-key

x-api-signaturestringOptional

Signing the request body with a private API-key

Content-typestringOptional

Request content type

Example: application/json

Body

application/json

Request body for getting information about the payment link

idstringRequired

Payment link ID

Example: 6a42622f-4968-47e2-a24d-5f5f1dc1acd6

merchantIdstringRequired

Merchant ID in the system

Example: 3ce560cc-4d42-4543-b9ef-8cc35c00638c

Responses

200Success

application/json

post

/api-gateway/recurrents/get-billing-link

HTTPcURLJavaScriptPython

POST /api-gateway/recurrents/get-billing-link HTTP/1.1
Host: ocp.onchainpay.io
Content-Type: application/json
Accept: */*
Content-Length: 97

{
  "id": "6a42622f-4968-47e2-a24d-5f5f1dc1acd6",
  "merchantId": "3ce560cc-4d42-4543-b9ef-8cc35c00638c"
}

200Success

{
  "success": true,
  "response": {
    "id": "6a42622f-4968-47e2-a24d-5f5f1dc1acd6",
    "merchantId": "3ce560cc-4d42-4543-b9ef-8cc35c00638c",
    "clientId": "merchant_client_unique_id",
    "clientName": "John Doe",
    "clientEmail": "[email protected]",
    "webhookUrl": "https://merchant.domain/webhooks/subscription",
    "returnUrl": "https://merchant.domain/",
    "address": "0x00000005707Bf50EfA35a2db020eDe9Ac0780b9f",
    "currency": "USDT",
    "network": "ethereum",
    "status": "PENDING",
    "createdAt": "2025-06-09T13:18:11.530Z",
    "updatedAt": "2025-06-09T13:18:11.530Z"
  }
}