Payout

Payout is the way that merchant have to give a certain amount to a customer in a voucher.

Payout Object

Field
Type
Description

id

string

Unique identifier for the object.

public_address

string

Customer public address on voucher api.

recipient_name

string

Customer’s name.

source

string

ID of the voucher that was generated as payout result

created_at

int

Timestamp that represent once the payout was created.

amount

int

Value of the payout voucher generated the same received on the request in the minor currency.

currency

string

Iso code 3 representing the currency code the same received on the request.

metadata

hash

A set of key-value pairs attached to a payout object. It can be useful for storing additional information about the payout in a structured format.

account_id

string

ID of the customer in merchant side.

status

enum

The status of the charge is either “succeeded”, “pending”, or “failed”.

deposit

bool

True if the voucher is for a deposit.

livemode

bool

Indicator about if the object if for production or test.

{
	"id": "AW-kLcRRC5P8U68CYe0kVA",
	"public_address": "mwVXtJA1DUhZFbkzxKQsXLej9vdFh9b9eH",
	"source": "AW-kLcRbx6KXBv7B3CF8uw",
	"created_at": 1579007460,
	"amount": 10000,
	"currency": "EUR",
	"recipient_name": "John Doe",
	"account_id": "merchant_account_id",
	"metadata": {
		"trans_id": "123456789"
	},
	"livemode": false
}

Last updated