Skip to main content
POST
/
v3
/
payout
/
quote
cURL
curl --request POST \
  --url https://service-sandbox.tazapay.com/v3/payout/quote \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "payout_type": "local",
  "payout_info": {
    "amount": 123,
    "currency": "<string>"
  },
  "local": {
    "fund_transfer_network": "<string>"
  },
  "holding_info": {
    "currency": "<string>"
  },
  "destination_info": {
    "currency": "<string>",
    "country": "<string>",
    "amount": 123
  },
  "local_payment_network": {
    "type": "<string>"
  },
  "wallet": {
    "type": "<string>"
  },
  "swift": {
    "charge_type": "<string>"
  }
}
'
{
  "id": "poq_d3inm6ami8u10oqfm",
  "local": {
    "fund_transfer_network": "chats"
  },
  "local_payment_network": {
    "payment_network": ""
  },
  "object": "payout_quote",
  "payout_type": "local",
  "holding_info": {
    "currency": "USD",
    "amount": 640000
  },
  "payout_info": {
    "currency": "HKD",
    "amount": 5000000
  },
  "destination_info": {
    "currency": "HKD",
    "amount": 5000000
  },
  "fee_info": {
    "fixed": {
      "in_holding_currency": 200,
      "in_payout_currency": 15
    },
    "variable": {
      "in_holding_currency": 1280,
      "in_payout_currency": 100
    }
  },
  "exchange_rates": {
    "holding_to_payout": 7.81,
    "payout_to_destination": 1
  },
  "valid_until": "2024-12-03T14:30:00+08:00",
  "status": "active",
  "created_at": "2024-12-03T14:00:00+08:00",
  "updated_at": "2024-12-03T14:00:00+08:00",
  "wallet": {}
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json
​
payout_type
string
default:local
required

Type of the payout. Possible values - swift, local, local_payment_network, wallet, tazapay_account

​
payout_info
object
required

Amount in payout currency

​
local
object

Object containing additional details if the payout_type is local

​
holding_info
object

Amount in balance (holding) currency

​
destination_info
object

Amount in destination currency (currency in which beneficiary receives the funds)

​
local_payment_network
object

Object containing additional details if the payout type is local_payment_network

​
wallet
object

Object containing additional details if the payout type is wallet

​
swift
object

Object containing additional details if the payout_type is `swift

Response

200 - application/json
​
id
string

Unique identifier for the payout quote

Example:

"poq_aohnraoinrfaoinrao"

​
object
string

Type of the object

Example:

"payout_quote"

​
payout_type
string

Type of payout (e.g., local, swift)

Example:

"local"

​
holding_info
object

Details about the holding currency and amount

​
payout_info
object

Information about payout currency and amount

​
destination_info
object

Information about destination currency and amount

​
fee_info
object

Breakdown of fixed and variable fees

​
exchange_rates
object

Exchange rates used in the payout quote

​
valid_until
string

Timestamp until which the quote is valid (ISO 8601 format)

Example:

"2025-06-23T20:17:00+08:00"

​
status
string

Status of the payout quote

Example:

"active"

​
created_at
string

Timestamp when the payout quote was created

Example:

"2025-06-23T20:16:00+08:00"

​
updated_at
string

Timestamp when the payout quote was last updated

Example:

"2025-06-23T20:16:00+08:00"