🔀Send a Payout

Send customers or clients crypto from your balance. Send a single crypto, or multiple, using the Payouts Dashboard or via API.

Send a Payout via API

Prerequisites

• Access granted by the Swapped team.

• Generate an API Key with private key signing capabilities, learn more about Client Key API Access.

Payout Balances

Payouts assume that you have the necessary balance of the relevant crypto tokens to disburse. You can swap to the relevant cryptocurrency from the Swapped Commerce > Balances dashboard.

Examples

Sample single crypto payout:

POST https://pay-api.swapped.com/v1/payouts

sample data:

{
  payouts: [
    {
      chain: "polygon",
      currency: "USDT",
      amount: "250.00",
      memo: "", // optional
      address: "0x0123456789..."
      customerName: "John Doe",
      customerEmail: "[email protected]"
      // Optional 
      kyc: {
        addressLine1: "2200 Pioneer Ave",
        addressLine2: "",
        city: "Cheyenne",
        country: "US", // 2-digit country codes
        postalCode: "82001",
        region: "WY",
        taxId: "0102030405"
      }
    }
  ]
}

sample response:

{
  "success": true,
  "message": "success",
  "data": {
    "payoutGroupId": "15a139b6-7237-2be1-845a-f271dd0200a6",
    "payouts": [
      {
        "payoutId": "fa10a2ex-2de1-4b76-95c9-4bd2d88fff25",
        "settlementId": "12991754-abl2-4152-ac25-914fwe1344fo"
      }
    ]
  }
}

Sample multi-crypto payout:

POST https://pay-api.swapped.com/v1/payouts

{
  payouts: [
    {
      chain: "polygon",
      currency: "USDT",
      amount: "20.00",
      memo: "",
      address: "0x0123456789..."
      customerName: "John Doe",
      customerEmail: "[email protected]"
      kyc: { ... }
    },
    {
      chain: "ethereum",
      currency: "USDC",
      amount: "200.00",
      memo: "",
      address: "0x0123456789..."
      customerName: "Navn Navnesen",
      customerEmail: "[email protected]"
      kyc: { ... }
    },
    { ... }
  ]
}

Create payouts

post

Authorizations

apiKey

X-API-KeystringRequired

Body

application/json

Responses

200

Successful

*/*

post

/v1/payouts

HTTPcURLJavaScriptPython

POST /v1/payouts HTTP/1.1
Host: pay-api.swapped.com
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 279

{
  "payouts": [
    {
      "blockchain": "text",
      "currency": "text",
      "amount": "text",
      "memo": "text",
      "address": "text",
      "customerName": "text",
      "customerEmail": "text",
      "kyc": {
        "taxId": "text",
        "addressLine1": "text",
        "addressLine2": "text",
        "city": "text",
        "region": "text",
        "country": "text",
        "postalCode": "text"
      }
    }
  ]
}

200

Successful

{
  "data": {
    "payoutGroupId": "text",
    "payouts": [
      {
        "payoutId": "text",
        "settlementId": "text"
      }
    ]
  },
  "message": "text",
  "success": true
}

Notes