Retrieve Funding Rejects

Retrieves a paginated list of funding rejects. The results can be fitered by any one or more query parameters passed as input in the API Request.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

🚧

In development

Our Funding rejects API is currently in development and specification is subject to change. If you are interested in using this solution or would like to provide feedback on the API design, please contact us via our support page

Query Params
string
length between 1 and 20

For use by an alliance or partner when there is a need to filter on a specific merchant within their scope. May be restricted based on the API key.

string of strings

Current status of the funding reject whether it has been funded to the merchant account or still rejected. This field should contain the 3 digit status index.

CodeStatus
003Error
005Loaded
008Approved
032Matched
104Cheque issued
105Returned
106Centralise
107Penalise
109Decentralise
110Applied PyG
string
length between 8 and 8

Extract funding rejects that were posted to merchant account after this date. The date format is YYYY-MM-DD. Default: Date will be 'current institution posting date - 1' if this query parameter not provided.

string
length between 8 and 8

Extract funding rejects that were posted to merchant account before this date. The date format is YYYY-MM-DD. Default: Date will be current institution posting date if this query parameter not provided.

int32
≥ 0
Defaults to 0

Starting point to start retrieving the elements from. This can be used with "limit". Can be used for page/offset based pagination.

int32
1 to 100
Defaults to 20

Number of elements to be returned in a single query. Can be used for page/offset or cursor based pagination.

string

Defines how to sort the records that are returned. Must be specified in the syntax '+' (ascending) or '-' (descending) followed by the field name. Valid values: +posted for ascending and -posted for descending. Default: +posted

string of strings

Unique system identifier of the record in OmniPay system.

Headers
string

Institution number (8-digit number) associated with the merchant. This information defines the acquirer for the merchant. If a consumer is granted access to this API for multiple institutions, this field must be populated. If access is for only one institution, the API will automatically determine this value, making it optional for the client.

Responses

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