Skip to main content

Fetch Payments

This method allows the Bank to fetch payment information from the Payment Platform. This is used as an alternative of the 'Execute Payment' method exposed by the Bank API (in case the Bank API doesn't dispose of the 'Execute Payment' method). The 'Fetch Payments' endpoint is supposed to be invoked with a given frequency by the Bank, for example every 5 minutes.

Query Parameters
requestParameterDto object REQUIRED
Header Parameters
TZ

The timezone header is optional. If provided, the header value will be applied to the API response's date and time fields. If the timezone header is not included, the default UTC timezone will be used and returned to the response.

Responses
200

OK

Schema OPTIONAL
paymentsCount int32 OPTIONAL
payments object[] OPTIONAL
firstName string OPTIONAL
lastName string OPTIONAL
customerCode string OPTIONAL
customerName string OPTIONAL
paymentReference string OPTIONAL
invoiceId string OPTIONAL
amount number OPTIONAL
currency string OPTIONAL
beneficiaries object[] OPTIONAL
reference string OPTIONAL
code string OPTIONAL
name string OPTIONAL
bankAccount string OPTIONAL
bankBicCode string OPTIONAL
bankName string OPTIONAL
amount number OPTIONAL
currency string OPTIONAL
errors object[] OPTIONAL
id string OPTIONAL
message string OPTIONAL
status string OPTIONAL
bankPayerId string OPTIONAL
zonedCreated date-time OPTIONAL
created date-time OPTIONAL
errors object[] OPTIONAL
id string OPTIONAL
message string OPTIONAL