Sign in
Transfer Quotes

Create Transfer Quote

post/v1/instances/{instance_id}/transfer-quotes

Path parameters

instance_idstring required
Example:in_000000000000

Headers

Idempotency-Keystring

Optional key to safely retry this request without performing the action twice. Retrying with the same key and an identical body replays the original response; reusing a key with a different body returns an error. Keys are kept for 24 hours.

Example:a1b2c3d4-e5f6-7890-abcd-ef1234567890

Request body

wallet_idstring required
amount_reference'sender' | 'receiver' required
cover_feesboolean nullable

If true, the sender will cover the fees. If false, the customer will cover the fees.

request_amountinteger required

100 represents 1, 2050 represents 20.50

sender_token'USDC' | 'USDT' | 'USDB' required
customer_wallet_addressstring required
customer_token'USDC' | 'USDT' | 'USDB' required
customer_network'base' | 'sepolia' | 'arbitrum_sepolia' | 'base_sepolia' | 'arbitrum' | 'polygon' | 'polygon_amoy' | 'ethereum' | 'stellar' | 'stellar_testnet' | 'tron' | 'solana' | 'solana_devnet' | 'tempo' | 'tempo_testnet' required
partner_fee_idstring nullable

Example request

{
  "wallet_id": "bl_000000000000",
  "amount_reference": "sender",
  "cover_fees": true,
  "request_amount": 1000,
  "sender_token": "USDC",
  "customer_wallet_address": "0xDD6a3aD0949396e57C7738ba8FC1A46A5a1C372C",
  "customer_token": "USDC",
  "customer_network": "polygon",
  "partner_fee_id": "pf_000000000000"
}

Response

Transfer Quote creation details

idstring required
expires_atnumber nullable required

Epoch unix timestamp that represents the final datetime to transaction be received on blockchain

commercial_quotationnumber nullable required

1 USD = 4.95 BRL

blindpay_quotationnumber nullable required

1 USD = 5.05 BRL (commercial quotation + (blindpay taxes))

receiver_amountnumber required

10.10 USDC

sender_amountnumber required

52.40 BRL needs to be sent in a pix transfer

partner_fee_amountnumber nullable

1.5 USDC

flat_feenumber required

0.5 USDC

Example response

{
  "id": "qu_000000000000",
  "expires_at": 1712958191,
  "commercial_quotation": 495,
  "blindpay_quotation": 505,
  "receiver_amount": 1010,
  "sender_amount": 5240,
  "partner_fee_amount": 150,
  "flat_fee": 50
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.