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: 8a19100c-e2ec-46ba-932f-682d2df79d8b

merchantIdstringRequired

Merchant ID in the system

Example: 6c3428c6-c8b8-444f-9ab0-78c864df1719

Responses

200Success

application/json

post

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

HTTPcURLJavaScriptPython

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

{
  "id": "8a19100c-e2ec-46ba-932f-682d2df79d8b",
  "merchantId": "6c3428c6-c8b8-444f-9ab0-78c864df1719"
}

200Success

{
  "success": true,
  "response": {
    "id": "8a19100c-e2ec-46ba-932f-682d2df79d8b",
    "merchantId": "6c3428c6-c8b8-444f-9ab0-78c864df1719",
    "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": "2026-01-29T11:16:59.959Z",
    "updatedAt": "2026-01-29T11:16:59.959Z"
  }
}