Payment Request

Create a payment request to redirect customers to the Paymid payment checkout page.

Endpoint Information

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

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",
  "email": "[email protected]",
  "contactNumber": "+889943432",
  "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": "100001",
  "webhookUrl": "https://example.webhook",  // optional (if your Api Config already have ipn-url set & if you send webhookUrl in the payload then it will overwrite your config ipn & webhook url.)
  "successUrl": "https://example.com/success",  // optional
  "failedUrl": "https://example.com/failed"  // optional
}

Request Parameters

Parameter	Type	Required	Description
firstName	string	Yes	Customer's first name
middleName	string	No	Customer's middle name
lastName	string	Yes	Customer's last name
reference	string	Yes	Unique transaction reference (minimum 10 characters, no special characters)
dob	string	Yes	Customer's date of birth (YYYY-MM-DD format)
email	string	Yes	Customer's email address
contactNumber	string	Yes	Customer's contact number with country code
address	string	Yes	Customer's address
country	string	Yes	Country name
state	string	Yes	State/province name (use "N/A" if not applicable)
city	string	Yes	City name
zipCode	number	Yes	Postal/ZIP code
currency	string	Yes	Currency code in ISO 4217 format (e.g., USD, EUR, GBP)
amount	number	Yes	Payment amount
ttl	number	No	Time to live in minutes (default: 15 minutes)
tagName	string	No	Optional tag for categorization
merchantAccountId	string	Yes	Your merchant account ID
webhookUrl	string	No	Webhook URL for payment notifications (overrides API Config if provided)
successUrl	string	No	Redirect URL after successful payment
failedUrl	string	No	Redirect URL after failed payment

Response

Success Response

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

Response Fields

Field	Type	Description
success	boolean	Request success status
message	string	Response message
data.payment_url	string	Payment checkout URL to redirect the customer

Important Notes

Country Availability

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

Usage

1. Make a POST request with customer and payment details
2. Receive the payment_url in the response
3. Redirect the customer to the payment_url
4. Customer completes payment on the secure checkout page
5. Receive webhook notification on transaction completion

Related Endpoints

• Payment with Checkout Template - Use a custom checkout template
• Dynamic Currency Payment - Accept payments with currency conversion
• Payment with Solution ID - Process through specific payment solution