API referenceTrading enrollments
List trading enrollments
GET
Lists the trading enrollments your integration key can reach.
integrationKeyheader
AuthorizationBearer <token>Your integration key, sent as Authorization: Bearer nik_<prefix>_<secret>.
Konsol issues it.
page?integerRange
1 <= valueDefault
1limit?integerRange
1 <= value <= 100Default
20trading_id?stringFormat
uuidtrading_external_ref?stringYour identifier for it, matched exactly; none matching is an empty page.
Match
^\S(.*\S)?$Length
1 <= length <= 128acquirer_id?stringFormat
uuidacquirer_external_ref?stringYour identifier for it, matched exactly; none matching is an empty page.
Match
^\S(.*\S)?$Length
1 <= length <= 128status?stringDefaults to active, or to both active and ended when sort is
updated_at or -updated_at, so an enrollment that ended since your last
refresh is in it.
Value in
"active""ended"sort?stringOrders by a field, ascending, or descending with a - prefix. Ties break on
id. Without it the list is in id order.
Value in
"created_at""-created_at""updated_at""-updated_at"A page of enrollments
application/json- response
data*array<>page*integerRange
1 <= valuelimit*integerRange
1 <= value <= 100total_count*integerRange
0 <= valuetotal_is_capped*booleantotal_pages*integerRange
0 <= valuehas_more*booleanExample Request
curl -X GET 'https://api.konsol.my/integration/v1/trading-enrollments'Example Response
{ "data": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "trading_id": "1697ee0a-d655-4892-9ce3-9e2a05ec9dc1", "product": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "code": "string", "name": "string" }, "vendor": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string" }, "acquirer": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "external_ref": "ACQ-MBB" }, "status": "active", "activated_at": "2019-08-24T14:15:22Z", "ended_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z" } ], "page": 1, "limit": 1, "total_count": 0, "total_is_capped": true, "total_pages": 0, "has_more": true}