GET /affiliates/payouts — loopay-api

v1

latestOpenAPI 3.0.02026-08-043111167.0 KB

Affiliate

Get all payOuts for affiliates

Gets all payOuts for affiliates created by the currently registered user, belonging to the company of the user

get/affiliates/payouts

Query parameters

authorizationstring required

Authorization token

companiesIdsstring required

Comma separated list of company ids

Response

Array of Affiliate model instances

idnumber

namestring

documentNumbernumber

documentTypeIdnumber

Example response

[
  {
    "id": 1,
    "name": "Global INC",
    "documentNumber": 900200001,
    "documentTypeId": 1,
    "PayOut": [
      {
        "id": 5087,
        "uid": "5f9b9b9b9b9b9b9b",
        "beneficiaryName": "John Doe",
        "documentTypeId": 1,
        "documentNumber": 19373737,
        "bankBaseId": 23,
        "bankAccountType": "ahorros",
        "bankAccount": "81234678944",
        "Amount": 5000000,
        "externalIdentifier": "REF123456789",
        "tags": {
          "tagIdentifier": [
            "indentifier1",
            "indentifier2",
            "indent 22",
            "indent 4"
          ]
        },
        "currencyId": 1,
        "signedBy": {
          "id": 122,
          "createdAt": "2020-10-28T15:33:19.000Z",
          "userId": 13
        },
        "companyProductId": 4451,
        "state": "delivered",
        "createdAt": "2020-10-28T15:33:19.000Z",
        "scheduledAt": "2020-10-28T15:33:19.000Z",
        "updatedAt": "2020-10-28T15:33:19.000Z",
        "validatedAt": "2020-10-28T15:33:19.000Z",
        "trasnferedAt": "2020-10-28T15:33:19.000Z",
        "reversedAt": "2020-10-28T15:33:19.000Z"
      }
    ]
  }
]