Sign in
Payouts

Create Payout on Stellar

post/v1/instances/{instance_id}/payouts/stellar

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

quote_idstring required
signed_transactionstring nullable

Signed transaction

sender_wallet_addressstring required

Payout wallet address

Example request

{
  "quote_id": "qu_000000000000",
  "signed_transaction": "AAA...Zey8y0A",
  "sender_wallet_address": "0x123...890"
}

Response

Payout started with success

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

Payout general status

sender_wallet_addressstring required

Payout wallet address

billing_fee_amountnumber nullable

Billing fee in cents (charged via invoice at the end of the month)

transaction_fee_amountnumber nullable

Transaction fee in cents (percentage-based fee)

partner_feeinteger

Payout partner fee amount in cents (can be negative for rebates)

customer_idstring nullable
bank_account_idstring nullable
offramp_wallet_idstring nullable
payable_idstring nullable

The payable this payout executes, when it pays a payable instead of a bank account.

Example response

{
  "id": "pa_000000000000",
  "status": "processing",
  "sender_wallet_address": "0x123...890",
  "billing_fee_amount": 50,
  "transaction_fee_amount": 100,
  "partner_fee": -25000,
  "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_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_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_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_documents": {
    "step": "processing",
    "status": "waiting_documents",
    "reviewed_by": "compliance@example.com",
    "completed_at": "2011-10-05T14:48:00.000Z"
  },
  "customer_id": "re_000000000000",
  "bank_account_id": "ba_000000000000",
  "offramp_wallet_id": "ow_000000000000",
  "payable_id": "pb_000000000000"
}

Changes

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