List Customer Portals

Request

Get a list of portals associated with customer's pockets.

Security

HTTPBearer

Path

customer_idstring, (uuid)(Customer Id)required

Query

type[]Array of strings or null(Type[])

Any of:

Array of strings

status[]Array of strings or null(Status[])

Any of:

Array of strings

cursorstring or null(Cursor)

Any of:

string

limitinteger(Limit)

Default:100

x-jiko-idempotencystring, (uuid)(X-Jiko-Idempotency)required

A UUID you generate to identify this request. Reusing a value that was already sent is rejected as a duplicate request.

x-jiko-signaturestring(X-Jiko-Signature)required

Base64-encoded HMAC-SHA256 hash of x-jiko-idempotency + request pathname + body, keyed with your shared secret. See Authentication for the full algorithm and a code sample.

curl -i -X GET \
  'https://your-partner-name.sandbox-api.jikoservices.com/api/v2/customers/{customer_id}/portals/?type%5B%5D=VIRTUAL_BANK_ACCOUNT_PORTAL&status%5B%5D=OPEN&cursor=string&limit=100' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'x-jiko-idempotency: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'x-jiko-signature: string'

Responses

Successful Response

Bodyapplication/json

prev_pagestring or null(Prev Page)

Any of:

string

next_pagestring or null(Next Page)

Any of:

string

itemsArray of any(Items)required

object_typestring(Object Type)

Default:"CursorList"

Response

{
  "items": [
    { … }
  ],
  "object_type": "CursorList"
}