Payment

This chapter provides an in-depth overview of the Payment business transaction message, which is published when a payment is created or updated.

Business Transaction Overview

Headers of the Payment Business Transaction Message

The following table lists the headers in the Payment business transaction message:

Header Description Value

Header	Description	Value
X-Ocs-Io-transaction-id	ID of the transaction.
X-Ocs-Io-message-code	Code of the Message.	`payment`
X-Ocs-Io-message-payload	Name (JAVA’s Simple Name) of the Message’s Payload.	`PaymentEx`

X-Ocs-Io-transaction-id

ID of the transaction.

X-Ocs-Io-message-code

Code of the Message.

payment

X-Ocs-Io-message-payload

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

PaymentEx

Fields of the Payment Business Transaction Payload

The following table lists and describes the fields in the Payment business transaction payload:

Field	Description
refId	Ref ID of the Payment.
paymentNo	Number of the Payment (generated by RM module).
externalPaymentNo	External number of the Payment (generated by external system, e.g. Bank or Payment Gateway).
paymentType	Type of the Payment.
paymentMethod	Payment Method.
paymentAmount	Amount of the Payment.
currency	Currency of the Payment.
paymentDateReceived	Date/Time when Payment was received on provider’s bank account. Valid only for incoming payments.
paymentDateSent	Date/Time when Payment was sent from payer’s bank account (Incoming) from provider’s bank account (Outgoing).
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.
bankAccountNumber	Payer’s (Billing Account) bank account number, including prefix, without bank number code.
bankNumberCode	Payer’s (Billing Account) bank number code.
iban	Payer’s (Billing Account) bank account number in international format.
bic	Payer’s (Billing Account) BIC code of the bank.
bankAccountName	Payer’s (Billing Account) bank account name.
moneyOrder	Payer’s (Billing Account) Person and Address details in case Payment is transferred as Money Order
recipientNote	Recipient’s note/description of the Payment. Valid only for incoming payments.
payerNote	Payer’s note/description of the Payment.
bankAccountNumberProvider	Provider’s bank account number, including prefix, without bank number code.
bankNumberCodeProvider	Provider’s bank number code.
ibanProvider	Provider’s bank account number in international format.
bicProvider	Provider’s BIC code of the bank.
bankAccountNameProvider	Provider’s bank account name.
paymentCreatedDate	Date/Time when Payment was created.
paymentCreatedBy	Identification of the user who creates the Payment.
paymentIdentifiedDate	Date/Time when Payment was lastly identified. Valid only for incoming payments.
paymentIdentifiedBy	Identification of the user who lastly idenfifed the Payment. Valid only for incoming payments.
paymentAssignedDate	Date/Time when Payment was lastly assigned.
paymentAssignedBy	Identification of the user who lastly assigned the Payment.
account	Foreign key to Account.
usedAmount	Amount used in case of amount transactions.
remainingAmount	Remaining amount of payment after using some amount in case of amount transactions.
paymentCancelledDate	Date/Time when Payment was cancelled.
paymentCancelledBy	Identification of the user who cancelled the Payment.
cancellationReason	Reason of cancellation.
cancellationAmount	Cancellation amount (= Remaining Amount at the time of Cancel).
edrFileLoader	ID of the EdrFileLoader processed the Incoming Payment or Outgoing Payment.
edrFileExtractor	ID of the EdrFileExtractor processed the Outgoing Payment Request.
edrFile	ID of the EdrFile where Payment was loaded from.
promisedPaymentRefId	Ref ID of the Promised Payment done via OnLine channels. Populated only for PaymentType='PROMISE_TO_PAY'.
promisedPaymentDueDate	Date/Time Due of the Promised Payment. Populated only for PaymentType='PROMISE_TO_PAY'.

Field

Description

refId

Ref ID of the Payment.

paymentNo

Number of the Payment (generated by RM module).

externalPaymentNo

External number of the Payment (generated by external system, e.g. Bank or Payment Gateway).

paymentType

Type of the Payment.

paymentMethod

Payment Method.

paymentAmount

Amount of the Payment.

currency

Currency of the Payment.

paymentDateReceived

Date/Time when Payment was received on provider’s bank account. Valid only for incoming payments.

paymentDateSent

Date/Time when Payment was sent from payer’s bank account (Incoming) from provider’s bank account (Outgoing).

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.

bankAccountNumber

Payer’s (Billing Account) bank account number, including prefix, without bank number code.

bankNumberCode

Payer’s (Billing Account) bank number code.

iban

Payer’s (Billing Account) bank account number in international format.

bic

Payer’s (Billing Account) BIC code of the bank.

bankAccountName

Payer’s (Billing Account) bank account name.

moneyOrder

Payer’s (Billing Account) Person and Address details in case Payment is transferred as Money Order

recipientNote

Recipient’s note/description of the Payment. Valid only for incoming payments.

payerNote

Payer’s note/description of the Payment.

bankAccountNumberProvider

Provider’s bank account number, including prefix, without bank number code.

bankNumberCodeProvider

Provider’s bank number code.

ibanProvider

Provider’s bank account number in international format.

bicProvider

Provider’s BIC code of the bank.

bankAccountNameProvider

Provider’s bank account name.

paymentCreatedDate

Date/Time when Payment was created.

paymentCreatedBy

Identification of the user who creates the Payment.

paymentIdentifiedDate

Date/Time when Payment was lastly identified. Valid only for incoming payments.

paymentIdentifiedBy

Identification of the user who lastly idenfifed the Payment. Valid only for incoming payments.

paymentAssignedDate

Date/Time when Payment was lastly assigned.

paymentAssignedBy

Identification of the user who lastly assigned the Payment.

account

Foreign key to Account.

usedAmount

Amount used in case of amount transactions.

remainingAmount

Remaining amount of payment after using some amount in case of amount transactions.

paymentCancelledDate

Date/Time when Payment was cancelled.

paymentCancelledBy

Identification of the user who cancelled the Payment.

cancellationReason

Reason of cancellation.

cancellationAmount

Cancellation amount (= Remaining Amount at the time of Cancel).

edrFileLoader

ID of the EdrFileLoader processed the Incoming Payment or Outgoing Payment.

edrFileExtractor

ID of the EdrFileExtractor processed the Outgoing Payment Request.

edrFile

ID of the EdrFile where Payment was loaded from.

promisedPaymentRefId

Ref ID of the Promised Payment done via OnLine channels. Populated only for PaymentType='PROMISE_TO_PAY'.

promisedPaymentDueDate

Date/Time Due of the Promised Payment. Populated only for PaymentType='PROMISE_TO_PAY'.

Detailed API documentation and endpoint specifics are available here.