Request a payout

Initiates a payout request for the specified account.

Request
Security:
tilia_auth (write_process_credits)
path Parameters
account_id
required
string <UUID4>

Account ID for the account requesting the payout

Request Body schema: application/json

Payout resource

source_payment_method_id
required
string <UUID4>

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 <UUID4>

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 PayPal 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.

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.

Responses
201

Successfully requested payout

400

Invalid input

401

Unauthorized access.

500

Service unavailable or server error.

post/v2/{account_id}/payout
Request samples
application/json
{
  • "source_payment_method_id": "d3da84e7-a203-4453-a016-407e91eeeeee",
  • "destination_payment_method_id": "4ba04731-9f66-4123-a8a1-7ef815444444",
  • "amount": 250,
  • "currency": "USD"
}
Response samples
application/json
{
  • "status": "Success",
  • "message": null,
  • "codes": null,
  • "payload": {
    }
}