Skip to main content

Create institution quote

Requests quote for payout/conversion.

Endpoint​

POST /institution/quote

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​

{
  "session_token": "ENCRYPTED_TOKEN_SAMPLE",
  "institution_name": "DemoBank",
  "request_amount": "100.00",
  "request_currency": "USD"
}

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": "session_token is required",
  "request_id": "329e5e82-827d-4188-9d97-a9f3eedbaaca",
  "timestamp": "2026-02-11T03:59:45.802Z",
  "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": "This endpoint is not permitted for your institution.",
  "request_id": "bb3cf3c6-5900-449e-81fa-34e7b3130b59",
  "timestamp": "2026-02-11T03:59:45.797Z",
  "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.