Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

End-point

Method

Description

/api/transactions-pending

GET

Returns a collection of pending transactions

Info

All API endpoints require an authentication header to be included with the request.  See API Authentication

Filters

Parameter

Type

Description

id

int or Array Filter

OmniFund assigned Transaction ID

Code Block
# filter based on a single id
GET /api/transactions-pending?id=231432546
 
# filter based on multiple ids
GET /api/transactions-pending?id[]=231432546&id[]=231432546

customer

int or Array Filter

OmniFund assigned Customer ID

Code Block
# filter based on a single customer
GET /api/transactions-pending?customer=231432546
 
# filter based on multiple customers
GET /api/transactions-pending?customer[]=3245345&customer[]=21176543

amount

float or Array Filter

Amount of the transaction

Code Block
# filter based on a single amount
GET /api/transactions-pending?amount=1.25
 
# filter based on multiple amounts
GET /api/transactions-pending?amount[]=1.25&amount[]=25.33

referenceId

string or Array Filter

Merchant provided transaction reference ID

Code Block
# filter based on a single referenceId
GET /api/transactions-pending?amount=1.25
 
# filter based on multiple referenceIds
GET /api/transactions-pending?referenceId[]=A1234&referenceId[]=B2345

tranDate

Range Filter

Effective date the transaction is schedule to be processed on. Dates are displayed in and accept Unix format.

Code Block
# filter based on a single timestamp
GET /api/transactions-pending?tranDate=1553538663
 
# filter events between two timestamps
GET /api/transactions-pending?tranDate[between]=1553538663..1553638663
 
# filter events greater than or equal to a timestamp
GET /api/transactions-pending?tranDate[gte]=1553538663

...