BYbyaccrue
Counterparties

List Counterparty Payouts

List the payouts of a specific counterparty, newest first. meta.total counts the payouts matching the filters, so page through the list with page[offset] until you have read meta.total records. Both bounds of every filter range are inclusive.

get/api/v1/counterparties/:counterpartyId/payouts

Request

Path parameters

counterpartyIdstring uuid required

ID of the counterparty to fetch payouts for.

Example:123e4567-e89b-12d3-a456-426614174000

Query parameters

page[limit]number

Maximum number of objects that will be returned. Can not be greater than 50.

page[offset]number

Offset from the beginning of the list of objects. Can not be negative.

filter[status]'Approved' | 'Cancelled' | 'Completed' | 'Denied' | 'Failed' | 'NeedsApproval' | 'Pending' | 'Processing' | 'Returned' | 'Reversed' | 'Sent'

Filter payouts by status.

Example:Sent
filter[minAmount]integer

Only payouts of at least this amount, in cents.

Example:1000
filter[maxAmount]integer

Only payouts of at most this amount, in cents.

Example:500000
filter[createdAfter]string date-time

Only payouts created at or after this ISO 8601 datetime.

Example:2024-01-01T00:00:00.000Z
filter[createdBefore]string date-time

Only payouts created at or before this ISO 8601 datetime.

Example:2024-12-31T23:59:59.999Z
filter[effectiveDateFrom]string date

Only payouts with an effective date on or after this date (YYYY-MM-DD).

Example:2024-01-01
filter[effectiveDateTo]string date

Only payouts with an effective date on or before this date (YYYY-MM-DD).

Example:2024-12-31

Headers

Client-IDstring uuid required

The unique identifier of the client making the request. This header is required to retrieve the client-specific configuration and ensure that the response is tailored to the client's settings and permissions.

Example:123e4567-e89b-12d3-a456-426614174000
Authorizationstring uuid required

Secure secret to access privileged endpoints.

Example:Bearer 633b336e4f57f095a405f6685e208cc7dd16de3e82494662f2acfeec3af1cdef

Response

OK

Example response

{
  "data": [
    {
      "attributes": {
        "amount": 5000,
        "status": "Sent",
        "description": "Payout to vendor",
        "effectiveDate": "2024-01-15",
        "counterpartyId": "123e4567-e89b-12d3-a456-426614174000"
      }
    }
  ],
  "meta": {
    "total": 1,
    "limit": 10
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.