List Settlements

GET 
/settlements

List Settlements

Request

Query Parameters

page int32

Default value: 1

Page to list

id uuid

Settlement ID to look for

created[gt] timestamp

Filter settlements created on a date equal or greater than a give date

created[lt] timestamp

Filter settlements created on a date equal or less than a give date

Responses

200

Successful operation

application/json

Schema

Schema

settlements

object[]

Array [

id uuid

recipient_type string

Possible values: [Entity, Platform, Beneficiary]

recipient_id uuid

currency Currency (string)

ISO-4217 three-letter currency code.

amount integer

Full settlement amount before subtracting the settlement (bank transfer) fee

fee integer

settlement (bank transfer) fee for the settlement. Includes VAT.

tax integer

VAT

reference string

Settlement bank transfer sequence number. This value is not available yet and will be provided in future updates.

settlement_count int32

Number of transactions included in the settlement

invoice_url uri

Settlement invoice PDF file URL.

csv_list_url uri

Settlement transaction CSV list.

pdf_list_url uri

Settlement transaction PDF list. This is not always available

created_at timestamp

]

meta

object

current_page integer

next_page integer

prev_page integer

total_pages integer

total_count integer

Example (from schema)

{
  "settlements": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "recipient_type": "Entity",
      "recipient_id": "c5c57597-0d06-4583-9da5-c755c4943ede",
      "currency": "SAR",
      "amount": 24209,
      "fee": 46,
      "tax": 6,
      "reference": null,
      "settlement_count": 1,
      "invoice_url": "https://example.com/invoice.pdf",
      "csv_list_url": "https://example.com/list.csv",
      "pdf_list_url": "https://example.com/list.pdf",
      "created_at": "Date and time when the settlement was created."
    }
  ],
  "meta": {
    "current_page": 1,
    "next_page": null,
    "prev_page": null,
    "total_pages": 1,
    "total_count": 1
  }
}

401

Invalid authorization credentials

application/json

Schema

Schema

type string

Possible values: [authentication_error]

message string

Possible values: [Invalid authorization credentials]

errors object

Example (from schema)

{
  "type": "authentication_error",
  "message": "Invalid authorization credentials",
  "errors": null
}

403

Invalid authorization credentials

application/json

Schema

Schema

type string

Possible values: [api_error]

message string

Possible values: [User not authorized]

errors object

Example (from schema)

{
  "type": "api_error",
  "message": "User not authorized",
  "errors": null
}

Loading...