money
payouts

Get bank payout detail

Returns the multi-stage payout funnel for a bank-payout money movement. Gated on PermKYBLocked.

get/money/payouts/{id}

Path parameters

idstring required

Response

OK

completed_tsstring date-time
created_tsstring date-time
failed_tsstring date-time
idstring
input_amountstring
input_symbolstring
output_amountstring
output_symbolstring
purpose'supplier' | 'payroll' | 'physical_goods' | 'digital_goods' | 'other_services' | 'property_rental' | 'logistics' | 'taxes' | 'insurance' | 'remittances' | 'investment' | 'charity_donation' | 'tuition_costs' | 'medical_care' | 'family_maintenance' | 'pension' | 'utility_provider' | 'public_services' | 'property_purchase' | 'travel' | 'tourism_expense' | 'entertainment' | 'affiliation_programs' | 'rewards' | 'savings_retirement' | 'investment_interest' | 'shares' | 'availability' | 'capital_contribution'
status'pending' | 'processing' | 'paid' | 'failed' required

Changes

Changed in 2 of the 24 revisions of this API.15

    • added the optional property error/api_client_id to the response with the 400 status

      response-optional-property-added

    • added the optional property error/api_client_id to the response with the 401 status

      response-optional-property-added

    • added the optional property error/api_client_id to the response with the 403 status

      response-optional-property-added

    • added the optional property error/api_client_id to the response with the 404 status

      response-optional-property-added

    • added the optional property error/api_client_id to the response with the default status

      response-optional-property-added

    • changed the pattern of the path request parameter id from ^mm_[0-9a-hjkmnp-tv-z]{26}$ to ^mm_[0-7][0-9a-hjkmnp-tv-z]{25}$

      request-parameter-pattern-changed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog