Skip to main content

Payment Request with Checkout Template

Create a payment request using a specific checkout template design.

Endpoint Information​

Name: Payment Request with Checkout Template
Method: POST
URL: {{BASE_URL}}/api/v1/payment/request

Description​

If you need to make payment with a specific template, you need to provide the checkout templateId of the template. This allows you to customize the payment checkout page appearance for your customers.

Authentication​

Type: Basic Auth

  • Username: App Key
  • Password: Secret Key

Request Body​

Content-Type: application/json

{
  "firstName": "John",
  "middleName": "",  // optional
  "lastName": "Doe",
  "reference": "Test123456",  // must be 10 characters or more, special characters not allowed
  "dob": "2023-07-20",  // optional but format must be yyyy-mm-dd if present
  "email": "[email protected]",
  "contactNumber": "+46701234567",
  "address": "Sweden",
  "country": "Sweden",
  "state": "Blekinge",  // If don't have any state, use "N/A" or "country_name"
  "city": "Jämshög",
  "zipCode": 11115,
  "currency": "USD",  // ISO 4217 format
  "amount": 110,
  "ttl": 5,  // optional (default value: 15 minutes)
  "tagName": "macbook pro m2",  // optional
  "merchantAccountId": "{{your_account_no}}",
  "templateId": "{{checkout_template_id}}",  // Required - The checkout template ID
  "webhookUrl": "https://example.webhook"  // optional, max 255 characters
}

Key Parameters​

ParameterTypeRequiredDescription
templateIdstringYesThe ID of the checkout template to use for the payment page

All other parameters are the same as the standard Payment Request.

Response​

Success Response​

{
"success": true,
"message": "Payment Request Accepted",
"data": {
  "payment_url": "https://staging.centralisera.com/secure-payment/2bfec39f-55dc-4f48-976b-9d37b1675007"
}
}

Important Notes​

Template Customization

The payment checkout page will use your custom template design when the customer is redirected to the payment URL.

Country Availability

If your country is missing from the list, please contact the help panel to activate it.