API Reference

List and search payment instructions

get
https://api.sandbox.tapico.io/v1/payment-instructions

List payment instructions.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
id
array of uuids

A CSV of specific resource IDs to retrieve.

id
uuid

Only return results with the specified Account Servicer ID for the Debtor Account.

uuid

Only return results with the specified Application ID.

string
enum

Only return results with the specified ISO status.

Allowed:
string
enum

Only return results with the specified instruction status.

Allowed:
string

Each response payload may contain a nextCursor in the metadata, which is a pointer to the next set of results when more results are available.

Set this query parameter to access the next page of results.

integer
1 to 100
Defaults to 20

The numbers of items to return.

string
enum

Default sorting, by createdDateTime or updatedDateTime property.

Allowed:
Headers
string
enum

Specifies the Region for the request. When specified, this must match the region that the application access token was generated for.

For more information about regions see https://docs.tapico.io/docs/regions

Allowed:
Responses

Updated 8 months ago

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

Updated 8 months ago