Guides
R24 AMR | Min(s) read

External Interfaces Mapping

TPH interacts with external interfaces for various functions as explained in previous sections. For each of these interactions, a request is sent to the external system to which a response is received from the external system. These request and response messages have a pre-defined template, file format and Critical Data Elements, that should be mapped to TPH tables. This is required because certain transaction specific details are sent to external system to process and respond back with requisite information. Below given are the request and response mapping for each of the external interaction message mapping to TPH tables.

Account Validation

Payment engine sends the following details as part of the account validation request to the external account and customer application.

Request Data

Description

Unique Request ID

Unique Request Identifier

Transaction Reference

Unique transaction reference of the payment

Debit Credit Indicator

D: Debit Main account

DC: Debit Charge Account

C: Credit Main Account

CC: Credit Charge Account

Processing Company Code

Processing company of the transaction. This field is mandatory. This is the company code used within the payment engine. This code can be different from the code used in the external application. ESB is responsible for mapping the TPH company ID to external System company ID.

Account owning Company Code

TPH Company ID owing the account. If the company code is attached to the requested account as part of the payment instruction, then this field will be filled with the requested company code. Else it will be blank. ESB is responsible for mapping the TPH company ID to external System company ID.

BBAN Account Number

The BBAN account number that needs to be validated

If the account number in is an IBAN then the BBAN will be retrieved and sent to the external application.

IBAN Account number

If the account number in the payment instruction is an IBAN then it must be sent in this field. This is an optional field.

Account Currency

The currency of the requested account (if known).

This is an optional input and can be blank. If the value of this field is populated, then the DDA must check for the account in the specified currency.

Transaction Code

It Identifies the book code for the transaction debit entry in the general ledger. It can be used to check if there are any restrictions on the account for the product

For debit main account, debit book code will be used and for the debit charge account, debit charge book code will be used. Both these codes are output of product determination in TPH. This field will not always be available.

For credit main account, credit book code will be used and for the credit charge account, credit charge book code will be used. Both these codes are output of product determination in TPH. This field will not always be available.

 

This is an optional input and can be blank.

Transaction Currency

Currency of the Transaction.

Transaction Amount

Transaction amount of the payment.

Cheque Number

Cheque number as present in the payment instruction. It will be present only for incoming cheque debit payments.

Cheque Type

Cheque Type (if any) defined for the cheque debit transaction in TPH.

DDA system

 

Bank Specific Fields

Banks may pass their bank specific inputs and receive corresponding outputs in Bank specific output fields.

** TPH must have a mechanism in place to map the bank specific fields as part of the request details.

Manual Authorisation required flag

If this flag is set, Temenos Transact will retain the reservation request for manual authorization even if there is insufficient funds in the account to cover the payment.

The following table describes the details that external application sends as a response to the account validation and customer information request.

Response Data

Description

Unique Reference

Request Identifier that was sent as part of the request.

Transaction Reference

Unique transaction reference of the payment that was sent as part of the request.

Processing Company Code

Processing company code of the payment that was sent as part of the request.

ESB is responsible for mapping the external company ID to TPH company ID.

Debit Credit Indicator

D: Debit Main account

DC: Debit Charge Account

C: Credit Main Account

CC: Credit Charge Account

This indicator is also sent as part of the request.

Account Details

Description

Account Company

The company owning the account returned as response.

ESB is responsible for mapping the external company ID to TPH company ID.

Account Number

The account number returned as response from the external application.

Account Currency

The account currency of the account returned as response from the external system.

Account Status

This field indicates the status of the account in the DDA.

 

Account Type

This field indicates the type of the account. Following are the types used in TPH.

  • V: Vostro Account
  • N: Nostro Account
  • I: Internal Account
  • C: Customer Account
  • PL: Profit & Loss Account

Related IBAN

It is the IBAN of the requested account number.

Customer Details

Description

Customer ID

It is the unique customer identifier of the account owner. One customer can hold multiple accounts.

It is used for retrieving the client agreement and charges in TPH. It is also sent to the general ledger as part of the posting entry line.

Name 1

Name 1 of the customer

Name 2

Name 2 of the customer

Beneficiary Name 1 (multi value) Name 1 of the Joint customers. It is used to perform beneficiary name comparison using Temenos Name Check service.
Beneficiary Name 2 (multi value) Name 2 of the Joint customers. It is used to perform beneficiary name comparison using Temenos Name Check service.

Address Line 1

Address Line 1 of the customer

Address Line 2

Address line 2 of the customer

Town Country

Town Country of the customer

Postal Code

Postal Code of the customer

Country

Country of the customer

Preferred Language

Language in which the customer wishes to receive its statement lines. Currently not used in TPH (future use).

E.g.: EN

Sector

It is the sector code of the customer. This field indicates if the customer is a corporate, financial institution, individual etc.

It can be used for billing purpose.

Account officer

It is the account officer of the customer.

It will be part of the posting line entry (department code) to the general ledger and will be useful in reporting.

Target (Business Line)

The business line of the account. This is used while looking up the client conditions and client charges table in TPH.

Residence

It indicates the country of residency of the account owner.

It will be used within TPH while calculating client charges.

Confirmation Details

        Description

Email ID

Email ID where the advice of the debit or credit will be sent. If an Email ID is defined in client conditions, then that will be used instead of the ID defined in the DDA.

Customer Phone Number

This the phone number where SMS alerts will be sent in case of a debit or credit. If SMS number is defined in client conditions, then that will be used instead of the number defined in the DDA.

BIC Code

It is the BIC where the transaction advice must be sent (MT900 and MT910). If a BIC is defined in client conditions, then that will be used instead of the BIC defined in the DDA.

Custom Data

        Description

Bank Specific fields

Based on each bank’s requirement, custom data (bank specific) can be received from the external application in this section.

Result Details

        Description

Result

  • OK: Account is present and can be used for processing.
  • NOK: Account is not present. If present but still cannot be used for processing because it is closed or inactive or has posting/activity restrictions.

**Refer to section 3.2.7.1.1 for more details on the scenarios for the response statuses

Rejected Reason

This field holds the reason for the NOK (result reason for failure).

Informational Messages (list)

This field will hold all the informational messages received from the external system that have to be logged in the history log section of the payment.
E.g.: The account status is inactive but can still be used for processing .Inactive details will be sent by the external DDA as informational message as it does not impact payment processing.

Error Code

This field can be filled by the external system when the result is NOK (optional).

ESB is responsible for mapping External error code to TPS Error Code.

If the result is NOK and if the external system does not send an Error code then TPH will raise a default error code for this interaction.

Funds Check and Reservation

Request Details

Description

Unique Request ID

Unique Request Identifier

Processing Company Code

Processing company of the transaction. This field is mandatory.

This is the company code used within the payment engine. This code can be different from the code used in the external application.

ESB is responsible for mapping the TPH company ID to external System company ID.

Transaction Reference

Unique transaction reference of the payment for which these posting lines are generated.

This field is mandatory.

Debit Account Company

Company owning the debit account number.

This is the company code used within the payment engine. This code can be different from the code used in the external application.

Mapping of the TPH Company ID to external System Company ID should be handled in the transformation or integration layer (via ESB).

Debit Account Number

Account for which the balance must be checked and reserved.

Debit Account Currency

Currency of the debit account number.

Reservation Amount

Amount that has to be reserved. This is in the currency of the debit account.

This amount includes the transaction amount in debit account currency and the charges (if any) in the debit account currency.

Transaction Amount

Amount of the payment transaction.

Transaction Currency

Currency of the payment transaction.

Reservation Request Date

Current business date of the processing company.

Debit Booking Code

This is the general ledger booking code for the product for the debit account.

This field is passed so that the general ledger can perform any account restrictions on the debit account before performing balance check.

Old Reservation Reference

Reservation reference received from the external system when the previous reservation was made on the account.
*** If it is a new reservation then this field will be empty.

Old Reservation Account Number Company

The company code of the account on which the old reservation was made.
This is the company code used within the payment engine. This code can be different from the code used in the external application.
Mapping of the TPH Company ID to external System Company ID should be handled in the transformation or integration layer (via ESB).

*** If it is a new reservation then this field will be empty.

Old Reservation Account Number

Account on which the previous reservation was made.
*** If it is a new reservation then this field will be empty.

Old Reservation Account Currency

Currency of the account on which the previous reservation was made.
*** If it is a new reservation then this field will be empty.

Old Reservation amount

Amount that was reserved previously for this transaction.
*** If it is a new reservation then this field will be empty.

Duplicate Request Flag
  • Blank: Not a duplicate request
  • Y: Duplicate request for this transaction

This must be set to Y when a duplicate request for the transaction is sent to the external system.

Custom Data

        Description

Cheque Number

Cheque Number as present in the payment instruction. It will be present only for incoming cheque debit payments.

Will be present only when cheque type is present in the transaction.

Cheque Type

Cheque Type (if any) defined for the cheque debit transaction in TPH.

Will be present only when cheque number is present in the transaction.

Bank Specific fields

Based on each bank’s requirement, custom data (bank specific) can be sent to the external system.

The following table describes the details that external application sends as a response for a funds reservation request.

Response Data

Description

Unique Reference

Request Identifier that was sent as part of the request.

Transaction Reference

Unique transaction reference of the payment that was sent as part of the request.

Processing Company Code

Processing company of the transaction.
This is the company code used within the payment engine.

Mapping of the TPH Company ID to external System Company ID should be handled in the transformation or integration layer (via ESB).

Response Details

Description

Reservation Reference

This will hold the reservation key if the reservation request was approved.

This field will only be filled when the response status is ‘A’.

Result Details

      Description

Result

  • OK: Success (Balance is reserved on the account).
  • NOK: Failure (Balance is not available on the account and so not reserved).

Rejected Reason

This field holds the reason for rejecting the funds reservation request.

Only present if response status is 'NOK' (Rejected).

Informational Messages

This field will hold all the informational messages received from the external system that have to be logged in the history log section of the payment.
E.g. : When old reservation has to be deleted and new reservation has to be made ;If new reservation was successful (status ='A') but cancellation of old reservation was unsuccessful then it can be mentioned in this field.

Error Code

This field can be filled by the external system when the result is NOK (optional).

Mapping of the TPH Company ID to external System Company ID should be handled in the transformation or integration layer (via ESB).

If the result is NOK and if the external system does not send an Error code, then TPH will raise a default error code for this interaction.

Sanction Screening

Request Details

Description

 All payment details stored in Temenos Payments

Request holds all payment attributes which has values for the payment in Temenos Payments.

Original payment message

Holds the original payment message (body).

The response received has the following details.

Response Details

Description

Application Name

Filtering component sends the response with the application name ‘DISPO.ITEMS’, which is available as a part of the response format. Although, Temenos Payments consumes only the status details. It does not create or update based on this attribute.

FTNumber* Company Code

ID of the POR.SCREENINGREQUESTS record, where the response details are saved.

Dispo Status

The following values are available:

  • Approved - For no or false hit
  • Possible - For possible hit
  • Rejected - For true hit

General Ledger Posting

Request Details

Description

Unique Request ID

Unique Request Identifier

Processing Company Code

Processing company of the transaction. This field is mandatory.

This is the company code used within the payment engine. This code can be different from the code used in the external application.

Mapping of the TPH Company ID to external System Company ID should be handled in the transformation or integration layer (via ESB).

Transaction Reference

Unique transaction reference of the payment for which these posting lines are generated. This field is mandatory.

Action Flag

  • BR: Check the balance and raise the accounting entries.
  • RA: Only raise the accounting entries ( no need to check for funds availability).

Force Flag

  • Blank: Booking must not happen if there is no sufficient funds or has new restrictions after reservation was made on the account.
  • Y: Booking must always happen if there is no sufficient funds or has new restrictions after reservation was made on the account.
  • Phase 1: This field will be blank.

Debit Account Number Company ID

Company owning the debit account number.

This is the company code used within the payment engine. This code can be different from the code used in the external application.

Mapping of the TPH Company ID to external System Company ID should be handled in the transformation/integration layer (via ESB).

Will be present only when action flag is ‘BR’.

Debit Account Number

Account for which the balance must be checked.

Will be present only when action flag is ‘BR’.

Debit Account Number Currency

Currency of the debit account number.

Will be present only when action flag is ‘BR’.

Reservation Amount

Amount that has to be reserved. This is in the currency of the debit account.

This amount includes the transaction amount in debit account currency and the charges (if any) in the debit account currency.

Will be present only when action flag is ‘BR’.

Transaction Amount

Amount of the payment transaction.

Will be present only when action flag is ‘BR’.

Transaction Currency

Currency of the payment transaction.

Will be present only when action flag is ‘BR’.

Preauthorised Key

If the balance on the account was pre-approved, then this field will hold the reference for it.

Will be present only when action flag is ‘RA’ and a pre-approved reservation key is present in the payment transaction.

**GL is responsible for interfacing with the DDA to cancel the pre-approved reservation (if any).

Debit Account Reservation Key Details

(Reservation Amount, Reservation account currency, Reservation account company code, Reservation Requested date)

This field will contain the reservation details for the main debit account This field will be populated only if reservation was made as part of balance check process step. This is required to be sent to the ledger system to cancel the reservation made on the debit account.

This field is optional.

Will be present only when reservation key is present, and the action flag is ‘RA’ AND GL & DDA reside in the same application.

IF GL & DDA reside in the same application then GL is responsible for interfacing with the DDA to cancel the reservation (if any).

Debit Booking Code

This is the general ledger booking code for the product for the debit account.

This field is passed so that the general ledger can perform any account restrictions on the debit account before performing balance check.

Posting Line Count

Number of posting lines passed by TPH to the external application.

This field is mandatory.

Duplicate Request Flag
  • Blank: Not a duplicate request
  • Y: Duplicate request for this transaction

This must be set to Y when a duplicate request for the transaction is sent to the external system.

Cut Off Date

Booking date of the transaction.

Custom Data

Description (Bank Specific)

Channel Cut off Time

Cut off time of the channel.

DDA must consider the cut off time before making the booking as TPH will not check if cut off time as passed after the response is received from the posting for a successful booking.

Priority

This field indicates the priority of the transaction.

  • N: Normal
  • U: Urgent

Direction

This field indicates the direction of the transaction.

  • B: Book Transfer
  • O: Outbound
  • I: Inbound
  • R: Redirected

Cheque Number

Cheque Number as present in the payment instruction. It will be present only for incoming cheque debit payments.

Will be present only when cheque type is present in the transaction.

Cheque Type

Cheque Type (if any) defined for the cheque debit transaction in TPH.

Will be present only when cheque number is present in the transaction.

Posting Line Details

Description (Repetitive 2…n)

Posting Line Number

The number to identify each posting line passed by TPH to the external application.

This field is mandatory.

Account Number Company ID

This is the company code of the account which is being debited or credited.

This is the company code used within the payment engine. This code can be different from the code used in the external application.

Mapping of the TPH Company ID to external System Company ID should be handled in the transformation or integration layer (via ESB).

This field is mandatory.

Account Number

This is the account to which this entry is posted.

This field is mandatory.

Account Currency

This field holds the currency code of the account.

This field is mandatory.

Posting Line Debit Credit Indicator

This field indicates if the account is debited or credited as part of the booking entry.

  • D: Debit Posting
  • C: Credit Posting

This field is mandatory.

Posting Amount

This is the amount for this posting entry.

This field is mandatory.

Posting Amount Currency

This is the currency of the above-mentioned account.

This field is mandatory.

Posting Amount Local Currency

This is posting amount converted into local currency equivalent amount.

This field is mandatory.

Local Currency Code

This is the local currency code for the owning bank in the ledger.

This field is mandatory.

Booking Date

This is the booking date for this posting entry.

This field is mandatory.

Value Date

This is the value date for this posting entry, which could be in future as well.

This field is mandatory.

Exposure Date

This is the date from which funds are available to the party for withdrawal.

This field is optional.

Booking Code

This is the booking date for this posting entry.

This is the booking code which should be used inside for this posting entry to identify the type of entry.

This field is mandatory

Posting Type Flag

This indicates the type of posting.

  • M: Main / Principal amount debited or credited
  • C: Charges being debited (for P&L as well)
  • O: OCP posting

Our Reference

This is the Account Servicing Institution's Reference that can be used in sub tag 8 of tag 61 of MT940.

Account Owner Reference

This is the reference for the account owner that will be used in sub tag 7 of tag 61 of MT940.

Supplementary Details

This is the supplementary details used in sub tag 9 of tag 61 of MT940.

Custom Data of the Posting Line

Description (Banks can have their own logic to populate these fields)

Currency Market

When currency conversion is involved (debit account currency is different from credit account currency), this field will denote the market from which the currency rates were applied to arrive at the non-local currency amount.

Dealer Desk

This can help the general Ledger to identify the right accounts that can be used for intra branch bookings or open currency position entries.

Department Code

Department against which payment postings have to be booked to be used by GL later in reporting. This shall be populated by Account Officer code as returned by account & customer database during account validation.

Client ID

This is the client ID (customer number) of the account that is debited or credited.

Swift Transaction Type Code

This is the SWIFT Transaction Type Code which will be reported in Tag61 of MT940.

Statement Line Details

Description (Repetitive: 0…n)

Statement Line Number

As there can be multiple statement entries for a single posting line, this field indicates the sequence of statement line.

Statement Line

The field contains the statement line (transaction details) for the associated posting line.

Line Continuity Flag

This can be used by the general ledger while generating statement lines to decide whether to truncate or continue in the next line if the statement line exceeds the allowed number of characters by the statement generation system.

  • Y: Continue in the next line
  • N: Truncate

This field can be blank.

The following table describes the details that external application sends as a response for a check balance & posting request.

Response Data

Description

Unique Reference

Request Identifier that was sent as part of the request.

Transaction Reference

Unique transaction reference of the payment that was sent as part of the request.

Processing Company Code

Processing company of the transaction.
This is the company code used within the payment engine.
ESB (Integration framework) is responsible for mapping the external company ID to TPH company ID.

Posting Details

Description

Posting Reference IDS

This will be hold the account entry ids generated in the external ledger .

This is required when TPH sends a reverse request to the general ledger for reversing previously raised accounting entries.

Result Details

Description

Result
  • OK: Approved – Accounting entries raised successfully.
  • NOK: Rejected – Accounting entries were not raised as sufficient balance is not available on the main debit account or account was closed or had posting restrictions.
  • RETRY: Retry – Posting could not be performed because the channel cut off time has passed. This should be the only reason.

Rejected Reason

This field holds the reason for not able to perform the posting entries or reverse the posting entries.

Only present if response status is 'NOK' (Rejected).

Informational Message

If accounting entries have been successfully raised but there is any informational message which is not an error that the external system would like to the payment engine to log in the history log

(E.g.: When accounting entries have been raised successfully but the cheque status in the DDA could not be updated. Any informational message that did not functionally deter from making the accounting entries).

Error Code

This field can be filled by the external system when the result is NOK (optional)

Mapping of the TPH Company ID to external System Company ID should be handled in the transformation or integration layer (via ESB).

If the result is NOK and if the external system does not send an Error code, then TPH will raise a default error code for this interaction.

Reverse Posting

Request Details

Description

Unique Request ID

Unique Request Identifier

Processing Company Code

Processing company of the transaction. This field is mandatory.

This is the company code used within the payment engine. This code can be different from the code used in the external application.

Mapping of the TPH Company ID to external System Company ID should be handled in the transformation or integration layer (via ESB).

Transaction Reference

Unique transaction reference of the payment for which these posting lines are generated.

This field is mandatory.

Posting Reference IDs

The posting entries reference ids returned by the external system while accounting entries were raised in the general ledger.

Force Flag

This flag indicates if booking entries must still be reversed if the account has restrictions.

  • Y: Accounting entries must be reversed even if it has restrictions.
  • Blank: Accounting entries must not be reversed if it has restrictions.
  • Phase 1: This field will have the value ‘Y’.

Duplicate Request Flag
  • Blank: Not a duplicate request
  • Y: Duplicate request for this transaction

This must be set to Y when a duplicate request for the transaction is sent to the external system.

Original Posting Line Details

Description (Repetitive 2…n)

Posting Line Number

The number to identify each posting line passed by TPH to the external application.

This field is mandatory.

Account Number Company ID

This is the company code of the account which is being debited or credited.

This is the company code used within the payment engine. This code can be different from the code used in the external application.

Mapping of the TPH Company ID to external System Company ID should be handled in the transformation or integration layer (via ESB).

This field is mandatory.

Account Number

This is the account to which this entry is posted.

This field is mandatory.

Account Currency

This field holds the currency code of the account.

This field is mandatory.

Posting Line Debit Credit Indicator

This field indicates if the account is debited or credited as part of the booking entry.

  • D: Debit Posting
  • C: Credit Posting

This field is mandatory.

Posting Amount

This is the amount for this posting entry.

This field is mandatory.

Posting Amount Currency

This is the currency of the above-mentioned account.

This field is mandatory.

Posting Amount Local Currency

This is posting amount converted into local currency equivalent amount.

This field is mandatory.

Local Currency Code

This is the local currency code for the owning bank in the ledger.

This field is mandatory.

Booking Date

This is the booking date for this posting entry.

This field is mandatory.

Value Date

This is the value date for this posting entry, which could be in future as well.

This field is mandatory.

Exposure Date

This is the date from which funds are available to the party for withdrawal.

This field is optional.

Booking Code

This is the booking date for this posting entry.

This is the booking code which should be used inside for this posting entry to identify the type of entry.

This field is mandatory.

Posting Type Flag

This indicates the type of posting.

  • M: Main / Principal amount debited or credited
  • C: Charges being debited (for P&L as well)
  • O: OCP posting

Our Reference

This is the Account Servicing Institution's Reference that can be used in sub tag 8 of tag 61 of MT940.

Account Owner Reference

This is the reference for the account owner that will be used in sub tag 7 of tag 61 of MT940.

Supplementary Details

This is the supplementary details used in sub tag 9 of tag 61 of MT940.

Custom Data of the Posting Line

Description (Banks can have their own logic to populate these fields)

Currency Market

When currency conversion is involved (debit account currency is different from credit account currency), this field will denote the market from which the currency rates were applied to arrive at the non-local currency amount.

Dealer Desk

This can help the general Ledger to identify the right accounts that can be used for intra branch bookings or open currency position entries.

Department Code

Department against which payment postings have to be booked to be used by GL later in reporting. This shall be populated by Account Officer code as returned by account & customer database during account validation.

Client ID

This is the client ID (customer number) of the account that is debited or credited.

Book Code

Place holder for future use.

Swift Transaction Type Code

This is the SWIFT Transaction Type Code which will be reported in Tag61 of MT940.

Statement Line Details

Description (Repetitive: 0…n)

Statement Line Number

As there can be multiple statement entries for a single posting line, this field indicates the sequence of statement line.

Statement Line

The field contains the statement line (transaction details) for the associated posting line.

Line Continuity Flag

This can be used by the general ledger while generating statement lines to decide whether to truncate or continue in the next line if the statement line exceeds the allowed number of characters by the statement generation system.

  • Y: Continue in the next line
  • N: Truncate

This field can be blank.

The following table describes the details that external application will send as a response for a reverse posting entries request.

Response Data

Description

Unique Reference

Request Identifier that was sent as part of the request.

Transaction Reference

Unique transaction reference of the payment that was sent as part of the request.

Processing Company Code

Processing company of the transaction.
This is the company code used within the payment engine.

Mapping of the TPH Company ID to external System Company ID should be handled in the transformation or integration layer (via ESB).

Posting Details

Description

Posting Reference IDS

This will hold the account entry ids generated in the external ledger while reversing the accounting entries.

 

Result Details

Description

Result
  • OK: Approved – Accounting entries reversed successfully
  • NOK: Rejected – Accounting entries could not be reversed

Rejected Reason

This field holds the reason for not able to reverse the posting entries.

Only present if response status is 'R' (Rejected).

Informational Message

If accounting entries have been successfully reversed but there is any informational message which is not an error that the external system would like to the payment engine to log in the history log.

Cancel Reservation

Cancel Reservation request is sent to the external system to undo the reservation that was made on the account by a fund reservation request from the payment system.

Request Details

Description

Unique Request ID

Unique ID generated to identify the request sent to the external system.

Processing Company Code

Processing company of the transaction. This field is mandatory.

This is the company code used within the payment engine. This code can be different from the code used in the external application.

Mapping of the TPH Company ID to external System Company ID should be handled in the transformation or integration layer (via ESB).

Transaction Reference

Unique transaction reference of the payment for which these posting lines are generated.

This field is mandatory.

Reserved account number company ID

Company owning the reserved account number.

This is the company code used within the payment engine. This code can be different from the code used in the external application.

Mapping of the TPH Company ID to external System Company ID should be handled in the transformation or integration layer (via ESB).

Reserved account number

Account for which reservation was previously performed and needs to be undone now.

Reserved account number Currency

Currency of the account number for which reservation was previously performed and needs to be undone now.

Reservation date

Date when the reservation request was made in the system.

Reservation Reference

Reservation reference received from the external system when the reservation was made on the account.

Transaction Amount

Transaction amount of the payment

Transaction Currency

Transaction currency of the payment

Duplicate Request Flag
  • Blank: Not a duplicate request
  • Y: Duplicate request for this transaction

This must be set to Y when a duplicate request for the transaction is sent to the external system.

The following table describes the details that external application will send as a response for a cancel funds reservation request.

Response Data

Description

Unique Reference

Request Identifier that was sent as part of the request.

Transaction Reference

Unique transaction reference of the payment that was sent as part of the request.

Processing Company Code

Processing company of the transaction.
This is the company code used within the payment engine.
ESB is responsible for mapping the external company ID to TPH company ID.

Result Details

Description

Result

  • OK: Cancellation was successful
  • NOK: Cancellation was not successful

Informational Messages (List)

This field will hold all the informational messages received from the external system that have to be logged in the history log section of the payment.

Mandate Validation

Payment engine must send the following details as part of the mandate validation request to the external direct debit mandate system.

Request Data

Description

Unique Request ID

Unique Request Identifier

Transaction Reference

Unique transaction reference of the payment

Processing Company Code

Processing company of the transaction. This field is mandatory.

This is the company code used within the payment engine. This code can be different from the code used in the external application.

Mapping of the TPH Company ID to external System Company ID should be handled in the transformation or integration layer (via ESB).

Auto Register Flag

This flag indicates that the external DD system must register the mandate if it is not present.

  • Y: Auto Register
  • N: Do not auto Register

Mandate Limit Check Flag

This flag indicates that the external DD system must check for mandate limit checks for the DD payment.

  • Y: Perform Mandate Limit check
  • N: Do not perform mandate limit check.

Creditor Restriction Fag

This flag indicates that the external DD system must validate the DD payment details against creditor black list and white list.

  • Y: Validate against creditor black list and white list.
  • N: Do not perform any creditor validation

Clearing Id 

This field indicates the source of the incoming DD payment (e.g. STEP2, BACS, etc.).

Payment Type Service level code

This field indicates the scheme of the DD payment (e.g. CORE or B2B).

Settlement Date

This field indicates when the direct debit must be collected from the debtor.

Mandate Reference

This field indicates the mandate reference of the collection to use while looking up the mandate in DD management system.

Mandate reference that must be used for auto registration if the mandate does not exist

Creditor ID

This field indicates the Creditor Identifier of the collection to use while looking up the mandate in DD management system.

Mandate reference that must be used for auto registration if the mandate does not exist.

Original Mandate Reference

If the mandate reference was updated as part of the direct debit collection, then this field will contain the original mandate reference.

Original Creditor ID

If the creditor ID was updated as part of the direct debit collection, then this field will contain the original mandate reference.

Debtor Bank BIC

BIC of the debtor bank.

Debtor Bank National Clearing Code

National Clearing Code of the debtor bank.

Debtor Account Number

Debtor’s account number mention in the direct debit collection.

Debtor Name

Debtor’s name

Debtor Address Line 1

Address Line 1 of the debtor

Debtor Address Line 2

Address Line 2 of the debtor

Debtor Country

Country of the debtor

Creditor account number

Account number of the creditor.

Creditor name

Creditor’s name

Amended Creditor Name

New name of the creditor, if it was changed as part of the direct debit collection.

Credit Bank National Clearing Code

National Clearing Code of the Creditor Bank

Creditor Bank BIC

BIC of the Creditor Bank

Creditor Address Line 1

Address Line 1 of the creditor

Creditor Address Line 2

Address Line 2 of the creditor

Country of the Creditor

Country of the Creditor

Sequence type

Sequence type of the direct debit collection: First, last, one off or recurrent

Date of Signature

Date of signature of the mandate

Transaction Amount

Amount of the direct debit collection

Transaction Currency

Transaction Currency of the direct debit collection

Duplicate Request Flag
  • Blank: Not a duplicate request
  • Y: Duplicate request for this transaction

This must be set to Y when a duplicate request for the transaction is sent to the external system.

Custom Data

Description

Banks may pass their bank specific inputs and receive corresponding outputs in Bank specific output fields.

Banks may pass their bank specific inputs and receive corresponding outputs in Bank specific output fields.

Response Data

Description

Unique Reference

Request Identifier that was sent as part of the request.

Transaction Reference

Unique transaction reference of the payment that was sent as part of the request.

Mandate Details

Description

Debtor Account Number

Account number registered against the mandate in the external system. This is required for mandate details validation in TPH.

Debtor Bank BIC

BIC of the debtor bank – Optional. If present is required for mandate validation in TPH.

Debtor Bank National Clearing Code

National clearing code of the debtor bank (Optional). If present is required for mandate validation in TPH.

Transaction Type

This field indicates if the direct debit is one off or recurrent. This is required for mandate details validation in TPH.

Mandate Auto Registered

This field indicates if the Mandate was auto registered or not when mandate was not present in the system based on Auto Register Flag in the request details.

  • Y: Mandate was auto-registered
  • Blank: Mandate was not auto-registered

Mandate Custom Data

Description

Identification Code of the Scheme

Scheme of the direct debit. B2B or CORE (optional). If present is required for mandate validation in TPH.

Bank Specific Details

Any custom data will be passed by the external system that will be required for mandate details validation in TPH.

Result Details

Description

Result
  • OK: Mandate exist or was auto registered (if not present) and Mandate Limit Validation was successful (based on input flag) and credit restriction validation was successful (based on input flag).
  • NOK: Mandate does not exist, or mandate limit validation failed (which is based on input flag) or credit restriction validation failed (which is based on input flag).

Rejected Reason

This field holds the reason for failure of Mandate validation or Mandate Limit check Failure or Credit Restriction Failure.

Only present if response status is ‘NOK’.

Informational Message (List)

This field will hold all the informational messages received from the external system that have to be logged in the history log section of the payment.

Error Code

This field can be filled by the external system when the result is NOK (optional).

Mapping of the TPH Company ID to external System Company ID should be handled in the transformation/integration layer (via ESB).

If the result is NOK and if the external system does not send an Error code then TPH will raise a default error code for this interaction.

Mandate Modification

Request Data

Description

Unique Request ID

Unique Request Identifier

Transaction Reference

Unique transaction reference of the payment

Processing Company Code

Processing company of the transaction. This field is mandatory.

This is the company code used within the payment engine. This code can be different from the code used in the external application.

Mapping of the TPH Company ID to external System Company ID should be handled in the transformation or integration layer (via ESB).

Cancel Mandate Flag

This field indicates if the mandate has to be canceled or not when the collection is one off or final.

  • Y: status has to be updated
  • N: status does not have been updated

Amend Flag

This field indicates if the mandate details in the system have to be amended or not with the amended details present in the direct debit collection.

  • Y: Have to be amended
  • N: Do not have to be amended

Update Col Date Flag

This field indicates if the mandate‘s last collection date has to be updated or not with the collection date.

  • Y: Have to update the collection date.
  • N: Do not have to update the collection date.

Mandate Limit Update Flag

This field indicates if the mandate‘s limit record has to be updated or not by increasing the number of transactions by count of 1.

  • Y: Have to update the limit record
  • N: Do not have to update the limit record

Clearing Id 

This field indicates the source of the incoming DD payment (e.g. STEP2, BACS etc.).

Mandate Reference

Mandate reference used to retrieve the mandate record.

If the mandate was not auto registered and the bank would like to amend the details in the system, then the original mandate reference must be sent if the mandate reference was updated as part of the collection.

If the mandate was auto registered or the bank expects the debtor to inform the debtor bank of the mandate changes then the mandate reference mentioned in the direct debit collection must be sent.

Creditor identifier.

Creditor ID used to retrieve the mandate record.

If the mandate was not auto registered and the bank would like to amend the details in the system, then the original creditor ID must be sent if the creditor ID was updated as part of the collection.

If the mandate was auto registered or the bank expects the debtor to inform the debtor bank of the mandate changes then the creditor ID mentioned in the direct debit collection must be sent.

Payment Type Service level code

This field indicates the service level code of the direct debit collection (SEPA or BACS or USACH).

Direct Debit Scheme

This field indicates the scheme of the direct debit (e.g. B2B or CORE).

Amended Details

Description

New Mandate Reference

New mandate reference if it was amended as part of the collection else this field can be left blank.

New Creditor ID

New creditor ID if it was amended as part of the collection else this field can be left blank.

New Creditor Name

New creditor name if it was amended as part of the collection else this field can be left blank.

New Debtor Account number

New debtor account number if it was amended as part of the collection else this field can be left blank.

Bank Specific fields

Based on each bank’s requirement, custom data (bank specific) can be sent to the external system.

Response Data

Description

Unique Reference

Request Identifier that was sent as part of the request.

Transaction Reference

Unique transaction reference of the payment that was sent as part of the request.

Processing Company Code

Processing company of the transaction.
This is the company code used within the payment engine.
Mapping of the TPH Company ID to external System Company ID should be handled in the transformation or integration layer (via ESB).

Result Details

Description

Result

  • OK: Mandate Details were updated successfully
  • NOK: Mandate Details were not updated successfully

Informational Messages (List)

This field will hold all the informational messages received from the external system that have to be logged in the history log section of the payment.

Reason for not able to update the mandate can be sent by the external system in this field.

Cancel Modification of Mandate

Request Data

Description

Unique Request ID

Unique Request Identifier

Transaction Reference

Unique transaction reference of the payment

Processing Company Code

Processing company of the transaction. This field is mandatory.

This is the company code used within the payment engine. This code can be different from the code used in the external application.

Mapping of the TPH Company ID to external System Company ID should be handled in the transformation or integration layer (via ESB).

Reopen Mandate Flag

This field indicates if the mandate has to be reopened or not.

  • Y: Have to reopen the mandate
  • N: Do not have to reopen

Mandate Limit Update Flag

This field indicates if the mandate‘s limit record has to be updated or not by decreasing the number of transactions by count of 1.

  • Y: Have to update the limit record
  • N: Do not have to update the limit record

Clearing Id 

The originating source of the payment.

Payment Type Service level code

This field indicates if it is a SEPA or a BACS or ACH direct debit.

Direct Debit Scheme

This field indicates the scheme of the direct debit (e.g. B2B or CORE).

Mandate Reference

Mandate reference used to retrieve the mandate record.

Mandate Reference mentioned in the direct debit collection.

Creditor identifier.

Creditor ID used to retrieve the mandate record.

Creditor ID mentioned in the direct debit collection.

Original Mandate Reference

Original mandate reference if the mandate reference was amended as part of direct debit collection else it will be blank.

Original Creditor Identifier.

Original Creditor identifier if the creditor identifier was amended as part of the direct debit else it will be blank.

Settlement Date

This field indicates when the direct debit must be collected from the debtor.

Custom Data

Description

Bank Specific fields

Based on each bank’s requirement, custom data (bank specific) can be sent to the external system.

Response Data

Description

Unique Reference

Request Identifier that was sent as part of the request.

Transaction Reference

Unique transaction reference of the payment that was sent as part of the request.

Result Details

Description

Result

  • OK: Mandate Details were updated successfully
  • NOK: Mandate Details were not updated successfully

Informational Messages (List)

This field will hold all the informational messages received from the external system that have to be logged in the history log section of the payment.

Reason for not able to update the mandate can be sent by the external system in this field.

Copyright © 2020- Temenos Headquarters SA

Contact Us

knowledge@temenos.com

Published on :
Thursday, May 30, 2024 11:31:13 AM IST