Test creating a checkout link

This endpoint is used to test the process of generating a checkout link for a given App Integration using the configured payment gateway settings.

It allows developers to validate that the integration with the payment gateway is working as expected, before enabling real payment flows in production.

Test creating a checkout link

post

This endpoint is used to test the creation of a checkout link for the given app integration. The checkout link will be created with the given payload request.

Path parameters

appIntegrationIdstringRequired

The id of the app integration.

Header parameters

Brand-URLstringRequired

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

Example: YOUR_BRAND_URL

Auth-KeystringRequired

Auth-Key is required to authenticate the request. If missing, the server will return 401 Unauthorized.

Example: YOUR_AUTH_KEY

Body

application/jsontext/jsonapplication/*+json

publicKeystring · min: 1Required

The public key of the payment gateway used for authentication. For PayPal: Client ID from your PayPal app credentials (used with OAuth 2.0). For Stripe: Publishable key from your Stripe dashboard (used client-side).

privateKeystring · min: 1Required

The private key of the payment gateway used for secure server-side operations. For PayPal: Secret from your PayPal app credentials. For Stripe: Secret key from your Stripe dashboard (used for server-side API calls). Note: This should never be exposed to client-side code.

displayNamestring · min: 1Required

The display name shown to customers during checkout. For PayPal: Appears as the merchant name during PayPal checkout flow. For Stripe: Displayed as the company name on Stripe Checkout pages. Maximum length is typically 127 characters for most payment providers.

Responses

200

The request was successful.

application/json

This provides interfaces for API responses with data.

successbooleanRead-onlyRequired

This is the flag to indicate whether the API call is successful or not.

statusCodeinteger · int32Read-onlyRequired

This is the HTTP status code. This is used to determine the status code to be returned to the client.

messagestring · min: 1Read-onlyRequired

This is the message to be displayed to the user.

datastring · nullableRead-onlyOptional

This is the data to be returned to the client.

401

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

application/json

403

The user's access was denied.

application/json

429

API call exceeded rate limit due to too many requests.

application/json

post

/api/v1/app-integrations/{appIntegrationId}/payment-gateway/test

HTTPcURLJavaScriptPython

POST /api/v1/app-integrations/{appIntegrationId}/payment-gateway/test HTTP/1.1
Host: protocol.jframework.io
Brand-URL: text
Auth-Key: text
Content-Type: application/json
Accept: */*
Content-Length: 257

{
  "product": {
    "name": "text",
    "description": "text",
    "currencyCode": "text",
    "code": "text",
    "quantity": 1,
    "amount": 1,
    "tax": 1,
    "shipping": 1,
    "returnURL": "https://example.com",
    "cancelURL": "https://example.com"
  },
  "publicKey": "text",
  "privateKey": "text",
  "displayName": "text"
}

application/jsontext/jsonapplication/*+json

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": "CHECKOUT_URL",
  "errors": []
}