Search for list of funding rejects
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
How to retrieve a list of funding rejects
Retrieve a list of funding rejects for an existing merchant by making a GET API call to /funding-rejects endpoint in Funding Rejects API.
User will be able to filter the funding rejects using following query parameters by passing in API request for every GET API call to /funding-rejects endpoint:
| Object | Description |
|---|---|
| fundingId | Unique system identifier of the record in system (Slip number of the original funding amount). If this parameter passed with valid funding ID then system return particular funding reject available with this funding ID. |
| merchantId | Our reference merchant number (external). If this parameter passed with valid existing merchant number then system return any funding rejects available only for this merchant. |
| limit | Number of funding rejects to be returned in a single GET API call. Can be used for page/offset or cursor based pagination. For example, if limit is passed as 100, then maximum of 100 available funding reject records will be returned starting from 'offset' parameter passed. |
| offset | Starting point to start retrieving the funding rejects record from. This can be used in conjuction with "limit" query parameter. Can be used for page/offset based pagination. For example, if offset is passed as 10, then first 10 funding rejects will be skipped and from 11th record will be returned. If this parameter not passed then system consider default value as '0'. |
| rejectedAfter | 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. |
| rejectedBefore | 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. |
| sort | 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 |
| status | Current status of the fuding reject whether it has been funded to the merchant account or still rejected. If this parameter passed with valid funding reject status then only funding rejects with the provided status will be returned. |
User will be able to view the following data for every GET API call to /funding-rejects endpoint:
| Object | Field reference in API Response Payload | Description |
|---|---|---|
| Merchant No. | 'id' under 'merchant' Object | Our reference merchant number (external) |
| Merchant Name | 'tradeName' under 'merchant' object | Merchant trade name |
| Funding Reject ID | 'id' under 'object' Object | Slip number of Funding Reject |
| Funding ID | 'fundingId' under 'originalPayment' Object | Slip number of the original payment transaction |
| Funding Date | 'fundingDate' under 'originalPayment' Object | The date the original payment was posted on system that become rejected |
| Amount | 'amount' under 'originalPayment' Object | Value of rejected merchant funds |
| Merchant Counter Bank Number | 'sortCode' under 'account' Object | Clearing number of the merchant's bank i.e. the sort code or BSB number (Australia) |
| Merchant Bank Account Number | 'accountNumber' under 'account' Object | Merchant's bank account number |
| IBAN (International Bank Account Number) | 'iban' under 'account' Object | International Bank Account Number (IBAN) is a series of alphanumeric characters that uniquely identifies a customer's account held at a bank anywhere in the world. |
| Account Currency | 'currencyCode' under 'account' Object | Currency of rejected merchant funds |
| Reason | 'reason' under 'object' Object | The reason for the rejected payment |
| Reprocessed Date | 'reprocessedDate' under 'object' Object | Date when the rejected payment is resubmitted on funding file |
| Date | 'postedDate' under 'object' Object | The date the rejected payment is posted on the system |
| Last Updated By | 'lastUpdatedBy' under 'object' Object | The contact name of the user that last updated the funding reject (if not updated systemically) |
| Status | 'status' under 'object' Object | The current status of the funding reject |
Below is a sample response:
// GET list of funding rejects
[
{
"id": "12345678901",
"reason": "01UAR0000No Sending Bank Info for pymt fmt (000) tran type (02) curr (CAD)",
"reprocessedDate": "20200615",
"posted": "20200615",
"lastUpdatedBy": "John Smith",
"status": "LOADED",
"merchant": {
"id": "0000075999959",
"tradeName": "Insomnia"
},
"originalPayment": {
"fundingId": "12345678901",
"funded": "20200615",
"amount": "10.00"
},
"account": {
"sortCode": "13165987",
"accountNumber": "ZZ999999999999999",
"iban": "ZZ99999999999999999999",
"currencyCode": "CAD"
}
},
{
"id": "01234567890",
"reason": "01UAR0000No Sending Bank Info for pymt fmt (000) tran type (02) curr (USD)",
"reprocessedDate": "20200620",
"posted": "20200620",
"lastUpdatedBy": "Jane Doe",
"status": "APPROVED",
"merchantObject": {
"id": "0000076543210",
"tradeName": "Cafe"
},
"originalPayment": {
"fundingId": "12345678901",
"funded": "20200620",
"amount": "100.00"
},
"account": {
"sortCode": "1230456",
"accountNumber": "ZZ999999999999999",
"iban": "ZZ99999999999999999999",
"currencyCode": "USD"
}
}
]
Updated about 1 year ago
