List settlements

GET

/api/v1/settlements

const url = 'https://example.com/api/v1/settlements?page=1&per_page=10';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://example.com/api/v1/settlements?page=1&per_page=10' \
  --header 'Authorization: Bearer <token>'

Authorizations

bearerAuth

Parameters

Query Parameters

ids

Array<string>

Filter by settlement IDs

partner_ids

Array<string>

Filter by partner IDs

workspace_ids

Array<string>

Filter by workspace IDs

commission_ids

Array<string>

Filter by commission IDs included in the settlement

page

integer

default: 1

Page number for pagination (default: 1)

per_page

integer

default: 10

Number of items per page for pagination (default: 10)

Responses

200

application/json

object

settlements

required

Array<object>

object

required

Unique identifier for the settlement

string format: uuid

customer_id

required

ID of the customer this settlement belongs to

string format: uuid

workspace_id

required

ID of the workspace this settlement belongs to

string format: uuid

partner_id

required

ID of the partner this settlement belongs to

string format: uuid

currency

required

ISO 4217 currency code (e.g. EUR, USD)

string

view

required

object

status

required

One of: discriminator: type

object

type

required

string

Allowed values: draft

reconciliation_status

required

Reconciliation status of the settlement (reconciled, unreconciled)

string

invoice_reference

Invoice reference set by link_invoice

string

nullable

credit_note_reference

Credit note reference set by link_credit_note

string

nullable

report_reference

Report reference set by link_report

string

nullable

payment_reference

Payment reference set when payment is initiated (self-payout path only)

string

nullable

paid_at

Timestamp when the settlement was paid

string format: date-time

nullable

disputed_at

Timestamp when the settlement was disputed

string format: date-time

nullable

created_at

Timestamp when the settlement was created

string format: date-time

nullable

total_amount

required

Sum of all commission amounts in this settlement

integer format: int64

commission_amounts

required

Per-commission amount lines

Array<object>

object

commission_id

required

ID of the commission

string format: uuid

amount

required

Amount settled for this commission (in smallest currency unit)

integer format: int64

total

required

Total number of settlements matching the query

integer format: int64

page

required

Current page number

integer format: int64

per_page

required

Number of items per page

integer format: int64

Example

{
  "settlements": [
    {
      "view": {
        "status": {
          "type": "draft"
        }
      }
    }
  ]
}

401

Unauthorized

application/json

object

error_code

required

string

Allowed values: UNAUTHORIZED NOT_FOUND INTERNAL_ERROR BAD_REQUEST FORBIDDEN CONFLICT

message

required

string

Example

{
  "error_code": "UNAUTHORIZED",
  "message": "Authentication credentials were not provided or are invalid."
}

500

Internal Server Error

application/json

object

error_code

required

string

Allowed values: UNAUTHORIZED NOT_FOUND INTERNAL_ERROR BAD_REQUEST FORBIDDEN CONFLICT

message

required

string

Example

{
  "error_code": "UNAUTHORIZED",
  "message": "Authentication credentials were not provided or are invalid."
}