Sign in
Transfers

Retrieve Transfer

get/v1/instances/{instance_id}/transfers/{id}

Path parameters

instance_idstring required
Example:in_000000000000
idstring required
Example:pa_000000000000

Response

List transfers

idstring required
status'processing' | 'failed' | 'refunded' | 'completed' required

Transfer general status

transfer_quote_idstring required
instance_idstring required
created_atstring date-time nullable
updated_atstring date-time nullable
image_urlstring uri nullable
first_namestring nullable
last_namestring nullable
legal_namestring nullable
wallet_idstring required
sender_token'USDC' | 'USDT' | 'USDB' required
sender_amountnumber required

52.40 BRL needs to be sent in a pix transfer

receiver_amountnumber required

10.10 USDC

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

1.5 USDC

external_idstring nullable
customer_idstring required
addressstring nullable
network'base' | 'sepolia' | 'arbitrum_sepolia' | 'base_sepolia' | 'arbitrum' | 'polygon' | 'polygon_amoy' | 'ethereum' | 'stellar' | 'stellar_testnet' | 'tron' | 'solana' | 'solana_devnet' | 'tempo' | 'tempo_testnet' required

Example response

{
  "id": "bl_000000000000",
  "status": "processing",
  "transfer_quote_id": "pq_000000000000",
  "instance_id": "in_000000000000",
  "tracking_transaction_monitoring": {
    "step": "processing",
    "blockchain_screening": 1,
    "risk_score": 1,
    "completed_at": "2011-10-05T14:48:00.000Z"
  },
  "tracking_paymaster": {
    "step": "on_hold",
    "transaction_hash": "0x123...890",
    "gas_fee": "100",
    "completed_at": "2011-10-05T14:48:00.000Z",
    "error_message": "Gas fee is too low"
  },
  "tracking_bridge_swap": {
    "step": "on_hold",
    "transaction_hash": "0x123...890",
    "gas_fee": "100",
    "completed_at": "2011-10-05T14:48:00.000Z",
    "error_message": "Gas fee is too low"
  },
  "tracking_complete": {
    "step": "on_hold",
    "transaction_hash": "0x123...890",
    "gas_fee": "100",
    "completed_at": "2011-10-05T14:48:00.000Z",
    "error_message": "Gas fee is too low"
  },
  "created_at": "2021-01-01T00:00:00Z",
  "updated_at": "2021-01-01T00:00:00Z",
  "image_url": "https://example.com/image.png",
  "first_name": "John",
  "last_name": "Doe",
  "legal_name": "Company Name Inc.",
  "wallet_id": "bl_000000000000",
  "sender_token": "USDC",
  "sender_amount": 5240,
  "receiver_amount": 1010,
  "customer_network": "polygon",
  "customer_token": "USDC",
  "customer_wallet_address": "0xDD6a3aD0949396e57C7738ba8FC1A46A5a1C372C",
  "partner_fee_amount": 150,
  "external_id": "your-database-id",
  "customer_id": "re_000000000000",
  "address": "0xDD6a3aD0949396e57C7738ba8FC1A46A5a1C372C",
  "network": "polygon"
}

Changes

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