Skip to main content

Pre-Auth Payment Request

Initiate a pre-authorization payment request to reserve funds on a customer's card.

Endpoint Information​

Name: Payment Request (Pre Auth)
Method: POST
URL: {{BASE_URL}}/api/v1/payment/request

Description​

A pre-authorization request validates the customer's card and reserves the specified amount without immediately charging it. You must capture the transaction later to complete the payment.

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 city, 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, max 255 characters
  "requestType": "pre-auth"  // REQUIRED: Must be set to "pre-auth"
}

Key Parameters​

ParameterTypeRequiredDescription
requestTypestringYesMust be set to "pre-auth" to initiate a pre-authorization

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.paymid.com/secure-payment/2bfec39f-55dc-4f48-976b-9d37b1675007",
  "reference": "DuqXNBv0Q-sk-151s2"
}
}

Usage​

  1. Initiate Pre-Auth: Use this endpoint with requestType: "pre-auth"
  2. Redirect Customer: Redirect user to the payment_url to authorize the hold
  3. Capture Funds: Use the Capture Pre-Auth API to charge the card later

Important Notes​

Country Availability

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

Example Screenshot​

Payment Request