Payout.md

Payout

Properties

Name	Type	Description	Notes
payoutId	Integer	The id of the payout.	[optional]
payeeBankAccountId	Integer	Bank account identifier	[optional]
accountName	String	Account name of the payout destination	[optional]
payoutStatus	PayoutStatusEnum	Status of the payout	[optional]
createdDate	OffsetDateTime	Date payout was created	[optional]
periodStartTime	OffsetDateTime	This payout includes operations after at this date (inclusive)	[optional]
periodEndTime	OffsetDateTime	This payout includes operations before at this date (exclusive)	[optional]
destinationBank	String	Destination bank name	[optional]
destinationAccount	String	Last 4 digits of the destination bank IBAN	[optional]
amount	Double	Payout amount	[optional]
payoutType	PayoutTypeEnum	Type of payout source	[optional]
currency	CurrencyEnum	Payout currency	[optional]
cutoffDate	OffsetDateTime	Payouts before this date do not have a details breakdown	[optional]
onlineSalesAmount	Double	Payout online sales amount	[optional]
onlineSalesDeliveryCharges	Double	Payout online sales delivery charges	[optional]
onlineSalesTips	Double	Payout online sales tips	[optional]
onlineSalesServiceCharges	Double	Payout online sales service charges	[optional]
onlineSalesRefundedFees	Double	Payout online sales refunded fees	[optional]
onlineSalesFees	Double	Payout online sales fees	[optional]
posSalesFees	Double	Payout online sales fees	[optional]
onlineSalesRefundedAmount	Double	Payout online sales refunded amount	[optional]
posSalesRefundedAmount	Double	POS Payout online sales refunded amount	[optional]
onlineSalesTax	Double	Payout online sales tax	[optional]
totalOnlineRevenue	Double	Payout total online revenue	[optional]
cashSalesFees	Double	Payout cash sales fees	[optional]
cashSalesRefundedFees	Double	Payout cash sales refunded fees	[optional]
customerCashFees	Double	Payout cash fees charged to customer	[optional]
salesFeesVat	Double	Payout sales fees vat	[optional]
totalFees	Double	Payout total fees	[optional]
totalOnlineRevenueAdjustments	Double	Payout total online revenue adjustments	[optional]
chargebackAmount	Double	Payout chargeback amount	[optional]
posSalesChargebackAmount	Double	POS Payout chargeback amount	[optional]
chargebackRefundedFees	Double	Payout chargeback refunded fees	[optional]
totalChargebackCost	Double	Payout chargebacks total cost	[optional]
totalOtherCharges	Double	Payout other charges total	[optional]
openingBalance	Double	Payout opening balance	[optional]
closingBalance	Double	Payout closing balance	[optional]
payGreenSalesAmount	Double	Amount of sales through PayGreen (restaurant vouchers)	[optional]
deliveryIntegrationFee	Double	Third party integration delivery fee	[optional]
deliveryIntegrationTipFee	Double	Third party integration delivery tip fee	[optional]
totalThirdPartyFees	Double	Total third party integration fees	[optional]
posSalesAmount	Double	POS sales amount	[optional]
posSalesTax	Double	POS sales tax	[optional]
tipsOnPosSales	Double	Tips on POS sales	[optional]
bankAccountHasChanged	Boolean	Indicates whether the bank account has changed since the previous payout	[optional]

Enum: PayoutStatusEnum

Name	Value
PENDING	"Pending"
INTRANSIT	"InTransit"
PAID	"Paid"
FAILED	"Failed"
CANCELLED	"Cancelled"

Enum: PayoutTypeEnum

Name	Value
INTERNAL	"Internal"
STRIPE	"Stripe"

Enum: CurrencyEnum

Name	Value
EUR	"EUR"
USD	"USD"
GBP	"GBP"
CAD	"CAD"
AUD	"AUD"
DJF	"DJF"
ZAR	"ZAR"
ETB	"ETB"
AED	"AED"
BHD	"BHD"
DZD	"DZD"
EGP	"EGP"
IQD	"IQD"
JOD	"JOD"
KWD	"KWD"
LBP	"LBP"
LYD	"LYD"
MAD	"MAD"
OMR	"OMR"
QAR	"QAR"
SAR	"SAR"
SYP	"SYP"
TND	"TND"
YER	"YER"
CLP	"CLP"
INR	"INR"
AZN	"AZN"
RUB	"RUB"
BYN	"BYN"
BGN	"BGN"
NGN	"NGN"
BDT	"BDT"
CNY	"CNY"
BAM	"BAM"
CZK	"CZK"
DKK	"DKK"
CHF	"CHF"
MVR	"MVR"
BTN	"BTN"
XCD	"XCD"
BZD	"BZD"
HKD	"HKD"
IDR	"IDR"
JMD	"JMD"
MYR	"MYR"
NZD	"NZD"
PHP	"PHP"
SGD	"SGD"
TTD	"TTD"
XDR	"XDR"
ARS	"ARS"
BOB	"BOB"
COP	"COP"
CRC	"CRC"
CUP	"CUP"
DOP	"DOP"
GTQ	"GTQ"
HNL	"HNL"
MXN	"MXN"
NIO	"NIO"
PAB	"PAB"
PEN	"PEN"
PYG	"PYG"
UYU	"UYU"
VEF	"VEF"
IRR	"IRR"
XOF	"XOF"
CDF	"CDF"
XAF	"XAF"
HTG	"HTG"
ILS	"ILS"
HRK	"HRK"
HUF	"HUF"
AMD	"AMD"
ISK	"ISK"
JPY	"JPY"
GEL	"GEL"
KZT	"KZT"
KHR	"KHR"
KRW	"KRW"
KGS	"KGS"
LAK	"LAK"
MKD	"MKD"
MNT	"MNT"
BND	"BND"
MMK	"MMK"
NOK	"NOK"
NPR	"NPR"
PKR	"PKR"
PLN	"PLN"
AFN	"AFN"
BRL	"BRL"
MDL	"MDL"
RON	"RON"
RWF	"RWF"
SEK	"SEK"
LKR	"LKR"
SOS	"SOS"
ALL	"ALL"
RSD	"RSD"
KES	"KES"
TJS	"TJS"
THB	"THB"
ERN	"ERN"
TMT	"TMT"
BWP	"BWP"
TRY	"TRY"
UAH	"UAH"
UZS	"UZS"
VND	"VND"
MOP	"MOP"
TWD	"TWD"
BMD	"BMD"