Create Pay Out Request

post

https://openapi.sandbox.xenithpay.com/v1/payouts

You can use this endpoint to create a Pay Out request.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

initiatedAmount

number

required

Requested amount of the transaction in the actual value in the provided currency.

Decimal support depends on the currency. IDR, JPY, KRW and VND do not accept decimal amounts — send whole units only. All other supported currencies accept at most 2 decimal places.

currency

string

required

ISO 4217 three-letter code of the transaction's currency.

destinationPayoutMethod

string

required

Payment method for this transaction. List of supported methods can be found here.

destinationPayoutChannel

string

required

Payment channel for this transaction. List of supported channels can be found here.

destinationPayoutAccount

string

required

Account number of destination.

destinationPayoutAccountName

string

required

Account holder name as per bank records. Must match the registered account name exactly.

referenceCode

string

required

Merchant-provided identifier for this transaction.

customerReference

string

required

Merchant-provided identifier of the Customer for this transaction.

description

string

Free-text field for any additional information.

callbackUrl

string

required

Your webhook URL to receive transaction notifications.

metadata

object

Metadata is required for certain currencies:

INR – requires ifscCode (Indian Financial System Code).
JPY – requires bankBranchName.
KRW – requires mobile and email.

Headers

Xenith-Api-Key

string

required

API Key will be delivered to you by email

Xenith-Request-Timestamp

string

required

ISO 8601 date time format, should be in (UTC+0)

Xenith-Request-Signature

string

required

Refer to page Build Signature and Set Headers for instructions on how to build a signature

X-Idempotency-Key

string

required

A unique key to prevent duplicate requests. Must be unique across all payout transactions for the merchant. Max 100 characters.

Responses

Callback

201Successfully creating pay out request

400Payout creation failed due to failing request validation. See the Create Pay Out Errors dictionary for more detail.

422(no retry) There are insufficient funds to complete the payout transaction. Ensure your account has adequate balance before retrying the payout. See the Create Pay Out Errors dictionary for more detail.

500An unexpected server error occurred. Wait briefly and retry. If the error persists after multiple attempts, contact support. Retrying is safe for this GET operation. See the Create Pay Out Errors dictionary for more detail.