Confirmation of Funds Credited

deprecated

This endpoint has been deprecated and may be removed in future versions of the API.

This method allows the Bank to send credit notification for a received payment. It is used for reconciliation purposes. The Bank should be able to filter the credit statement by reference, informing the API only for those reference starting with a given prefix (to be defined). For these payments, the Bank will consume the API ‘Confirmation of Funds Credited’.

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.

Request Body — REQUIRED
reference string
paidAmount number — REQUIRED
currency string — REQUIRED
status string — REQUIRED
paymentDate date-time — REQUIRED
valueDate date-time
collectorCode string — REQUIRED
bankTransactionReference string
creditedAccount string — REQUIRED
orderingCustomer string
orderingInstitution string

Responses
200 OK Schema — OPTIONAL paymentId string — OPTIONAL paidAt date-time — OPTIONAL zonedPaidAt date-time — OPTIONAL