Create Payout

Send money to a bank account, card, or wallet.

POSThttps://api.uprails.com/payouts/create

Creates a new payout to send funds to an external destination. The payout will be processed based on the specified priority and processor availability.

Processor Selection

Uprails automatically selects the best available payment processor based on the destination, amount, and priority. You can also specify a preferred processor.

Request Example

curl -X POST https://api.uprails.com/payouts/create \
  -H "Content-Type: application/json" \
  -H "api-key: snd_YOUR_API_KEY" \
  -d '{
    "amount": 10000,
    "currency": "USD",
    "profile_id": "YOUR_PROFILE_ID",
    "payout_type": "bank",
    "priority": "regular",
    "customer_id": "cus_abc123",
    "email": "recipient@example.com",
    "name": "John Doe",
    "payout_method_data": {
      "bank": {
        "bank_name": "Chase",
        "bank_account_number": "123456789",
        "bank_routing_number": "021000021",
        "bank_account_holder_name": "John Doe"
      }
    }
  }'

Request Body

amountintegerrequired

Amount in the smallest currency unit (e.g., cents)

currencystringrequired

Three-letter ISO currency code

profile_idstringrequired

The identifier for the business profile associated with this payout.

payout_typestringrequired

Type of payout

Enum:cardbankwallet

prioritystringdefault: regular

Payout priority/speed

Enum:instantfastregularwire

customer_idstring

Customer ID to associate with this payout

emailstring

Recipient email address

namestring

Recipient name

phonestring

Recipient phone number

payout_method_dataobjectrequired

Payout destination details

cardobject

Card details for card payouts

bankobject

Bank account details for bank payouts

billingobject

Billing address information

confirmbooleandefault: true

Whether to confirm the payout immediately

metadataobject

Set of key-value pairs for storing additional information

Response

200OK

{
  "payout_id": "po_1234567890abcdef",
  "merchant_id": "mer_xyz789",
  "customer_id": "cus_abc123",
  "status": "pending",
  "amount": 10000,
  "currency": "USD",
  "payout_type": "bank",
  "priority": "regular",
  "email": "recipient@example.com",
  "name": "John Doe",
  "created": "2024-01-15T10:00:00Z"
}

Card Payout Example

Card Payout Requestjson

{
  "amount": 5000,
  "currency": "USD",
  "payout_type": "card",
  "priority": "instant",
  "payout_method_data": {
    "card": {
      "card_number": "4242424242424242",
      "card_exp_month": "12",
      "card_exp_year": "2025",
      "card_holder_name": "John Doe"
    }
  }
}