Nothing Found

Request a payout

Initiates a payout request for the specified account.

Securitytilia_auth
Request
path Parameters
account_id
required
string (AccountId) <= 36 characters

Account ID for the account requesting the payout

Example: acct_2TiDFXHVFMlAuyy7ovvz3YPKv9b
Request Body schema: application/json
required

Payout resource

source_payment_method_id
required
string <= 36 characters

The id for the payment method from which the funds are to be transferred. The provider for this payment method must be wallet (e.g. the account's USD wallet).

destination_payment_method_id
required
string <= 36 characters

The id for the payment method to which the funds are to be transferred. Typically, this value is returned by the Payout flow. This payment method must be associated with a payout-supported payment method (Paypal or ACH-supported bank account)

amount
required
integer

The amount requested to be paid out. Specified in the lowest denomination of the currency. For example, if currency is USD, an amount of $3.42 is represented as '342'. A payout fee is calculated and the actual amount to be paid out is returned in the response payload. Note that if token_exchange_id is specified, then this field will be ignored and the user received amount specified in the token conversion will be used instead.

currency
required
string [ 3 .. 10 ] characters

A currency code. May be either an ISO 4217 currency code, or a code representing your in-game token. Must be a supported currency.

token_exchange_id
string <= 36 characters

The TUID of a token exchange ID representing a previous token conversion. This associates the payout with this token conversion, so that if the payout is canceled then the token conversion will be reversed.

Responses
201

Successfully creates a payout with status FUNDS-IN-ESCROW that will be subject to review

400

Invalid input

401

Unauthorized access.

429

Too many payouts requested

500

Service unavailable or server error.

post/v2/{account_id}/payout
Request samples
application/json
{
  • "source_payment_method_id": "pm_2V2bA0r2hJpUnCA9HeTgOl0rONr",
  • "destination_payment_method_id": "pm_2V2bA0r2hJpUnCA9HeTgOl0rONr",
  • "amount": 250,
  • "currency": "string",
  • "token_exchange_id": "vtok_2V2WX4AZZiE6eDoGb6coN0RuxIR"
}
Response samples
application/json
{
  • "status": "Success",
  • "message": null,
  • "codes": null,
  • "payload": {
    }
}