Skip to main content

Create quote

Create a time-bound quote for a transfer request.

Endpoint​

POST /quote

Query Parameters​

  • version (string, required) - API contract version. Use exactly 2024-10-01.

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​

KeyDescriptionExampleData typeRequirementField Length
PW-subscription-keyDeveloper key available after portal registration. Production key is shared on request.eed0d85c530c4b26a91d09b783d8fab3stringmandatory32
PW-origin-countryISO Alpha-2 country code where the transaction is created.TTstringmandatory2
PW-request-dateCurrent request timestamp. Format: YYYY-MM-DD HH:mm:ss (UTC).2014-10-08 16:01:31stringmandatory19
PW-ip-addressFixed institution IP used for PayWise network-level validation.255.255.255.255stringconditional8-16
User-AgentIn programmable environments, this avoids running into Cloudflare issues.Mozilla/5.0 (Windows NT 10.0; Win64; x64)stringmandatory255

Request Body​

{
"session_token": "SESSION_TOKEN_REDACTED",
"institution_name": "ExampleInstitution",
"request_amount": "150.00",
"request_currency": "USD",
"debit_party": {
"mobile_number": "18680001234",
"organization_id": "ExampleOrg",
"account_number": "ACCT-XXXXXX",
"account_type": "wallet",
"currency": "USD",
"country": "US",
"metadata": "sender-profile-a"
},
"credit_party": {
"mobile_number": "18680001234",
"organization_id": "ExampleOrg",
"account_number": "ACCT-XXXXXX",
"account_type": "wallet",
"currency": "TTD",
"country": "TT",
"metadata": "beneficiary-profile-b"
}
}

Downloads​

Responses​

200 - Quote created successfully.​

{
"status": "success",
"code": 200,
"message": "Quote created successfully.",
"expire_date": "2026-02-26T16:45:00.000Z",
"quote_id": "quote_01JQW9X7C5M6P8R2S4T6U8V0WX",
"rate": "7.1205",
"quote_date": "2026-02-26T16:40:00.000Z",
"amount_quoted": "1068.08"
}

400 - Error response.​

{
"status": "error",
"code": 403,
"message": "Error: Exceeds user limits."
}

Notes​

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