Onboarded companies

GET

/api/companies

Code sample: Shell / cURL

curl --request GET \
  --url https://api.ztlpay.io/api/companies \
  --header 'Authorization: Bearer <token>'

• Production environment
• Sandbox environment for testing

Get list of all companies onboarded by the partner

Authorizations

• OAuth2Sandbox
  api://ac0d1aea-5e3a-463f-9dd1-194898ee5820/.default
• OAuth2Production
  api://1f115cad-5576-4db9-a7f9-8921c47a86e4/.default

Responses

200

Successfully retrieved entries

Media typeapplication/json

Array<object>

Payroll cancellation response

object

organizationNumber

string

activeSubscription

boolean

Example^generated

[
  {
    "organizationNumber": "example",
    "activeSubscription": true
  }
]

403

Forbidden

Media typeapplication/json

object

type

Type of error, used to group similar errors

string format: uri

title

required

The title of the error

string

detail

Detailed information of the error cause

string

instance

Endpoint that caused the failure request

string

traceId

ID to identify the failure request

string

Example

{
  "type": "urn:quote-failed",
  "title": "Payment rejected",
  "instance": "/api/payments/56563af2-a199-44ec-92a1-d77eed2d8562/status"
}