Creating a payment link

The method creates a temporary link to connect the user. The user must follow the link and give permission to spend coins from his address. After that, you will receive a webhook with the status and payment link ID

Creating a payment link

post

/api-gateway/recurrents/create-subscriber-billing-link

Header parameters

x-api-public-keystring

Public API-key

x-api-signaturestring

Signing the request body with a private API-key

Content-typestring

Request content type

Example: application/json

Body

merchantIdstringrequired

Merchant ID in the system

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

clientIdstringrequired

Client ID in the merchant system

Example: merchant_client_unique_id

clientEmailstringrequired

Client's mail in the merchant's system

Example: [e-mail]

clientNamestring

Client name in the merchant system

Example: John Doe

returnUrlstring

URL to be used as "Return to Store" link

Example: https://merchant.domain/

webhookUrlstring

URL to notify about connecting or denying a client's connection request

Example: https://merchant.domain/webhooks/subscription

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://app.apollopayment.io/api-gateway/recurrents/create-subscriber-billing-link' \
  --header 'Content-Type: application/json' \
  --data '{
    "merchantId": "deefcd05-aa9d-4e9c-99ef-05afd371ce8f",
    "clientId": "merchant_client_unique_id",
    "clientEmail": "[e-mail]",
    "clientName": "John Doe",
    "returnUrl": "https://merchant.domain/",
    "webhookUrl": "https://merchant.domain/webhooks/subscription"
  }'

200

200

{
  "success": true,
  "response": {
    "merchantId": "deefcd05-aa9d-4e9c-99ef-05afd371ce8f",
    "clientId": "merchant_client_unique_id",
    "clientEmail": "[e-mail]",
    "clientName": "John Doe",
    "returnUrl": "https://merchant.domain/",
    "webhookUrl": "https://merchant.domain/webhooks/subscription",
    "link": "https://subscriptions.domain/42a8b646-c7e3-49fc-b536-ae4c25bdea79"
  }
}