Generate checkout link to pay payment

Generate checkout link to pay the payment.

post

Path parameters

idstringRequired

The id of the payment.

Query parameters

appIntegrationIdstringOptional

(Optional) The identifier of the specific app integration payment gateway to use for generating the checkout link. If provided, this app integration will be used to handle the payment. If null, the system will use the default payment configuration associated with the payment.

Header parameters

Brand-URLstringRequired

The brand URL of the request. This is used to identify the brand.

Example: YOUR_BRAND_URL

Auth-KeystringRequired

This is used to authenticate the request. If the request is not authenticated, the server will return a 401 Unauthorized response.

Example: YOUR_AUTH_KEY

Responses

200

The request was successful.

application/json

401

The user is not authorized to access the requested resource. The request is missing the required Auth-Key header.

application/json

429

API call exceeded rate limit due to too many requests.

application/json

post

HTTPcURLJavaScriptPython

POST /api/v1/payments/{id}/generate-checkout-link HTTP/1.1
Host: protocol.jframework.io
Brand-URL: text
Auth-Key: text
Accept: */*

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": {
    "checkoutLink": "https://paypal.com/checkout?token=example"
  },
  "errors": []
}