Sign in

v1

latestOpenAPI 3.0.02026-08-043111167.0 KB
Payout

Get self payOuts by externalIdentifier

Get a list of payOuts by a list of externalIdentifier and companyProductId

post/payouts/byExternalIdentifierList

Query parameters

authorizationstring required

Authorization token

Request body

externalIdentifierListstring[]
companyProductIdnumber

Example request

{
  "externalIdentifierList": [
    "XYZ123456789"
  ],
  "companyProductId": 1
}

Response

Array of PayOut model instances

idnumber

PayOut id

externalIdentifierstring

PayOut externalIdentifier

Amountnumber

PayOut amount

bankBaseIdnumber

PayOut bankBaseId

bankAccountTypestring

PayOut bankAccountType

bankAccountstring

Bank account number

beneficiaryNamestring

PayOut beneficiaryName

documentTypeIdnumber

Beneficiary documentTypeId

documentNumberinteger

Beneficiary documentNumber

statestring

PayOut state

Example response

[
  {
    "id": 1,
    "externalIdentifier": "XYZ123456789",
    "Amount": 1000,
    "bankBaseId": 1,
    "bankAccountType": "ahorros",
    "bankAccount": "123456789",
    "beneficiaryName": "John Doe",
    "documentTypeId": 1,
    "documentNumber": 123456789,
    "state": "DELIVERED"
  }
]