Create a Payout Deal

post

https://secure.sandbox.platcore.io/deals/payout

This endpoint creates a new payout deal, initiating a transfer of funds to a specified recipient.
The deal requires details such as the currency, amount, and recipient information.
Upon success, a response containing the deal ID and status will be returned.
Ensure that all required fields are included in the request body.

Body Params

currency

string

required

ID or SYMBOL from currencies helper.

amount

number

required

The amount to be transferred in the specified currency.

currencyTo

string

required

ID or SYMBOL from currencies helper for the target currency.

ttl

number

Deal time-to-live in queue. Default: 20 minutes.

ttl_unit

string

enum

Defaults to sec

Unit for TTL. Default: seconds.

Allowed:

invoiceId

string

required

Merchant reference for the invoice.

src_amount

number

Reference amount in the source transaction currency, used for cross-exchange settlement.

clientId

string

required

Merchant reference for the client.

finalAmount

number

Optional final amount for pre-charge rate lock.

recipient

object

sender_name

string

required

The name of the sender initiating the payout.

baseCurrency

string

enum

Defaults to crypto

Base currency for deal calculation. Default: Crypto.

Allowed:

fiatLiquidity

boolean

Indicates whether fiat liquidity is available.

feesStrategy

string

enum

The strategy for applying fees: 'add' or 'subtract'.

Allowed:

refundAvailable

boolean

Indicates whether refunds are available for this deal.

Headers

Authorization

string

required

Bearer token for authenticating the request. Example: Authorization: Bearer 123.

Responses

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "status": "new"
}

{
  "error": "ERROR_ACCESS_TOKEN_INVALID",
  "message": "Access token is invalid.",
  "statusCode": 400
}

{
  "error": "ERROR_TOKEN_EXPIRED",
  "message": "Access token has expired.",
  "statusCode": 401
}

{
  "error": "DEAL_ALREADY_EXISTS",
  "message": "Deal with same invoiceId already exists.",
  "statusCode": 409
}

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successfully created a new payout deal. Example response: JSON

400Invalid request, typically due to a missing or malformed parameter. Example response: JSON

401Authentication failed. This may happen due to the following reasons: Authentication is required but not provided. The access token has expired. Example response: JSON

409Conflict occurred because a deal with the same invoice ID already exists. Example response: JSON