Skip to main content
POST
/
payouts
curl --request POST \
  --url https://api-sandbox.y.uno/v1/payouts \
  --header 'Content-Type: application/json' \
  --header 'private-secret-key: <api-key>' \
  --header 'public-api-key: <api-key>' \
  --data '
{
  "account_id": "{{account_id}}",
  "merchant_reference": "MR-Test-123",
  "description": "Test",
  "country": "US",
  "purpose": "EXPENSES",
  "amount": {
    "currency": "USD",
    "value": 100
  },
  "beneficiary": {
    "merchant_beneficiary_id": "test_merchant_deposit_id",
    "country": "US",
    "national_entity": "INDIVIDUAL",
    "first_name": "John",
    "last_name": "Doe",
    "legal_name": "John Doe",
    "email": "john.doe@email.com",
    "date_of_birth": "1980-01-01",
    "document": {
      "document_type": "SSN",
      "document_number": "123-45-6789"
    },
    "phone": {
      "country_code": "1",
      "number": "1234567890"
    },
    "address": {
      "address_line_1": "123 Main St",
      "address_line_2": "Apt 1",
      "city": "New York",
      "state": "NY",
      "zip_code": "10001",
      "country": "US"
    }
  },
  "withdrawal_method": {
    "type": "WALLET",
    "provider_id": "NEQUI",
    "detail": {
      "wallet": {
        "code": "h15sg84U6rCl"
      }
    }
  },
  "metadata": [
    {
      "key": "key1",
      "value": "value1"
    },
    {
      "key": "key2",
      "value": "value2"
    }
  ]
}
'
{
  "id": "5223d101-0019-43d3-92cb-5c23391a7410",
  "account_id": "f7c5fe77-721b-49c2-84d3-957748df3c2c",
  "status": "SUCCEEDED",
  "merchant_reference": "MR-Test-123",
  "purpose": "EXPENSES",
  "country": "BR",
  "description": "Test",
  "amount": {
    "currency": "BRL",
    "value": 100
  },
  "beneficiary": {
    "merchant_beneficiary_id": "test_merchant_deposit_id",
    "national_entity": "INDIVIDUAL",
    "first_name": "John",
    "last_name": "Doe",
    "legal_name": "John Doe",
    "email": "john.doe@email.com",
    "country": "BR",
    "date_of_birth": "1980-01-01",
    "document": {
      "document_type": "CPF",
      "document_number": "123456789"
    },
    "phone": {
      "country_code": "55",
      "number": "1234567890"
    },
    "address": {
      "address_line_1": "123 Main St",
      "address_line_2": "Apt 1",
      "country": "US",
      "state": "NY",
      "city": "New York",
      "zip_code": "10001"
    }
  },
  "metadata": [],
  "created_at": "2024-05-27T15:12:22.712914616Z",
  "updated_at": "2024-05-27T15:12:22.712916116Z",
  "transactions": [
    {
      "id": "f0642eb0-31cb-44bc-9dc6-03d55ff4d664",
      "status": "SUCCEEDED",
      "type": "PAYOUT",
      "response_code": "SUCCEEDED",
      "merchant_reference": "",
      "purpose": "",
      "description": "Test",
      "amount": {
        "currency": "BRL",
        "value": 100
      },
      "withdrawal_method": {
        "type": "ASTROPAY_PAYOUT",
        "detail": {
          "bank_transfer": null,
          "wallet": {
            "code": "h15sg84U6rCl",
            "email": null,
            "country": null,
            "document": null,
            "phone": null
          }
        }
      },
      "provider_data": {
        "id": "ASTROPAY",
        "transaction_id": "32373",
        "account_id": "",
        "beneficiary_id": "test_merchant_deposit_id",
        "status": "APPROVED",
        "status_detail": "APPROVED",
        "raw_response": "{\n  \"cashout_id\" : 32373,\n  \"merchant_cashout_id\" : \"f0642eb0-31cb-44bc-9dc6-03d55ff4d664\",\n  \"status\" : \"APPROVED\",\n  \"user_id\" : \"h15sg84U6rCl\"\n}"
      },
      "created_at": "2024-05-27T15:12:23.022588031Z",
      "updated_at": "2024-05-27T15:12:23.022588361Z"
    }
  ]
}
This request allows you to create a payout to transfer funds from your account to another account or recipient.
Payout Methods GuideTo see test guidelines and beneficiary information details that are needed for each integration, please refer to the Payout Methods guide.

Authorizations

​
public-api-key
string
header
default:<Your public-api-key>
required
​
private-secret-key
string
header
default:<Your private-secret-key>
required

Body

application/json
​
account_id
string
default:{{account_id}}
required

The unique identifier of the account. You find this information on the Yuno dashboard (UUID, 36 chars.).

​
merchant_reference
string
default:test-reference
required

The unique identifier of the merchant's payout (MAX 255; MIN 3).

​
country
enum<string>
required

Country where the transaction must be processed (MAX 2; MIN 2; ISO 3166-1).

Available options:
AR,
BO,
BR,
CL,
CO,
CR,
EC,
SV,
GT,
HN,
MX,
NI,
PA,
PY,
PE,
US,
UY
​
purpose
enum<string>
required

Indicates the purpose for the payout. Possible enum values: Check the Purpose list.

Available options:
FAMILY_AND_FRIENDS,
PERSONAL_TRANSFER,
REMITTANCES,
PROVIDER_SERVICES,
ADVERTISING_SERVICES,
REPRESENTATION_SERVICES,
ADVISORY_SERVICES,
FREELANCER_SERVICES,
SUPPLIER,
BUSINESS_TO_BUSINESS,
MARKETPLACE,
PAYROLL,
GIFTS_AND_BENEFITS,
EXPENSES,
CORPORATE_PAYMENT,
PURCHASE_OF _PHYSICAL_GOODS,
PURCHASE_OF _DIGITAL_GOODS,
PURCHASE_OF_SERVICES,
INVESTMENTS,
CAPITAL_CONTRIBUTION,
INVESTMENTS_SHARES,
TAXES,
LOGISTICS_AND_TRANSPORTATION,
DELIVERY,
AFFILIATION_PROGRAM,
LOANS,
REAL_STATE,
RENT,
TRAVEL_FLIGHTS,
TRAVEL_ACCOMMODATIONS,
EDUCATION,
TUITION_COSTS,
TRAININGS,
CHARITY,
MEDICAL_SERVICES,
SAVINGS,
RETIREMENT,
PENSION,
INSURANCE,
REWARDS,
TRADEMARKS_AND_COPYRIGHT,
ENTERTAINMENT,
GOVERNMENT,
OTHERS
​
amount
object
required

Specifies the payout amount object, with the value and currency.

​
beneficiary
object
required

Specifies the beneficiary object with their identification.

​
withdrawal_method
object
required

The withdrawal method to make the payout.

​
description
string

The description of the payout (MAX 255; MIN 3).

​
metadata
object[]

Specifies a list of metadata objects. You can add up to 50 metadata objects.

Response

201

​
id
string
Example:

"5223d101-0019-43d3-92cb-5c23391a7410"

​
account_id
string
Example:

"f7c5fe77-721b-49c2-84d3-957748df3c2c"

​
status
string
Example:

"SUCCEEDED"

​
merchant_reference
string
Example:

"MR-Test-123"

​
purpose
string
Example:

"EXPENSES"

​
country
string
Example:

"BR"

​
description
string
Example:

"Test"

​
amount
object
​
beneficiary
object
​
metadata
array
​
created_at
string
Example:

"2024-05-27T15:12:22.712914616Z"

​
updated_at
string
Example:

"2024-05-27T15:12:22.712916116Z"

​
transactions
object[]