Payouts
Retrieve Payouts
get/v1/instances/{instance_id}/payouts
Path parameters
instance_idstring required
Example:in_000000000000
Query parameters
limit'10' | '50' | '100' | '200' | '500' | '1000'
Number of items to return
Example:50
offset'0' | '10' | '50' | '100' | '200' | '500' | '1000'
Number of items to skip
Example:0
starting_afterstring
A cursor for use in pagination. starting_after is an object ID that defines your place in the list.
Example:pi_123
ending_beforestring
A cursor for use in pagination. ending_before is an object ID that defines your place in the list.
Example:pi_123
customer_idstring
Example:re_000000000000
status'processing' | 'failed' | 'refunded' | 'completed' | 'on_hold'
customer_namestring
bank_account_idstring
countrystring
payment_method'wire' | 'ach' | 'pix' | 'pix_safe' | 'ted' | 'spei_bitso' | 'transfers_bitso' | 'ach_cop_bitso' | 'international_swift' | 'rtp' | 'sepa'
networkstring
tokenstring
Response
List payouts with pagination and filtering
Example response
{
"data": [
{
"customer_id": "re_000000000000",
"id": "pa_000000000000",
"status": "processing",
"sender_wallet_address": "0x123...890",
"signed_transaction": "AAA...Zey8y0A",
"quote_id": "qu_000000000000",
"instance_id": "in_000000000000",
"partner_fee": -25000,
"tracking_transaction": {
"step": "processing",
"status": "failed",
"transaction_hash": "0x123...890",
"completed_at": "2011-10-05T14:48:00.000Z",
"provider_transaction_id": "67c12eae-b7bc-31cc-a5ef-623dcea82346",
"provider_error_reason": "erc20_allowance_insufficient"
},
"tracking_payment": {
"step": "on_hold",
"provider_name": "HSBC",
"provider_integration": "zenus",
"provider_transaction_id": "0x123...890",
"provider_status": "canceled",
"provider_error_reason": "invalid_key",
"provider_uetr": "37d10eff-d450-4aba-a5d4-e3978f5a3343",
"provider_imad": "20260526MMQFMP2M008120",
"provider_reference": "2084734238TC",
"provider_clearing_system": "FED",
"forced_provider": "veem",
"recipient_name": "John Doe",
"recipient_tax_id": "123.456.789-10",
"recipient_bank_code": "00416968",
"recipient_branch_code": "0001",
"recipient_account_number": "1234567890",
"recipient_account_type": "checking",
"coelsa_id": "1LMP68NKV46DRDYK2R7OEV",
"end_to_end_id": "E20018183202603311320vm6ALFpJpsS",
"estimated_time_of_arrival": "5_min",
"completed_at": "2011-10-05T14:48:00.000Z",
"refund_review_reason": "amount_threshold",
"refund_review_detected_at": "2011-10-05T14:48:00.000Z",
"refund_review_actioned_at": "2011-10-05T14:48:00.000Z"
},
"tracking_liquidity": {
"step": "processing",
"provider_transaction_id": "0x123...890",
"provider_status": "deposited",
"estimated_time_of_arrival": "1_business_day",
"completed_at": "2011-10-05T14:48:00.000Z"
},
"tracking_complete": {
"step": "on_hold",
"status": "tokens_refunded",
"refund_reason": "fiat_payment_failed",
"transaction_hash": "0x123...890",
"provider_transaction_id": "67c12eae-b7bc-31cc-a5ef-623dcea82346",
"completed_at": "2011-10-05T14:48:00.000Z"
},
"tracking_documents": {
"step": "processing",
"status": "waiting_documents",
"reviewed_by": "compliance@example.com",
"completed_at": "2011-10-05T14:48:00.000Z"
},
"jpm_track_data": {
"jpm_trace_number": "317802200000565",
"jpm_processing_status": "Completed",
"extended_tracking_status": "Delivered to next bank",
"jpm_reference_number": "9483400364JO",
"uetr": "4ad5f98a-5279-410a-99a2-39a729aceb35",
"fed_imad": "1230MMQFMP2L034796",
"payment_date": "Dec 30 2025",
"payment_amount": "3,914.00",
"payment_currency": "USD"
},
"cpn_payment_id": "f06dbc45-58a4-389f-beb8-581c3fafff3c",
"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.",
"network": "sepolia",
"token": "USDC",
"description": "Memo code or description, only works with USD and BRL",
"sender_amount": 1010,
"receiver_amount": 5240,
"partner_fee_id": "pf_000000000000",
"partner_fee_amount": 150,
"commercial_quotation": 495,
"blindpay_quotation": 485,
"total_fee_amount": 1.5,
"customer_local_amount": 1000,
"currency": "BRL",
"transaction_fee_amount": 100,
"billing_fee_amount": 50,
"transaction_document_file": "https://example.com/image.png",
"transaction_document_type": "invoice",
"transaction_document_id": "1234567890",
"name": "Bank Account Name",
"type": "wire",
"pix_key": "14947677768",
"pix_safe_bank_code": "00416968",
"pix_safe_branch_code": "0001",
"pix_safe_cpf_cnpj": "12345678901",
"ted_bank_code": "033",
"ted_branch_code": "0001",
"ted_cpf_cnpj": "12345678901",
"account_number": "1001001234",
"routing_number": "012345678",
"country": "US",
"account_class": "individual",
"address_line_1": "Address line 1",
"address_line_2": "Address line 2",
"city": "City",
"state_province_region": "State/Province/Region",
"postal_code": "Postal code",
"account_type": "checking",
"ach_cop_beneficiary_first_name": "Fernando",
"ach_cop_bank_account": "12345678",
"ach_cop_bank_code": "051",
"ach_cop_beneficiary_last_name": "Guzman Alarcón",
"ach_cop_document_id": "1661105408",
"ach_cop_document_type": "CC",
"ach_cop_email": "fernando.guzman@gmail.com",
"beneficiary_name": "Individual full name or business name",
"spei_clabe": "5482347403740546",
"spei_protocol": "clabe",
"spei_institution_code": "40002",
"swift_beneficiary_country": "MX",
"swift_code_bic": "123456789",
"swift_account_holder_name": "John Doe",
"swift_account_number_iban": "123456789",
"transfers_account": "BM123123123123",
"transfers_type": "CVU",
"bank_account_id": "ba_000000000000",
"payable_id": "pb_000000000000",
"has_virtual_account": true,
"sender_legal_name": "LRB TRADING INVESTMENT L.L.C"
}
],
"pagination": {
"has_more": true,
"next_page": "pi_123",
"prev_page": "pi_123"
}
}Changes
No recorded changes to this endpoint across all 1 revision of this API.