DOCUMENTATION
Guides
Recipient login

Akoya product responses

Validate responses from Akoya API endpoints

Suggest Edits

📘

Notes

Akoya's high-level JSON structure for API responses follow FDX specifications.

Provider-specific sample responses are documented in the Hub and should be cross-referenced when performing these tests to validate response, payload structure, and sample responses per data element.

The /accounts-info endpoint

Test caseTask(s)Expected result(s)
Return all accounts.Omit the accountIds parameter with the /accounts-info endpoint.HTTP 200: OK with non-empty JSON payload
Return one account.Set accountIds query param to an accountId retrieved in /accounts-info payload.Validate fetch for 1.
Return N accounts.Set accountIds query param to more than one accountId (comma separated) retrieved in /accounts-info payload.Validate fetch for N.

The /transactions endpoint

Test caseTask(s)Expected result(s)
Get an account’s transactions.Call /transactions.HTTP 200: OK with non-empty JSON payload
Filter transactions based on start/end time.Provide values for the startTime and endTime query parameters.startTime / endTime parameters are functioning as expected; Akoya uses ISO8601. See transactions documentation for example payloads.
Paginate through transactions.Call the /transactions endpoint using a Mikomo test account that has a very large (paginated) payload.Pagination functions as expected for payloads large enough to require it. See our documentation on pagination.
Get an account with no transactions.Call the /transactions endpoint using a Mikomo test account that has no transactions.The following HTTP response: HTTP 200: OK

Payload:
{
   "transactions": []
}

The /customer endpoint

Test caseTask(s)Expected result(s)
Get an account’s customer info.Call /customers.HTTP 200: OK with non-empty JSON payload.

See Customer info

The /payment-enablement endpoint

Test caseTask(s)Expected result(s)
Get an account’s payment network info.Call /payments.HTTP 200: OK with non-empty JSON payload

See Payment networks

Need help?

Check out our Developer Community, or visit the Support Center in the Data Recipient Hub.

Looking for provider nuance documentation?

All provider nuance documentation is available in the Data providers section in the Data Recipient Hub.

Still stuck?

For all production issues, submit a support ticket through the Data Recipient Hub. Our support team is standing by 24/7. Questions and non-production issues will be answered during business hours.

Updated 3 months ago