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.

SecurityMarketplace API Key | Merchant Secret Token | Admin JWT | Merchant JWT | Marketplace JWT

Request

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 Body schema: application/json
required

currency required	string 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 required	integer <int64> 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 required	string Information about the payout that will appear on the customer's bank statement.
paymentChannels	Array of strings (PaymentChannel) The payment channels to use for the payout. If more than one is specified, they will be attempted in the order given. Items 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.

Responses

200

400

401

403

404

405

406

409

422

429

500

503

post/transactions/payouts

Request samples

Payload
Curl
JavaScript

application/json

{"currency": "AUD",
"payoutAmount": 0,
"externalAccountId": "xacc_aTm56_ym1jZ_uS-g",
"statementDescriptor": "string",
"paymentChannels": ["direct_entry"
],
"feePayingMerchantId": "mcht_aTm56vym1jZ_uS-M"
}

Response samples

application/json

{"payoutId": "payout_aTm56vym1jZ_uS-Y",
"referencePayoutId": "string",
"currency": "string",
"settlementDate": "2019-08-24",
"merchantId": "mcht_aTm56vym1jZ_uS-M",
"merchantBusinessName": "string",
"amount": 0,
"openingBalance": 0,
"closingBalance": 0,
"totalAmount": 0,
"status": "created",
"bankAccountNumber": "string",
"paymentChannel": "direct_entry",
"statementDescriptor": "string",
"createdAt": "2019-08-24T14:15:22Z"
}