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) - UTC request timestamp formatted as YYYY-MM-DD HH:mm:ss.
• PW-ip-address (string, required)
• User-Agent (string, required)

Header Constraints

Key	Description	Example	Data type	Requirement	Field Length
PW-subscription-key	Developer key available after portal registration. Production key is shared on request.	eed0d85c530c4b26a91d09b783d8fab3	string	mandatory	32
PW-origin-country	ISO Alpha-2 country code where the transaction is created.	TT	string	mandatory	2
PW-request-date	Current request timestamp. Format: YYYY-MM-DD HH:mm:ss (UTC).	2014-10-08 16:01:31	string	mandatory	19
PW-ip-address	Fixed institution IP used for PayWise network-level validation.	255.255.255.255	string	conditional	8-16
User-Agent	In programmable environments, this avoids running into Cloudflare issues.	Mozilla/5.0 (Windows NT 10.0; Win64; x64)	string	mandatory	255

Request Body

{
  "session_token": "SESSION_TOKEN_REDACTED",
  "institution_name": "ExampleInstitution",
  "request_amount": "100.00",
  "request_currency": "USD"
}

Downloads

• Download Postman-ready request body

Before You Implement

• Read Transactions Overview
• Read Token Encryption Guide

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.