unified-payments
  1. Payments
unified-payments
  • Unified Payments
    • Overview
    • Encryption
    • Authentication
    • Card (Non-3DS)
    • Card (3DS)
    • Apple Pay
  • Unified Payments API
    • Payments
      • Initiate Payment
        POST
      • List Payments
        GET
      • Get Payment
        GET
    • Refunds
      • Initiate Refund
      • List Refunds
      • Get Refund
  • Schemas
    • Schemas
      • SuccessResponse
    • ErrorResponse
    • PaymentRequest
    • PaymentResponse
    • WebhookPayload
  1. Payments

Initiate Payment

POST
/v2/payments
Create a new payment. Supports card payments (with/without 3DS) and Apple Pay. Returns immediate result for non-3DS cards, or a challenge_url for 3DS/Apple Pay that requires customer redirect.

Request

Authorization
Bearer Token
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
or
Body Params application/jsonRequired

Examples

Responses

🟢200OK
application/json
Payment processed successfully
Body

🟠400Bad Request
🟠401Unauthorized
🟠409Conflict
🔴500Internal Server Error
Request Request Example
Shell
JavaScript
Java
Swift
cURL
curl --location --request POST '/v2/payments' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "merchant_reference": "order_12345",
    "merchant_meta": {
        "customer_id": "cust_789",
        "order_type": "retail"
    },
    "amount": 5000,
    "currency": "USD",
    "description": "Premium Subscription - Annual",
    "payment_method": {
        "type": "card",
        "data": "tbjH0nx6WaEkzHOjgw2crsusmVBuL8s+PxWFqYb5cWZ3k1VpR7KmN9wXyC2zQ4..."
    },
    "billing_address": {
        "first_name": "John",
        "last_name": "Doe",
        "email": "john.doe@example.com",
        "address_line_one":"Apt 5B",
        "address_line_two":"245 West 72nd Street",
        "country": "US",
        "city": "New York",
        "state": "NY"
        "zip": "10023"
    },
    "ip_address": "203.0.113.42",
    "redirect_url": "https://yoursite.com/payment/callback",
    "webhook_url": "https://yoursite.com/webhooks/payment",
    "enable_3ds": false
}'
Response Response Example
200 - Non-3DS Payment Success
{
    "status": "successful",
    "message": "Payment processed successfully",
    "data": {
        "payment_id": "01HXYZ123ABC456DEF789GHI",
        "merchant_reference": "order_12345",
        "merchant_meta": {
            "customer_id": "cust_789",
            "order_type": "retail"
        },
        "amount": 5000,
        "currency": "USD",
        "status": "completed",
        "authorization_code": "AUTH123456",
        "created_at": 1699564800000,
        "completed_at": 1699564802000
    }
}
Modified at 2026-01-13 10:56:50
Previous
Apple Pay
Next
List Payments
Built with