Developer documentation
HomeLogin
Enterprise API
Enterprise API
  • Authentication
    • Generate a private and a public certificate
    • Create a JWT token using your private key
  • Webhooks
  • Payment methods
    • Openbanking recurring payments
    • Openbanking payments
    • Card not present card payments
  • API reference
    • Payments
    • Payment methods
    • Customers
    • Settlements
    • Profiles
    • Specification
Powered by GitBook
On this page

Was this helpful?

  1. API reference

Settlements

PreviousCustomersNextProfiles

Was this helpful?

get

Returns a list of all the settlements

Authorizations
Path parameters
profileIdstringRequired

The id of the profile

Responses
200
OK
application/json
get
GET /v1/profiles/{profileId}/settlements HTTP/1.1
Host: api.bankingservice.ai
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
200

OK

[
  {
    "id": "text",
    "currency": "EUR",
    "charges": {},
    "charges_total": 1,
    "amount": 8230,
    "payout": {
      "payments": {
        "count": 1,
        "sum": 1
      },
      "refunds": {
        "count": 1,
        "sum": 1
      }
    },
    "scheduled": "2024-09-25T12:01:00.103Z",
    "created": "2024-09-25T12:01:00.103Z"
  }
]
get

Returns a settlement

Authorizations
Path parameters
profileIdstringRequired

The id of the profile

settlementIdstringRequired

The id of the settlement

Responses
200
OK
application/json
get
GET /v1/profiles/{profileId}/settlements/{settlementId} HTTP/1.1
Host: api.bankingservice.ai
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
200

OK

{
  "id": "text",
  "currency": "EUR",
  "charges": {},
  "charges_total": 1,
  "amount": 8230,
  "payout": {
    "payments": {
      "count": 1,
      "sum": 1
    },
    "refunds": {
      "count": 1,
      "sum": 1
    }
  },
  "scheduled": "2024-09-25T12:01:00.103Z",
  "created": "2024-09-25T12:01:00.103Z"
}
  • GET/v1/profiles/{profileId}/settlements
  • GET/v1/profiles/{profileId}/settlements/{settlementId}