Create New Payout

Create a new payout

POST /api/payout

Headers

Name
Type
Description

X-ApiKey*

String

Merchant API key provide by DCX

X-ApiSecret*

String

Merchant API secret provide by DCX

Request Body

Name
Type
Description

customer_id*

String

Customer short ID.

Example: WlgXhMXPBj

account_id*

String

Customer account ID.

Example: 63e06495d28b3b3f1a5b0c64

amount*

Number

Amount in cent.

Example: 1111

asset*

String

Payout asset.

Example: AUD

name*

String

Title of this payout.

Example: Payout for David

description

String

Payout description.

Example: this is a payment

reference*

String

For customer description. What customer sees.

Example: Hi David! Here is your payment :)

{
  "status": "ok",
  "message": "payout successfully",
  "payout": {
    "status": "scheduled",
    "payout_id": "63ea03feba1289cb3fe751e3",
    "received_time": 1676280833
  }
}
PreviousGet Customer Payout AccountsNextCreate New Payout (Bank account)

Last updated