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: 42a8b646-c7e3-49fc-b536-ae4c25bdea79

merchantIdstringrequired

Merchant ID in the system

Example: deefcd05-aa9d-4e9c-99ef-05afd371ce8f

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://app.apollopayment.io/api-gateway/recurrents/get-billing-link' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": "42a8b646-c7e3-49fc-b536-ae4c25bdea79",
    "merchantId": "deefcd05-aa9d-4e9c-99ef-05afd371ce8f"
  }'

200

200

{
  "success": true,
  "response": {
    "id": "42a8b646-c7e3-49fc-b536-ae4c25bdea79",
    "merchantId": "deefcd05-aa9d-4e9c-99ef-05afd371ce8f",
    "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-26T08:21:53.366Z",
    "updatedAt": "2024-12-26T08:21:53.366Z"
  }
}