Sign in

v1

latestOpenAPI 3.0.02026-07-26167441.9 MB

Create Payout

post/payouts

Request body

account_idstring required

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

merchant_referencestring required

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

descriptionstring

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

country'AR' | 'BO' | 'BR' | 'CL' | 'CO' | 'CR' | 'EC' | 'SV' | 'GT' | 'HN' | 'MX' | 'NI' | 'PA' | 'PY' | 'PE' | 'US' | 'UY' required

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

purpose'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' required

Indicates the purpose for the payout. Possible enum values: Check the <a href='https://docs.y.uno/reference/the-payout-object#purposes-list'>Purpose list</a>.

Response

201

OR
OR
OR
OR

Example response

{
  "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"
    }
  },
  "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",
      "description": "Test",
      "amount": {
        "currency": "BRL",
        "value": 100
      },
      "withdrawal_method": {
        "type": "ASTROPAY_PAYOUT",
        "detail": {
          "wallet": {
            "code": "h15sg84U6rCl"
          }
        }
      },
      "provider_data": {
        "id": "ASTROPAY",
        "transaction_id": "32373",
        "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"
    }
  ]
}