Payment History

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

Business Transaction Overview

Headers of the PaymentHistory Business Transaction Message

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

Header Description Value

X-Ocs-Io-transaction-id

ID of the transaction.

X-Ocs-Io-message-code

Code of the Message.

paymentHistory

X-Ocs-Io-message-payload

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

PaymentHistoryEx

Fields of the PaymentHistoryEx Business Transaction Payload

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

Field Description

refId

Ref ID of the PaymentHistory.

operationType

Type of the Operation. Enumerated value - 'CREATED' = 'Created', 'UPDATED' = 'Updated'.

operationCode

Code of the Operation.

createdDate

Date/Time when History Entry was created.

createdBy

Identification of the user who created the History Entry.

operationParameters

Parameters of the Operation as HashMap.

paymentType

Type of the Payment.

  • 'IN' - Incoming payment.

  • 'OUT' - Outgoing payment.

  • 'PROMISE_TO_PAY' - Promise to Pay, payed OnLine.

  • 'PAYMENT_OUT_REQ' - Request for Outgoing Payment.

paymentRefId

Payment Ref ID.

effectiveDate

Effective Date/Time of the Operation.

refPaymentType

Type of the Referenced Payment.

  • 'IN' - Incoming payment.

  • 'OUT' - Outgoing payment.

  • 'PROMISE_TO_PAY' - Promise to Pay, payed OnLine.

  • 'PAYMENT_OUT_REQ' - Request for Outgoing Payment.

refPaymentRefId

Referenced Payment Ref ID.

refDocumentRefId

Referenced Document Ref ID.
Detailed API documentation and endpoint specifics are available here.

List of Messages

operationType operationCode Description Reference

CREATED

PAYMENT_IN_CREATED

Published when Incoming Payment is created.

UPDATED

PAYMENT_IN_UPDATED

Published when Incoming Payment is updated.

UPDATED

PAYMENT_IN_CANCELLED

Published when Incoming Payment is cancelled.

UPDATED

PAYMENT_IN_IDENTIFIED

Published when Incoming Payment is identified.

UPDATED

PAYMENT_IN_UNIDENTIFIED

Published when Incoming Payment’s Identification is removed.

UPDATED

PAYMENT_IN_PAIRED_DOCUMENT

Published when Incoming Payment is paired with Document.

Document

UPDATED

PROMISE_2_PAY_PAIRED_DOCUMENT

Published when Promise to Pay is paired with Document.

Document

UPDATED

PROMISE_TO_PAY_PAIRED_PAYMENT

Published when Promise to Pay is paired with Incoming Payment.

Event is published for each party (Promise to Pay & Incoming Payment).

Incoming Payment

UPDATED

PAYMENT_IN_UNPAIRED

Published when Incoming Payment’s pairing with Document is removed.

Document

UPDATED

PROMISE_2_PAY_CANCELLED

Published when Promise to Pay is cancelled.

CREATED

PAYMENT_OUT_CREATED

Published when Outgoing Payment is created.

UPDATED

PAYMENT_OUT_UPDATED

Published when Outgoing Payment is updated.

UPDATED

PAYMENT_OUT_CANCELLED

Published when Outgoing Payment is cancelled.

UPDATED

PAYMENT_OUT_IDENTIFIED

Published when Outgoing Payment is identified.

UPDATED

PAYMENT_OUT_REQ_PAIRED

Published when Outgoing Payment Request is paired with Outgoing Payment.

Event is published for each party (Outgoing Payment Request & Outgoing Payment).

Outgoing Payment

UPDATED

PAYMENT_OUT_REQ_CANCELLED

Published when Outgoing Payment Request is cancelled.