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
Header parameters
x-api-public-keystringOptional
Public API-key
x-api-signaturestringOptional
Signing the request body with a private API-key
Content-typestringOptionalExample:
Request content type
application/json
Body
The body of the request to create a link to connect the user
merchantIdstringRequiredExample:
Merchant ID in the system
3ce560cc-4d42-4543-b9ef-8cc35c00638c
clientIdstringRequiredExample:
Client ID in the merchant system
merchant_client_unique_id
clientNamestringOptionalExample:
Client name in the merchant system
John Doe
returnUrlstringOptionalExample:
URL to be used as "Return to Store" link
https://merchant.domain/
webhookUrlstringOptionalExample:
URL to notify about connecting or denying a client's connection request
https://merchant.domain/webhooks/subscription
Responses
200Success
application/json
post
POST /api-gateway/recurrents/create-subscriber-billing-link HTTP/1.1
Host: ocp.onchainpay.io
Content-Type: application/json
Accept: */*
Content-Length: 257
{
"merchantId": "3ce560cc-4d42-4543-b9ef-8cc35c00638c",
"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": "3ce560cc-4d42-4543-b9ef-8cc35c00638c",
"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/6a42622f-4968-47e2-a24d-5f5f1dc1acd6"
}
}
Last updated