---
title: "POST /api/Payout"
method: POST
path: "/api/Payout"
tags: ["Payout"]
---

# POST /api/Payout

`POST /api/Payout`

## Request

- Base URL: `https://payout-api.stage.bamboopayment.com`
- URL: `https://payout-api.stage.bamboopayment.com/api/Payout`
- Auth: API key in header `Authorization` and API key in header `DigitalSignature`

## Request body

- CreatePayoutRequest
  - `country` string, nullable
  - `amount` integer
  - `currency` string, nullable
  - `destinationCurrency` string, nullable
  - `reason` string, nullable
  - `reference` string, nullable
  - `type` 0 | 1 | 2 | 3 | 4 | 5
  - `payee` Payee
    - `firstName` string, nullable
    - `lastName` string, nullable
    - `companyName` string, nullable
    - `email` string, nullable
    - `phone` string, nullable
    - `address` string, nullable
    - `location` PhysicalLocation
      - `city` string, nullable
      - `address` string, nullable
      - `zipCode` string, nullable
    - `document` Document
      - `type` string, nullable
      - `number` string, nullable
    - `bankAccount` BankAccount
      - `number` string, nullable
      - `swift` string, nullable
      - `type` 1 | 2
      - `codeBank` string, nullable
      - `nameBank` string, nullable
      - `branch` string, nullable
    - `birthDay` string, date-time, nullable
    - `nationalityCode` string, nullable
  - `instantPaymentData` object, nullable
  - `notification_Url` string, nullable
  - `metadata` unknown
  - `remmiter` Remmiter
    - `firstName` string, nullable
    - `lastName` string, nullable
    - `companyName` string, nullable
    - `birthDay` string, date-time, nullable
    - `location` PhysicalLocation
      - `city` string, nullable
      - `address` string, nullable
      - `zipCode` string, nullable
    - `countryIsoCode` string, nullable

## Response `200`

Success

- CreatePayoutResponse
  - `payoutId` integer
  - `status` integer
  - `statusDescription` string, nullable
  - `reference` string, nullable
  - `error` Error
    - `errorCode` integer
    - `message` string, nullable

## Other responses

- `400`: Bad Request
- `401`: Unauthorized

---

[API](https://skmtc.dev/bamboopayment/apis/payoutapi-public.md) - [All operations](https://skmtc.dev/bamboopayment/apis/payoutapi-public/llms.txt) - [OpenAPI document](https://skmtc.dev/bamboopayment/apis/payoutapi-public/revisions/4434fe6b3fa6?raw)