---
title: "Retrieve Payouts"
method: GET
path: "/v1/instances/{instance_id}/payouts"
tags: ["Payouts"]
---

# Retrieve Payouts

`GET /v1/instances/{instance_id}/payouts`

## Path parameters

- `instance_id` string, required

## Query parameters

- `limit` '10' | '50' | '100' | '200' | '500' | '1000' — Number of items to return
- `offset` '0' | '10' | '50' | '100' | '200' | '500' | '1000' — Number of items to skip
- `starting_after` string — A cursor for use in pagination. starting_after is an object ID that defines your place in the list.
- `ending_before` string — A cursor for use in pagination. ending_before is an object ID that defines your place in the list.
- `customer_id` string
- `status` 'processing' | 'failed' | 'refunded' | 'completed' | 'on_hold'
- `customer_name` string
- `bank_account_id` string
- `country` string
- `payment_method` 'wire' | 'ach' | 'pix' | 'pix_safe' | 'ted' | 'spei_bitso' | 'transfers_bitso' | 'ach_cop_bitso' | 'international_swift' | 'rtp' | 'sepa'
- `network` string
- `token` string

## Response `200`

List payouts with pagination and filtering

- union
  - object
    - `data` PayoutOut[], required
      - `customer_id` string, required — Customer id
      - `id` string, required
      - `status` 'processing' | 'failed' | 'refunded' | 'completed' | 'on_hold', required — Payout general status
      - `sender_wallet_address` string, required — Payout wallet address
      - `signed_transaction` string, nullable — Signed transaction
      - `quote_id` string, required
      - `instance_id` string, required
      - `partner_fee` integer — Payout partner fee amount in cents (can be negative for rebates)
      - `tracking_transaction` object, required
        - `step` 'processing' | 'on_hold' | 'pending_review' | 'pending_refund_review' | 'completed', required — Payout transaction step
        - `status` 'failed' | 'found', nullable — Payout transaction status
        - `transaction_hash` string, nullable — Blockchain transaction hash
        - `completed_at` string, nullable — Payout transaction completed date
        - `provider_transaction_id` string, nullable — Provider-side handle for the on-chain leg (e.g. Circle CPN payment id).
        - `provider_error_reason` string, nullable — Provider error reason when the crypto collection fails (e.g. erc20_allowance_insufficient, ESTIMATION_ERROR: execution reverted)
        - `ledger_in_transaction_id` string, nullable — Ledger transaction ID for the IN (crypto deposit) transaction
        - `ledger_out_transaction_id` string, nullable — Ledger transaction ID for the OUT (fiat withdrawal) transaction
      - `tracking_payment` object, required
        - `step` 'processing' | 'on_hold' | 'pending_review' | 'pending_refund_review' | 'completed', required — Payment step
        - `provider_name` 'Nvio Pagos' | 'Brex' | 'Stark Bank' | 'JPMorgan Chase' | 'HSBC' | 'Inter' | 'JP Morgan Chase' | 'Bitso' | 'Citi' | 'CFSB' | 'Triple A Technologies' | 'Portage Bank', nullable — Payment provider name
        - `provider_integration` 'veem' | 'zenus' | 'checkbook' | 'onemoney' | 'bitso' | 'starkbank' | 'triplea' | 'infinitus', nullable — Machine-readable integration that executed the fiat leg. Unlike provider_name (a client-facing bank label), this uniquely identifies the integration — e.g. zenus vs checkbook, which share the "JPMorgan Chase" label.
        - `provider_transaction_id` string, nullable — Payment provider transaction id
        - `provider_status` 'canceled' | 'failed' | 'returned' | 'sent', nullable — Payment provider status
        - `provider_error_reason` string, nullable — Provider error reason when payment fails (e.g. invalid_key, wrong_parameters)
        - `provider_uetr` string, nullable — Unique end-to-end transaction reference (UETR). Populated once the wire is confirmed by the network; null while the payment is in flight or when the rail does not expose it (e.g. ACH).
        - `provider_imad` string, nullable — Fed Input Message Accountability Data (IMAD). Domestic Fedwire payments only; null on ACH and SWIFT.
        - `provider_reference` string, nullable — Provider (JPMorgan/Zenus) payment reference captured from the ACCOUNT.ACCOUNT booking webhook (Zenus contractSource.sourceRef). Present for some ACH/wire payouts; a bank-side reference, not the formal ACH network trace number.
        - `provider_clearing_system` string, nullable — Clearing system that processed the payment (e.g. FED, CHIPS, ACH, SWIFT).
        - `forced_provider` 'zenus' | 'veem', nullable — Ops-set per-payout provider override (backoffice Reroute tab). When present it wins over the instance payment_route and default routing at send time. Left in place after the send as an audit marker of the forced route.
        - `recipient_name` string, nullable — Recipient name
        - `recipient_tax_id` string, nullable — Recipient tax id
        - `recipient_bank_code` string, nullable — Recipient bank code
        - `recipient_branch_code` string, nullable — Recipient branch code
        - `recipient_account_number` string, nullable — Recipient account number
        - `recipient_account_type` string, nullable — Recipient account type
        - `coelsa_id` string, nullable — COELSA transaction reference ID for ARS transfers (Argentine national banking system)
        - `end_to_end_id` string, nullable — BACEN Pix end-to-end transaction ID (govt Pix ID)
        - `estimated_time_of_arrival` '5_min' | '5_30_min' | '30_min' | '2_hours' | '1_business_day' | '2_business_days' | '5_business_days', nullable — Estimated time of arrival
        - `completed_at` string, nullable — Payment completed date
        - `refund_review_reason` 'amount_threshold' | 'time_window' | 'late_cancellation_no_live_run' | 'master_account_return', nullable — Why the payout was routed to the Pending Refunds review queue instead of auto-refunding after a provider cancellation
        - `refund_review_detected_at` string, nullable — When the provider cancellation was routed to the Pending Refunds review queue
        - `refund_review_actioned_at` string, nullable — Atomic claim marker: set the moment an operator approves a Pending Refunds entry, before the refund is sent, so a concurrent approve call cannot re-claim the same payout
      - `tracking_liquidity` object, nullable
        - `step` 'processing' | 'on_hold' | 'pending_review' | 'pending_refund_review' | 'completed', required — Payout liquidity step
        - `provider_transaction_id` string, nullable — Payment provider transaction id
        - `provider_status` 'deposited' | 'converted' | 'withdrawn', nullable — Payment provider status
        - `estimated_time_of_arrival` '5_min' | '5_30_min' | '30_min' | '2_hours' | '1_business_day' | '2_business_days' | '5_business_days', nullable — Estimated time of arrival
        - `completed_at` string, nullable — Payout transaction completed date
      - `tracking_complete` object, required
        - `step` 'processing' | 'on_hold' | 'pending_review' | 'pending_refund_review' | 'completed', required — Complete step
        - `status` 'tokens_refunded' | 'paid', nullable — Complete status
        - `refund_reason` string, nullable — Reason for refund when tokens are returned to sender
        - `transaction_hash` string, nullable — Complete transaction hash
        - `provider_transaction_id` string, nullable — Provider-side handle for the refund transaction (e.g. Circle transaction id)
        - `completed_at` string, nullable — Complete completed date
      - `tracking_documents` object, nullable
        - `step` 'processing' | 'on_hold' | 'pending_review' | 'pending_refund_review' | 'completed', required — Documents step
        - `status` 'waiting_documents' | 'compliance_reviewing', nullable — Documents status
        - `reviewed_by` string, nullable — Reviewer email/name
        - `completed_at` string, nullable — Documents completed date
      - `jpm_track_data` object, nullable
        - `jpm_trace_number` string, nullable — JPM trace number
        - `jpm_processing_status` string, nullable — JPM processing status
        - `extended_tracking_status` string, nullable — Extended tracking status from JPM
        - `jpm_reference_number` string, nullable — JPM reference number
        - `uetr` string, nullable — Unique end-to-end transaction reference
        - `fed_imad` string, nullable — Fed IMAD number (Wire payments only)
        - `payment_date` string, nullable — Payment date
        - `payment_amount` string, nullable — Payment amount
        - `payment_currency` string, nullable — Payment currency
      - `cpn_payment_id` string, nullable — Circle CPN payment id
      - `created_at` string, date-time, nullable
      - `updated_at` string, date-time, nullable
      - `image_url` string, uri, nullable
      - `first_name` string, nullable
      - `last_name` string, nullable
      - `legal_name` string, nullable
      - `network` 'base' | 'sepolia' | 'arbitrum_sepolia' | 'base_sepolia' | 'arbitrum' | 'polygon' | 'polygon_amoy' | 'ethereum' | 'stellar' | 'stellar_testnet' | 'tron' | 'solana' | 'solana_devnet' | 'tempo' | 'tempo_testnet', required — Check blindpay available networks
      - `token` 'USDC' | 'USDT' | 'USDB', required — Check blindpay available tokens
      - `description` string, nullable
      - `sender_amount` number, nullable, required — 10.10 USDC needs to be sent to bank account blockchain address
      - `receiver_amount` number, nullable, required — 52.40 BRL
      - `partner_fee_id` string, nullable
      - `partner_fee_amount` number, nullable — 1.5 USDC
      - `commercial_quotation` number, nullable, required — 1 USD = 4.95 BRL
      - `blindpay_quotation` number, nullable, required — 1 USD = 4.85 BRL (commercial quotation - (blindpay taxes))
      - `total_fee_amount` number, nullable — 1.5 USDC
      - `customer_local_amount` number, nullable — Estimated amount in the currency of recipient bank account
      - `currency` 'BRL' | 'USD' | 'MXN' | 'COP' | 'ARS' | 'EUR', required — ISO 4271 currency code
      - `transaction_fee_amount` number, nullable — Transaction fee in cents (percentage-based fee)
      - `billing_fee_amount` number, nullable — Billing fee in cents (charged via invoice at the end of the month)
      - `transaction_document_file` string, uri, nullable
      - `transaction_document_type` 'invoice' | 'purchase_order' | 'delivery_slip' | 'contract' | 'customs_declaration' | 'bill_of_lading' | 'others', nullable
      - `transaction_document_id` string, nullable
      - `name` string, nullable
      - `type` 'wire' | 'ach' | 'pix' | 'pix_safe' | 'ted' | 'spei_bitso' | 'transfers_bitso' | 'ach_cop_bitso' | 'international_swift' | 'rtp' | 'sepa', nullable
      - `pix_key` string, nullable
      - `pix_safe_bank_code` string, nullable
      - `pix_safe_branch_code` string, nullable
      - `pix_safe_cpf_cnpj` string, nullable
      - `ted_bank_code` string, nullable
      - `ted_branch_code` string, nullable
      - `ted_cpf_cnpj` string, nullable
      - `account_number` string, nullable
      - `routing_number` string, nullable
      - `country` 'AF' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BQ' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'CV' | 'KH' | 'CM' | 'CA' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CD' | 'CG' | 'CK' | 'CR' | 'HR' | 'CU' | 'CW' | 'CY' | 'CZ' | 'CI' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'SZ' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GG' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IM' | 'IL' | 'IT' | 'JM' | 'JP' | 'JE' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'ME' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'MK' | 'RO' | 'RU' | 'RW' | 'RE' | 'BL' | 'SH' | 'KN' | 'LC' | 'MF' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'RS' | 'SC' | 'SL' | 'SG' | 'SX' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'SS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'UM' | 'US' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'AX', nullable
      - `account_class` 'individual' | 'business', nullable
      - `address_line_1` string, nullable
      - `address_line_2` string, nullable
      - `city` string, nullable
      - `state_province_region` string, nullable
      - `postal_code` string, nullable
      - `account_type` 'checking' | 'saving', nullable
      - `ach_cop_beneficiary_first_name` string, nullable
      - `ach_cop_bank_account` string, nullable
      - `ach_cop_bank_code` string, nullable
      - `ach_cop_beneficiary_last_name` string, nullable
      - `ach_cop_document_id` string, nullable
      - `ach_cop_document_type` 'CC' | 'CE' | 'NIT' | 'PASS' | 'PEP', nullable — CC - Cédula de Ciudadanía; CE - Cédula de Extranjería; NIT - Número de Identificación Tributaria; PASS - Passport; PEP - Permiso Especial de Permanencia
      - `ach_cop_email` string, nullable
      - `beneficiary_name` string, nullable
      - `spei_clabe` string, nullable
      - `spei_protocol` 'clabe' | 'debitcard' | 'phonenum', nullable — For debitcard and phonenum the spei_institution_code is required
      - `spei_institution_code` string, nullable
      - `swift_beneficiary_country` 'AF' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BQ' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'CV' | 'KH' | 'CM' | 'CA' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CD' | 'CG' | 'CK' | 'CR' | 'HR' | 'CU' | 'CW' | 'CY' | 'CZ' | 'CI' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'SZ' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GG' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IM' | 'IL' | 'IT' | 'JM' | 'JP' | 'JE' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'ME' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'MK' | 'RO' | 'RU' | 'RW' | 'RE' | 'BL' | 'SH' | 'KN' | 'LC' | 'MF' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'RS' | 'SC' | 'SL' | 'SG' | 'SX' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'SS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'UM' | 'US' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'AX', nullable
      - `swift_code_bic` string, nullable
      - `swift_account_holder_name` string, nullable
      - `swift_account_number_iban` string, nullable
      - `transfers_account` string, nullable
      - `transfers_type` 'CVU' | 'CBU' | 'ALIAS', nullable
      - `bank_account_id` string, nullable
      - `payable_id` string, nullable — The payable this payout executes, when it pays a payable instead of a bank account.
      - `has_virtual_account` boolean, nullable — Has virtual account
      - `sender_legal_name` string, nullable — Legal name of the sending instance (originator), shown on the receipt
    - `pagination` PaginationMetadata, required
      - `has_more` boolean, required — Whether or not there are more elements available after this set.
      - `next_page` string, nullable — The ID of the first item in the next page of results.
      - `prev_page` string, nullable — The ID of the first item in the previous page of results.
  - PayoutOut[]
    - `customer_id` string, required — Customer id
    - `id` string, required
    - `status` 'processing' | 'failed' | 'refunded' | 'completed' | 'on_hold', required — Payout general status
    - `sender_wallet_address` string, required — Payout wallet address
    - `signed_transaction` string, nullable — Signed transaction
    - `quote_id` string, required
    - `instance_id` string, required
    - `partner_fee` integer — Payout partner fee amount in cents (can be negative for rebates)
    - `tracking_transaction` object, required
      - `step` 'processing' | 'on_hold' | 'pending_review' | 'pending_refund_review' | 'completed', required — Payout transaction step
      - `status` 'failed' | 'found', nullable — Payout transaction status
      - `transaction_hash` string, nullable — Blockchain transaction hash
      - `completed_at` string, nullable — Payout transaction completed date
      - `provider_transaction_id` string, nullable — Provider-side handle for the on-chain leg (e.g. Circle CPN payment id).
      - `provider_error_reason` string, nullable — Provider error reason when the crypto collection fails (e.g. erc20_allowance_insufficient, ESTIMATION_ERROR: execution reverted)
      - `ledger_in_transaction_id` string, nullable — Ledger transaction ID for the IN (crypto deposit) transaction
      - `ledger_out_transaction_id` string, nullable — Ledger transaction ID for the OUT (fiat withdrawal) transaction
    - `tracking_payment` object, required
      - `step` 'processing' | 'on_hold' | 'pending_review' | 'pending_refund_review' | 'completed', required — Payment step
      - `provider_name` 'Nvio Pagos' | 'Brex' | 'Stark Bank' | 'JPMorgan Chase' | 'HSBC' | 'Inter' | 'JP Morgan Chase' | 'Bitso' | 'Citi' | 'CFSB' | 'Triple A Technologies' | 'Portage Bank', nullable — Payment provider name
      - `provider_integration` 'veem' | 'zenus' | 'checkbook' | 'onemoney' | 'bitso' | 'starkbank' | 'triplea' | 'infinitus', nullable — Machine-readable integration that executed the fiat leg. Unlike provider_name (a client-facing bank label), this uniquely identifies the integration — e.g. zenus vs checkbook, which share the "JPMorgan Chase" label.
      - `provider_transaction_id` string, nullable — Payment provider transaction id
      - `provider_status` 'canceled' | 'failed' | 'returned' | 'sent', nullable — Payment provider status
      - `provider_error_reason` string, nullable — Provider error reason when payment fails (e.g. invalid_key, wrong_parameters)
      - `provider_uetr` string, nullable — Unique end-to-end transaction reference (UETR). Populated once the wire is confirmed by the network; null while the payment is in flight or when the rail does not expose it (e.g. ACH).
      - `provider_imad` string, nullable — Fed Input Message Accountability Data (IMAD). Domestic Fedwire payments only; null on ACH and SWIFT.
      - `provider_reference` string, nullable — Provider (JPMorgan/Zenus) payment reference captured from the ACCOUNT.ACCOUNT booking webhook (Zenus contractSource.sourceRef). Present for some ACH/wire payouts; a bank-side reference, not the formal ACH network trace number.
      - `provider_clearing_system` string, nullable — Clearing system that processed the payment (e.g. FED, CHIPS, ACH, SWIFT).
      - `forced_provider` 'zenus' | 'veem', nullable — Ops-set per-payout provider override (backoffice Reroute tab). When present it wins over the instance payment_route and default routing at send time. Left in place after the send as an audit marker of the forced route.
      - `recipient_name` string, nullable — Recipient name
      - `recipient_tax_id` string, nullable — Recipient tax id
      - `recipient_bank_code` string, nullable — Recipient bank code
      - `recipient_branch_code` string, nullable — Recipient branch code
      - `recipient_account_number` string, nullable — Recipient account number
      - `recipient_account_type` string, nullable — Recipient account type
      - `coelsa_id` string, nullable — COELSA transaction reference ID for ARS transfers (Argentine national banking system)
      - `end_to_end_id` string, nullable — BACEN Pix end-to-end transaction ID (govt Pix ID)
      - `estimated_time_of_arrival` '5_min' | '5_30_min' | '30_min' | '2_hours' | '1_business_day' | '2_business_days' | '5_business_days', nullable — Estimated time of arrival
      - `completed_at` string, nullable — Payment completed date
      - `refund_review_reason` 'amount_threshold' | 'time_window' | 'late_cancellation_no_live_run' | 'master_account_return', nullable — Why the payout was routed to the Pending Refunds review queue instead of auto-refunding after a provider cancellation
      - `refund_review_detected_at` string, nullable — When the provider cancellation was routed to the Pending Refunds review queue
      - `refund_review_actioned_at` string, nullable — Atomic claim marker: set the moment an operator approves a Pending Refunds entry, before the refund is sent, so a concurrent approve call cannot re-claim the same payout
    - `tracking_liquidity` object, nullable
      - `step` 'processing' | 'on_hold' | 'pending_review' | 'pending_refund_review' | 'completed', required — Payout liquidity step
      - `provider_transaction_id` string, nullable — Payment provider transaction id
      - `provider_status` 'deposited' | 'converted' | 'withdrawn', nullable — Payment provider status
      - `estimated_time_of_arrival` '5_min' | '5_30_min' | '30_min' | '2_hours' | '1_business_day' | '2_business_days' | '5_business_days', nullable — Estimated time of arrival
      - `completed_at` string, nullable — Payout transaction completed date
    - `tracking_complete` object, required
      - `step` 'processing' | 'on_hold' | 'pending_review' | 'pending_refund_review' | 'completed', required — Complete step
      - `status` 'tokens_refunded' | 'paid', nullable — Complete status
      - `refund_reason` string, nullable — Reason for refund when tokens are returned to sender
      - `transaction_hash` string, nullable — Complete transaction hash
      - `provider_transaction_id` string, nullable — Provider-side handle for the refund transaction (e.g. Circle transaction id)
      - `completed_at` string, nullable — Complete completed date
    - `tracking_documents` object, nullable
      - `step` 'processing' | 'on_hold' | 'pending_review' | 'pending_refund_review' | 'completed', required — Documents step
      - `status` 'waiting_documents' | 'compliance_reviewing', nullable — Documents status
      - `reviewed_by` string, nullable — Reviewer email/name
      - `completed_at` string, nullable — Documents completed date
    - `jpm_track_data` object, nullable
      - `jpm_trace_number` string, nullable — JPM trace number
      - `jpm_processing_status` string, nullable — JPM processing status
      - `extended_tracking_status` string, nullable — Extended tracking status from JPM
      - `jpm_reference_number` string, nullable — JPM reference number
      - `uetr` string, nullable — Unique end-to-end transaction reference
      - `fed_imad` string, nullable — Fed IMAD number (Wire payments only)
      - `payment_date` string, nullable — Payment date
      - `payment_amount` string, nullable — Payment amount
      - `payment_currency` string, nullable — Payment currency
    - `cpn_payment_id` string, nullable — Circle CPN payment id
    - `created_at` string, date-time, nullable
    - `updated_at` string, date-time, nullable
    - `image_url` string, uri, nullable
    - `first_name` string, nullable
    - `last_name` string, nullable
    - `legal_name` string, nullable
    - `network` 'base' | 'sepolia' | 'arbitrum_sepolia' | 'base_sepolia' | 'arbitrum' | 'polygon' | 'polygon_amoy' | 'ethereum' | 'stellar' | 'stellar_testnet' | 'tron' | 'solana' | 'solana_devnet' | 'tempo' | 'tempo_testnet', required — Check blindpay available networks
    - `token` 'USDC' | 'USDT' | 'USDB', required — Check blindpay available tokens
    - `description` string, nullable
    - `sender_amount` number, nullable, required — 10.10 USDC needs to be sent to bank account blockchain address
    - `receiver_amount` number, nullable, required — 52.40 BRL
    - `partner_fee_id` string, nullable
    - `partner_fee_amount` number, nullable — 1.5 USDC
    - `commercial_quotation` number, nullable, required — 1 USD = 4.95 BRL
    - `blindpay_quotation` number, nullable, required — 1 USD = 4.85 BRL (commercial quotation - (blindpay taxes))
    - `total_fee_amount` number, nullable — 1.5 USDC
    - `customer_local_amount` number, nullable — Estimated amount in the currency of recipient bank account
    - `currency` 'BRL' | 'USD' | 'MXN' | 'COP' | 'ARS' | 'EUR', required — ISO 4271 currency code
    - `transaction_fee_amount` number, nullable — Transaction fee in cents (percentage-based fee)
    - `billing_fee_amount` number, nullable — Billing fee in cents (charged via invoice at the end of the month)
    - `transaction_document_file` string, uri, nullable
    - `transaction_document_type` 'invoice' | 'purchase_order' | 'delivery_slip' | 'contract' | 'customs_declaration' | 'bill_of_lading' | 'others', nullable
    - `transaction_document_id` string, nullable
    - `name` string, nullable
    - `type` 'wire' | 'ach' | 'pix' | 'pix_safe' | 'ted' | 'spei_bitso' | 'transfers_bitso' | 'ach_cop_bitso' | 'international_swift' | 'rtp' | 'sepa', nullable
    - `pix_key` string, nullable
    - `pix_safe_bank_code` string, nullable
    - `pix_safe_branch_code` string, nullable
    - `pix_safe_cpf_cnpj` string, nullable
    - `ted_bank_code` string, nullable
    - `ted_branch_code` string, nullable
    - `ted_cpf_cnpj` string, nullable
    - `account_number` string, nullable
    - `routing_number` string, nullable
    - `country` 'AF' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BQ' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'CV' | 'KH' | 'CM' | 'CA' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CD' | 'CG' | 'CK' | 'CR' | 'HR' | 'CU' | 'CW' | 'CY' | 'CZ' | 'CI' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'SZ' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GG' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IM' | 'IL' | 'IT' | 'JM' | 'JP' | 'JE' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'ME' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'MK' | 'RO' | 'RU' | 'RW' | 'RE' | 'BL' | 'SH' | 'KN' | 'LC' | 'MF' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'RS' | 'SC' | 'SL' | 'SG' | 'SX' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'SS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'UM' | 'US' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'AX', nullable
    - `account_class` 'individual' | 'business', nullable
    - `address_line_1` string, nullable
    - `address_line_2` string, nullable
    - `city` string, nullable
    - `state_province_region` string, nullable
    - `postal_code` string, nullable
    - `account_type` 'checking' | 'saving', nullable
    - `ach_cop_beneficiary_first_name` string, nullable
    - `ach_cop_bank_account` string, nullable
    - `ach_cop_bank_code` string, nullable
    - `ach_cop_beneficiary_last_name` string, nullable
    - `ach_cop_document_id` string, nullable
    - `ach_cop_document_type` 'CC' | 'CE' | 'NIT' | 'PASS' | 'PEP', nullable — CC - Cédula de Ciudadanía; CE - Cédula de Extranjería; NIT - Número de Identificación Tributaria; PASS - Passport; PEP - Permiso Especial de Permanencia
    - `ach_cop_email` string, nullable
    - `beneficiary_name` string, nullable
    - `spei_clabe` string, nullable
    - `spei_protocol` 'clabe' | 'debitcard' | 'phonenum', nullable — For debitcard and phonenum the spei_institution_code is required
    - `spei_institution_code` string, nullable
    - `swift_beneficiary_country` 'AF' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BQ' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'CV' | 'KH' | 'CM' | 'CA' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CD' | 'CG' | 'CK' | 'CR' | 'HR' | 'CU' | 'CW' | 'CY' | 'CZ' | 'CI' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'SZ' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GG' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IM' | 'IL' | 'IT' | 'JM' | 'JP' | 'JE' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'ME' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'MK' | 'RO' | 'RU' | 'RW' | 'RE' | 'BL' | 'SH' | 'KN' | 'LC' | 'MF' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'RS' | 'SC' | 'SL' | 'SG' | 'SX' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'SS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'UM' | 'US' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'AX', nullable
    - `swift_code_bic` string, nullable
    - `swift_account_holder_name` string, nullable
    - `swift_account_number_iban` string, nullable
    - `transfers_account` string, nullable
    - `transfers_type` 'CVU' | 'CBU' | 'ALIAS', nullable
    - `bank_account_id` string, nullable
    - `payable_id` string, nullable — The payable this payout executes, when it pays a payable instead of a bank account.
    - `has_virtual_account` boolean, nullable — Has virtual account
    - `sender_legal_name` string, nullable — Legal name of the sending instance (originator), shown on the receipt

## Other responses

- `400` — Possible error codes: `VALIDATION_FAILED`. See the Error responses section for retry semantics.
- `401` — Possible error codes: `AUTH_UNAUTHORIZED`. See the Error responses section for retry semantics.
- `403` — Possible error codes: `AUTH_FORBIDDEN`. See the Error responses section for retry semantics.
- `429` — Possible error codes: `AUTH_RATE_LIMITED`. See the Error responses section for retry semantics.
- `500` — Possible error codes: `INTERNAL_ERROR`. See the Error responses section for retry semantics.

---

[API](https://skmtc.dev/blindpay/apis/blindpay-api.md) · [All operations](https://skmtc.dev/blindpay/apis/blindpay-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/blindpay/blindpay-api/revisions/470de27afb7b/schema)