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

Request body for getting information about the payment link

idstringrequired

Payment link ID

Example: e34d0746-b972-4b07-a9be-931f1578e898

merchantIdstringrequired

Merchant ID in the system

Example: 2612ad7b-ed3d-45e4-aab2-6a13e2ecd0e0

Responses

application/json

post

cURLJavaScriptPythonHTTP

curl -L \
  --request POST \
  --url 'https://ocp.onchainpay.io/api-gateway/recurrents/get-billing-link' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": "e34d0746-b972-4b07-a9be-931f1578e898",
    "merchantId": "2612ad7b-ed3d-45e4-aab2-6a13e2ecd0e0"
  }'

200

200

{
  "success": true,
  "response": {
    "id": "e34d0746-b972-4b07-a9be-931f1578e898",
    "merchantId": "2612ad7b-ed3d-45e4-aab2-6a13e2ecd0e0",
    "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-12-25T14:35:23.173Z",
    "updatedAt": "2024-12-25T14:35:23.173Z"
  }
}