iotoms Docs

List payouts for a settlement

GET
/api/v1/commission/settlements/{id}/payouts

Returns every commission payout recorded against the settlement id, most recent payment date first, with how each payout was split across people.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Path Parameters

id*string

ID of the record (UUID).

Formatuuid

Header Parameters

X-TenantID*string

Your merchant's tenant code — the value typed in the Domain field on the iotoms login screen. See Concepts.

Response Body

OK

*/*
  1. response
status*string

Outcome of the request: SUCCESS when it worked; errors return an error status with the reason in message.

message*string

Short human-readable message describing the outcome.

data?array<>|

Payouts recorded against the settlement, most recent payment date first.

Example Request
curl -X GET 'https://beta.iotoms.com/api/v1/commission/settlements/497f6eca-6276-4993-bfeb-53cbbbba6f08/payouts' \  -H 'X-TenantID: your-tenant-code'
Example Response
{  "status": "string",  "message": "string",  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "settlementId": "b4887549-5aec-4adc-bf32-5fb69ede72ea",      "amount": 0,      "payMode": "string",      "paidOn": "2019-08-24",      "reference": "string",      "notes": "string",      "allocations": [        {          "lineId": "e698cdee-c4ef-4d12-b0ea-7c98b2fc64a8",          "userRef": "string",          "amount": 0        }      ],      "createdAt": "2019-08-24T14:15:22Z",      "createdBy": "string"    }  ]}