Skip to main content

Create payment request

Wrapper endpoint for payment-request upstream route.

Endpoint​

POST /payments/request

Query Parameters​

  • version (string, required) - API contract version. Use exactly 2024-10-01.
  • diagnostics (boolean, optional) - Non-production docs only. Set true to include extra diagnostic metadata (for example observed_client_ip).

Header Parameters​

  • PW-subscription-key (string, required)
  • PW-origin-country (string, required)
  • PW-request-date (string, required)
  • PW-ip-address (string, required)
  • User-Agent (string, required)

Request Body​

{
  "api_key": "sandbox_api_key",
  "transaction_request": {
    "amount": "25.00",
    "currency": "USD",
    "customer_reference": "cust_123"
  }
}

Responses​

200 - Wrapper-normalized response envelope (success cases).​

Schema provided without concrete example payload.

400 - Wrapper-normalized response envelope (400)​

Example: error​

{
  "status": "error",
  "code": 400,
  "message": "api_key is required",
  "request_id": "4d55f2c0-487a-4a10-8c0a-5a136eb7f176",
  "timestamp": "2026-02-11T03:59:45.554Z",
  "observed_client_ip": {
    "request_ip": "172.64.80.1",
    "socket_remote_address": "172.64.80.1"
  }
}

403 - Wrapper-normalized response envelope (403)​

Example: captured_primary​

{
  "status": "error",
  "code": 403,
  "message": "Invalid or unauthorized `PW-subscription-key`",
  "request_id": "590fdf72-928a-4114-bb98-8c3d3ddb5d55",
  "timestamp": "2026-02-11T03:59:45.550Z",
  "observed_client_ip": {
    "request_ip": "172.64.80.1",
    "socket_remote_address": "172.64.80.1"
  }
}

Notes​

This endpoint page is generated from openapi/pw-wrappers.2024-10-01.yaml.