Sign in

v1

latestOpenAPI 3.0.02026-08-043111167.0 KB
Payout

Create payOuts

Create several payouts given a company id, company product id and a data array of payout objects

post/payouts/create

Query parameters

authorizationstring required

Authorization token

signPayOutsboolean

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

Request body

companyIdnumber
companyProductIdnumber

Example request

{
  "companyId": 13,
  "companyProductId": 20,
  "data": [
    {
      "Amount": 1000,
      "bankAccount": "123456789",
      "bankAccountType": "ahorros",
      "bankBaseId": 1,
      "beneficiaryName": "John Doe",
      "documentTypeId": 1,
      "documentNumber": 123456789,
      "externalIdentifier": "XYZ123456789"
    }
  ]
}

Response

Create payOuts with bank transfers

Create several payouts given a company id, company product id and a data array of payout objects.

idnumber

PayOut id

externalIdentifierstring

PayOut externalIdentifier is unique field

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": "RECEIVED"
  }
]