API Reference

GET Entity Account(s) [For Remitter/Student/Beneficiary]

get
https://api-er.stockal.com/v1/client/accounts

This API allows the API user to retrieve the details for an existing Entity Account OR details of all accounts of under one Entity Type.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
Defaults to 0ca9ed3f-9dc8-4311-9cb8-99f20069013d

This field allows the API user to specify the Account ID for the Entity being queried [To be used WITHOUT "accountType"]

string
Defaults to remitter

This field specifies the type of Entity the GET API queries for. This can be either remitter/beneficiary/student [To be used WITHOUT "userAccountId"]

Headers
string
required
Defaults to <api-key>

API Key

string
required
Defaults to <auth-key>

Auth key generated via the "Generate Auth key API"

string
required
Defaults to fa4dba28-48f3-4b4f-865e-c0d56fab1e64

User Id as generated via the "Create Account (sign-Up) API". Identifier of an individual user, you can map this to the User identification at your end.

Responses

Updated about 2 years ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 years ago