Sign in

v1

latestOpenAPI 3.0.02026-08-043111167.0 KB
Payout

Create a payOut

Create a single payout given a payout object

post/payout/create

Query parameters

authorizationstring required

Authorization token

signPayOutboolean

Set to true to sign (approve) the payout after creation (default: false)

Request body

Amountnumber required
bankAccountstring required
bankAccountTypestring required
bankBaseIdnumber required
beneficiaryNamestring required
companyIdnumber required
companyProductIdnumber required
currencyIdnumber
{"stackTrail":"components:schemas:CreaateSelfPayOut:properties:documentNumber","oasType":"schema","type":"unknown"}
documentTypeIdnumber required
externalIdentifierstring
metaDataobject
expiresAtstring date-time
emailstring
phonestring

Response

Create a payOut with bank transfer

Create one payout given a company id, company product id

idnumber
activeboolean
Amountnumber required
AmountUsdnumber
bankAccountstring required
bankAccountTypestring required
bankBaseIdnumber required
beneficiaryNamestring required
companyIdnumber
companyProductIdnumber required
currencyIdnumber required
deletedboolean
{"stackTrail":"components:schemas:PayOut:properties:documentNumber","oasType":"schema","type":"unknown"}
documentTypeIdnumber required
externalIdentifierstring required
metaDataobject
reversedAtstring date-time
startedProcessAtstring date-time
statestring
trasnferedAtstring date-time
userIdnumber required
validatedAtstring date-time
uidstring