Payment Received

This chapter provides an in-depth overview of the PaymentReceived notification message, which is published when a payment is received for an account.

Notification Overview

Headers of the PaymentReceived Notification

The following table lists the headers in the PaymentReceived notification:

Header Description Value

X-Ocs-Io-transaction-id

ID of the transaction.

X-Ocs-Io-notification-code

Code of the Notification.

paymentReceived

X-Ocs-Io-notification-payload

Name (JAVA’s Simple Name) of the Notification’s Payload.

PaymentReceivedNotification

Fields of the PaymentReceived Notification Payload

The following table lists and describes the fields in the PaymentReceived notification payload:

Field Description

effectiveDate

Effective Date/Time of the Notification.

account

ID (Ref ID / External ID) of the Account.

paymentType

Payment Types: 'IN' - Incoming Payment

paymentAmount

Amount of the Payment.

currency

Currency of the Payment.

paymentDateReceived

Date/Time when Payment was received on provider’s bank account.

paymentRef1

Payment Reference No.1 associated with the Payment.

paymentRef2

Payment Reference No.2 associated with the Payment.

paymentRef3

Payment Reference No.3 associated with the Payment.

channelType

Type of channel (e.g. card, bank transfer, etc.).
Detailed API documentation and endpoint specifics are available here.