İçeriğe geç
Apex Settlement
Onboarding

Get the terms

Gereken izincustomer:readAPI referansındaki uç nokta açıklamaları İngilizcedir.
GET
/v1/terms

The terms the Customer must accept, the platform's and each Provider's, each with its version and link, and whether they are all accepted. version names the whole set: send it back to POST /v1/terms. An End Customer whose set is empty reads accepted: true and need not accept anything.

Requires the customer:read permission. A Platform may call it for one of its End Customers with Apex-End-Customer.

Yetkilendirme

ApiKey
headerYetkilendirmeBearer <API key>

A Customer API key, created by a Customer admin in the Customer panel and shown once: Authorization: Bearer ak_live_… in production, ak_test_… elsewhere. A key holds a subset of its creator's permissions and may be limited to named IP addresses and an expiry date. Keys never manage people, other keys or approval rules, and never approve a Payout.

Başlık parametreleri

Apex-End-Customer?string

A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers end_customer_not_found.

Biçimuuid

Yanıt gövdesi

OK

application/json
  1. response
accepted*boolean
documents*array<>
version*string

version names the whole set; POST /v1/terms sends it back.

Örnek istek
curl -X GET 'http://localhost:3480/v1/terms'
Örnek yanıt
{  "accepted": true,  "documents": [    {      "accepted_at": "2026-11-10T16:40:00Z",      "id": "platform",      "provider": "bvnk",      "url": "https://example.com/terms/bvnk",      "version": "2026-10-01"    }  ],  "version": "string"}