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
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

The body of the request to create a link to connect the user

merchantIdstringRequired

Merchant ID in the system

Example: 86f1f78d-77c6-4bb1-b67c-8389218ce646
clientIdstringRequired

Client ID in the merchant system

Example: merchant_client_unique_id
clientEmailstringRequired

Client's mail in the merchant's system

Example: [email protected]
clientNamestringOptional

Client name in the merchant system

Example: John Doe
returnUrlstringOptional

URL to be used as "Return to Store" link

Example: https://merchant.domain/
webhookUrlstringOptional

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

Example: https://merchant.domain/webhooks/subscription
Responses
200Success
application/json
post
/api-gateway/recurrents/create-subscriber-billing-link
POST /api-gateway/recurrents/create-subscriber-billing-link HTTP/1.1
Host: app.apollopayment.io
Content-Type: application/json
Accept: */*
Content-Length: 257

{
  "merchantId": "86f1f78d-77c6-4bb1-b67c-8389218ce646",
  "clientId": "merchant_client_unique_id",
  "clientEmail": "[email protected]",
  "clientName": "John Doe",
  "returnUrl": "https://merchant.domain/",
  "webhookUrl": "https://merchant.domain/webhooks/subscription"
}
200Success
{
  "success": true,
  "response": {
    "merchantId": "86f1f78d-77c6-4bb1-b67c-8389218ce646",
    "clientId": "merchant_client_unique_id",
    "clientEmail": "[email protected]",
    "clientName": "John Doe",
    "returnUrl": "https://merchant.domain/",
    "webhookUrl": "https://merchant.domain/webhooks/subscription",
    "link": "https://subscriptions.domain/9b0838e7-54ca-4da7-9634-d497a47f9381"
  }
}
PreviousRecurring paymentsNextGet a payment link

Last updated