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

Profiles

PreviousSettlements

Was this helpful?

get

Returns a list of all the profiles

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

OK

[
  {
    "id": "text",
    "trade_name": "NxTap",
    "address": {
      "premise": 58,
      "sub_premise": "A",
      "building": "text",
      "postal_code": "text",
      "thoroughfare": "text",
      "locality": "Hoofddorp",
      "state": "Noord-Holland",
      "country": "NL"
    },
    "created": "2024-09-25T12:01:00.103Z"
  }
]
get

Returns a profile

Authorizations
Path parameters
partnerIdstringRequired

The id of the partner to retrieve

profileIdstringRequired

The id of the profile

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

OK

{
  "id": "text",
  "trade_name": "NxTap",
  "address": {
    "premise": 58,
    "sub_premise": "A",
    "building": "text",
    "postal_code": "text",
    "thoroughfare": "text",
    "locality": "Hoofddorp",
    "state": "Noord-Holland",
    "country": "NL"
  },
  "created": "2024-09-25T12:01:00.103Z"
}
  • GET/v1/profiles
  • GET/v1/profiles/{profileId}