# Create Manual Payout

Request to create a manual payout for a merchant. Merchants can only request manual payouts if they have a sufficient available balance.
This call requires manual payouts to be enabled for the merchant.

Endpoint: POST /transactions/payouts
Version: 3.0
Security: Marketplace API Key | Merchant Secret Token | Admin JWT | Merchant JWT | Marketplace JWT

## Header parameters:

  - `Merchant-Id` (string)
    Perform operation in the context of the given merchant. Usually not required — specify only if acting on behalf of a merchant not implied by the credentials specified in the Authorization header.

## Request fields (application/json):

  - `currency` (string, required)
    The currency of the payout as a 3 letter ISO code. Currently foreign exchange is not supported. The currency must match the trading currency of the merchant.

  - `payoutAmount` (integer, required)
    The amount credited towards the payout in minor currency units

  - `externalAccountId` (string)
    System unique identifier for a bank account to credit. If not specified, the merchant's primary bank account will be used.

  - `statementDescriptor` (string, required)
    Information about the payout that will appear on the customer's bank statement.

  - `paymentChannels` (array)
    The payment channels to use for the payout. If more than one is specified, they will be attempted in the order given.
    Enum: "direct_entry", "npp"

  - `feePayingMerchantId` (string)
    System unique identifier for the merchant to charge the payout fee to. The merchant receiving the payout is used by default.

## Response 200 fields (application/json):

  - `payoutId` (string, required)
    System unique identifier for the payout.

  - `referencePayoutId` (string)
    Identifier for payout that merchants can use.

  - `currency` (string, required)
    The currency of the payout as a 3 letter ISO code.

  - `settlementDate` (string)
    The date the payout was settlement with the merchant.

  - `merchantId` (string, required)
    System unique identifier for the merchant issued the payout.

  - `merchantBusinessName` (string, required)
    Business name for the merchant issued the payout.

  - `amount` (integer, required)
    The amount credited towards the payout in minor currency units

  - `openingBalance` (integer, required)
    The opening balance of the merchant account before the payout was settled in minor currency units.
Will usually be 0 but will be negative if the merchant account has a negative balance from a previous payout.

  - `closingBalance` (integer, required)
    The closing balance of the merchant account after payout has settled in minor currency units.
Will usually be 0 but will be negative if the merchant account has a negative balance.

  - `totalAmount` (integer, required)
    The amount paid out or the closing balance if the merchant account has a negative balance in minor currency units.

  - `status` (string, required)
    Status of the invoice.
    Enum: "created", "pending", "paid", "in_transit", "canceled", "failed", "reversed", "suspended"

  - `bankAccountNumber` (string)
    The bank account number the payout was sent to.

  - `paymentChannel` (string)
    The payment channel to use for the payout.
    Enum: "direct_entry", "npp"

  - `statementDescriptor` (string)
    Information about the payout that will appear on the customer's bank statement.

  - `createdAt` (string, required)
    When the payout was created.

## Response 400 fields (application/json):

  - `statusCode` (integer, required)
    HTTP status code for this error

  - `errorCode` (string, required)
    An April code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.

  - `message` (string, required)
    Human readable description of the error

  - `tracer` (string)
    An unique identifier for the request. Provide this to the support team if you wish to query a particular error.

  - `detail` (string)
    Optional additional details for the error.

  - `errorTypeDescription` (string)
    A description of the category of errors for the given statusCode.

  - `metadata` (any)
    Optional key value list of metadata

## Response 401 fields (application/json):

  - `statusCode` (integer, required)
    HTTP status code for this error

  - `errorCode` (string, required)
    An April code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.

  - `message` (string, required)
    Human readable description of the error

  - `tracer` (string)
    An unique identifier for the request. Provide this to the support team if you wish to query a particular error.

  - `detail` (string)
    Optional additional details for the error.

  - `errorTypeDescription` (string)
    A description of the category of errors for the given statusCode.

  - `metadata` (any)
    Optional key value list of metadata

## Response 403 fields (application/json):

  - `statusCode` (integer, required)
    HTTP status code for this error

  - `errorCode` (string, required)
    An April code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.

  - `message` (string, required)
    Human readable description of the error

  - `tracer` (string)
    An unique identifier for the request. Provide this to the support team if you wish to query a particular error.

  - `detail` (string)
    Optional additional details for the error.

  - `errorTypeDescription` (string)
    A description of the category of errors for the given statusCode.

  - `metadata` (any)
    Optional key value list of metadata

## Response 404 fields (application/json):

  - `statusCode` (integer, required)
    HTTP status code for this error

  - `errorCode` (string, required)
    An April code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.

  - `message` (string, required)
    Human readable description of the error

  - `tracer` (string)
    An unique identifier for the request. Provide this to the support team if you wish to query a particular error.

  - `detail` (string)
    Optional additional details for the error.

  - `errorTypeDescription` (string)
    A description of the category of errors for the given statusCode.

  - `metadata` (any)
    Optional key value list of metadata

## Response 405 fields (application/json):

  - `statusCode` (integer, required)
    HTTP status code for this error

  - `errorCode` (string, required)
    An April code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.

  - `message` (string, required)
    Human readable description of the error

  - `tracer` (string)
    An unique identifier for the request. Provide this to the support team if you wish to query a particular error.

  - `detail` (string)
    Optional additional details for the error.

  - `errorTypeDescription` (string)
    A description of the category of errors for the given statusCode.

  - `metadata` (any)
    Optional key value list of metadata

## Response 406 fields (application/json):

  - `statusCode` (integer, required)
    HTTP status code for this error

  - `errorCode` (string, required)
    An April code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.

  - `message` (string, required)
    Human readable description of the error

  - `tracer` (string)
    An unique identifier for the request. Provide this to the support team if you wish to query a particular error.

  - `detail` (string)
    Optional additional details for the error.

  - `errorTypeDescription` (string)
    A description of the category of errors for the given statusCode.

  - `metadata` (any)
    Optional key value list of metadata

## Response 409 fields (application/json):

  - `statusCode` (integer, required)
    HTTP status code for this error

  - `errorCode` (string, required)
    An April code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.

  - `message` (string, required)
    Human readable description of the error

  - `tracer` (string)
    An unique identifier for the request. Provide this to the support team if you wish to query a particular error.

  - `detail` (string)
    Optional additional details for the error.

  - `errorTypeDescription` (string)
    A description of the category of errors for the given statusCode.

  - `metadata` (any)
    Optional key value list of metadata

## Response 422 fields (application/json):

  - `statusCode` (integer, required)
    HTTP status code for this error

  - `errorCode` (string, required)
    An April code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.

  - `message` (string, required)
    Human readable description of the error

  - `tracer` (string)
    An unique identifier for the request. Provide this to the support team if you wish to query a particular error.

  - `detail` (string)
    Optional additional details for the error.

  - `errorTypeDescription` (string)
    A description of the category of errors for the given statusCode.

  - `metadata` (any)
    Optional key value list of metadata

## Response 429 fields (application/json):

  - `statusCode` (integer, required)
    HTTP status code for this error

  - `errorCode` (string, required)
    An April code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.

  - `message` (string, required)
    Human readable description of the error

  - `tracer` (string)
    An unique identifier for the request. Provide this to the support team if you wish to query a particular error.

  - `detail` (string)
    Optional additional details for the error.

  - `errorTypeDescription` (string)
    A description of the category of errors for the given statusCode.

  - `metadata` (any)
    Optional key value list of metadata

## Response 500 fields (application/json):

  - `statusCode` (integer, required)
    HTTP status code for this error

  - `errorCode` (string, required)
    An April code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.

  - `message` (string, required)
    Human readable description of the error

  - `tracer` (string)
    An unique identifier for the request. Provide this to the support team if you wish to query a particular error.

  - `detail` (string)
    Optional additional details for the error.

  - `errorTypeDescription` (string)
    A description of the category of errors for the given statusCode.

  - `metadata` (any)
    Optional key value list of metadata

## Response 503 fields (application/json):

  - `statusCode` (integer, required)
    HTTP status code for this error

  - `errorCode` (string, required)
    An April code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.

  - `message` (string, required)
    Human readable description of the error

  - `tracer` (string)
    An unique identifier for the request. Provide this to the support team if you wish to query a particular error.

  - `detail` (string)
    Optional additional details for the error.

  - `errorTypeDescription` (string)
    A description of the category of errors for the given statusCode.

  - `metadata` (any)
    Optional key value list of metadata