API Reference

Search Transactions

post
http://localhost:8080/v0/transactions/search
Query Params
int32
required

List fetch limit, value between 1 and 1000

int32
required

Offset used for paging results

string
enum

SortBy used for sorting transactions. Possible values:

  • CLEARING_TIME (default if not provided): Transactions sorted by clearing time
  • TRANSACTION_TIME: Transactions sorted by transaction time
Allowed:
Body Params

Body of a request to search transactions

uuid

Unique identifier (UUID) of the Account

date-time
required

DateTime in UTC format for the start date range of the Transaction search

string
enum

Origin source of the Transaction (only applicable if specifically used by Client). Possible values:

  • ATM_CASH
  • POS_DEBIT
  • VENUE
Allowed:
uuid

Additional identifier applied to Transaction related to origin of the request

string
enum

Initiator origin of the Transaction. Possible values:

  • CUSTOMER: Transaction initiated by a customer
  • SCHEDULED_PAYMENT: Transaction initiated by a schedule
  • HAAS_OPERATIONS: Transaction initiated by Client Operations team
  • OPERATIONS: Transaction initiated by Shaype Operations team
  • DIRECT_DEBIT: Transaction initiated by Direct Debit
Allowed:
date-time
required

DateTime in UTC format for the end date range of the Transaction search

Responses

Updated 11 days ago

Language
LoadingLoading…
Response
Choose an example:
application/json

Updated 11 days ago