aplonHUB, Outgoing Target2 (RTGS) APIs Documentation

Table of contents



In this document, find the APIs that aplonHUB exposes so that core banking (or other upstream systems) need to call in order to work with outgoing CBPR+ payments.

Credit Transfers

PUT /t2/rtgs/customer/credit/transfer

Description:

This API is used to initiate a Target2 customer credit transfer.

Method: PUT

Endpoint: /t2/rtgs/customer/credit/transfer



Sample Request Body
{ "chargeBearer": "string", "chargesInformation": [ { "agent": { "financialInstitutionIdentification": { "bicfi": "string", "lei": "string" } }, "amount": { "currencyCode": "string", "value": 0 } } ], "creditor": { "name": "string", "postalAddress": { "addressLine": [ "string" ], "buildingNumber": "string", "country": "string", "streetName": "string", "townName": "string" } }, "creditorAccount": { "identification": { "iban": "string", "other": { "identification": "string", "schemeName": { "code": "string", "proprietary": "string" } } } }, "creditorAgent": { "financialInstitutionIdentification": { "bicfi": "string" } }, "debtor": { "name": "string", "postalAddress": { "country": "string", "streetName": "string", "townName": "string", "postalCode" : "string" } }, "debtorAccount": { "identification": { "iban": "string", "other": { "identification": "string", "schemeName": { "code": "string", "proprietary": "string" } } } }, "debtorAgent": { "financialInstitutionIdentification": { "bicfi": "string" } }, "exchangeRate": 0, "instructedAgent": { "financialInstitutionIdentification": { "bicfi": "string" } }, "instructedAmount": { "currencyCode": "string", "value": 0 }, "instructingAgent": { "financialInstitutionIdentification": { "bicfi": "string" } }, "interbankSettlementAmount": { "currencyCode": "string", "value": 0 }, "interbankSettlementDate": "string", "paymentIdentification": { "clearingSystemReference": "string", "endToEndIdentification": "string", "instructionIdentification": "string", "uetr": "string" }, "remittanceInformation": { "unstructured": [ "string" ] } }


Fields

Instructions or allowed values

Fields

Instructions or allowed values

code or proprietrary

One of code or proprietary fields should be used but not both in .

For codea 4 digit string should be used, while for proprietary a string up to 35 characters

 

iban or other

For agent identification the iban or the other property should be used , but not both.

chargeBearer

One of should be used DEBT, CRED, SHAR, SLEV

bicfi

11 digits BIC should be used

postalCode

When postal code is present in debtor’s or creditor’s address, country and town name should be also present and address line is not allowed.

Responses

Responses

Code

Description

200

OK



Sample Successful Response
{ "status": "OK", "payload": 150, "errorCode": null, "errors": null }
Failure Sample Responce
{ "status": "FAILURE", "payload": null, "errorCode": "INVALID_FORMAT", "errors": [ "Invalid field format for field uetr. Valid format is [0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab]{1}[0-9a-f]{3}-[0-9a-f]{12}." ] }
Failure Sample Responce
Failure Sample Responce
Failure Sample Responce


Failure Sample Responce


Failure Sample Responce

Failure Sample Responce
Failure Sample Responce
Failure Sample Responce

PUT /t2/rtgs/fi/credit/transfer

Description:

This API is used to initiate a Target2 financial institution credit transfer.

Method: PUT

Endpoint: /t2/rtgs/fi/credit/transfer

Sample Request Body

 

Fields

Instructions or allowed values

Fields

Instructions or allowed values

schemeName: code or proprietrary

One of code or proprietary fields should be used but not both in .

For codea 4 digit string should be used, while for proprietary a string up to 35 characters

 

identification: iban or other

For agent identification the iban or the other property should be used , but not both.

bicfi

11 digits BIC should be used

pacs009Type

CORE or COV

 

Responses

Responses

Code

Description

200

OK



Sample Successful Response



Failure Sample Responce



Failure Sample Responce
Failure Sample Responce
Failure Sample Responce
Failure Sample Responce
Failure Sample Responce
Failure Sample Responce



PUT /t2/rtgs/recall/request



Description:

This API is used to initiate a recall request for an outgoing Target2 credit transfer

Method: PUT

Endpoint: /t2/rtgs/recall/request



Sample Request Body



Responses

Responses

Code

Description

200

OK



Recall Request Reason Codes

Recall Request Reason Codes

DUPL

Payment is a duplicate of another payment.

CUTA

Cancellation requested because an investigation request has been received and noremediation is possible.

UPAY

Payment is not justified.

CUST

Cancellation requested by the debtor

CURR

Currency of the payment is incorrect.

AGNT

Agent in the payment workflow is incorrect

TECH

Cancellation requested following technical problems resulting in an erroneous transaction.

FRAD

Cancellation requested following a transaction that may have been originated fraudulently. The use of the "Fraudulent Origin" code should be governed by jurisdictions.

COVR

Cover payments has either been returned or cancelled.

AM09

Amount of the payment is incorrect.

NARR

Reason is provided as narrative information in the additional reason information.



Sample Successful Response



Failure Sample Responce



Failure Sample Responce



Failure Sample Responce



Failure Sample Response



Failure Sample Response

PUT /t2/rtgs/recall/request/accept

Description:

This API accepts an incoming recall request

Method: PUT

Endpoint: /t2/rtgs/recall/request/accept



Sample Request Body



Return Reason Codes

Return Reason Codes

Code

Description

AC01

Format of the account number specified is not correct

AC02

Debtor account number invalid or missing

AC03

Wrong IBAN in SCT

AC04

Account number specified has been closed on the bank of account's books

AC06

Account specified is blocked, prohibiting posting of transactions against it

AC07

Creditor account number closed

AC13

Debtor account type is missing or invalid

AC14

An agent in the payment chain is invalid

AC15

Account details have changed

AC16

Account is in sequestration

AC17

Account is in liquidation

AG01

Transaction forbidden on this type of account (formerly NoAgreement)

AG02

Bank Operation code specified in the message is not valid for receiver

AG07

Debtor account cannot be debited for a generic reason

AGNT

Agent in the payment workflow is incorrect

AM01

Specified message amount is equal to zero

AM02

Specific transaction/message amount is greater than allowed maximum

AM03

Specified message amount is an non processable currency outside of existing agreement

AM04

Amount of funds available to cover specified message amount is insufficient

AM05

Duplication

AM06

Specified transaction amount is less than agreed minimum

AM07

Amount specified in message has been blocked by regulatory authorities

AM09

Amount received is not the amount agreed or expected

AM10

Sum of instructed amounts does not equal the control sum

ARDT

Already returned original SCT

BE01

Identification of end customer is not consistent with associated account number, organisation ID or private ID

BE04

Specification of creditor's address, which is required for payment, is missing/not correct (formerly IncorrectCreditorAddress)

BE05

Party who initiated the message is not recognised by the end customer

BE06

End customer specified is not known at associated Sort/National Bank Code or does no longer exist in the books

BE07

Specification of debtor's address, which is required for payment, is missing/not correct

BE08

Returned as a result of a bank error

BE10

Debtor country code is missing or invalid

BE11

Creditor country code is missing or invalid

BE16

Debtor or Ultimate Debtor identification code missing or invalid

BE17

Creditor or Ultimate Creditor identification code missing or invalid

CN01

Authorisation is cancelled

CNOR

Creditor bank is not registered under this BIC in the CSM

CNPC

Cash not picked up by Creditor or cash could not be delivered to Creditor

CURR

Currency of the payment is incorrect

CUST

Cancellation requested by the Debtor

DNOR

Debtor bank is not registered under this BIC in the CSM

DS28

Return following technical problems resulting in erroneous transaction

DT01

Invalid date (eg, wrong settlement date)

DT02

Cheque has been issued but not deposited and is considered expired

ED01

Correspondent bank not possible

ED03

Balance of payments complementary info is requested

ED05

Settlement of the transaction has failed

EMVL

The card payment is fraudulent and was not processed with EMV technology for an EMV card

ERIN

The Extended Remittance Information (ERI) option is not supported

FF03

Payment Type Information is missing or invalid. Generic usage if cannot specify Service Level or Local Instrument code

FF04

Service Level code is missing or invalid

FF05

Local Instrument code is missing or invalid

FF06

Category Purpose code is missing or invalid

FF07

Purpose is missing or invalid

FOCR

Return following a cancellation request

FR01

Returned as a result of fraud

FRTR

Final response/tracking is recalled as mandate is cancelled

G004

In a FIToFI Customer Credit Transfer: Credit to the creditor’s account is pending, status Originator is waiting for funds provided via a cover.
Update will follow from the Status Originator

MD01

No Mandate

MD02

Mandate related information data required by the scheme is missing

MD05

Creditor or creditor's agent should not have collected the direct debit

MD06

Return of funds requested by end customer

MD07

End customer is deceased

MS02

Reason has not been specified by end customer

MS03

Reason has not been specified by agent

NARR

Reason is provided as narrative information in the additional reason information

NOAS

No response from Beneficiary

NOCM

Customer account is not compliant with regulatory requirements, for example FICA (in South Africa) or any other regulatory requirements
which render an account inactive for certain processing

NOOR

Original SCT never received

PINL

The card payment is fraudulent (lost and stolen fraud) and was processed as EMV transaction without PIN verification

RC01

Bank Identifier code specified in the message has an incorrect format (formerly IncorrectFormatForRoutingCode)

RC07

Incorrect BIC of the beneficiary Bank in the SCTR

RC08

ClearingSystemMemberidentifier is invalid or missing. Generic usage if cannot specify between debit or credit account

RC11

Intermediary Agent is invalid or missing

RF01

Transaction reference is not unique within the message

RR01

Specification of the debtor’s account or unique identification needed for reasons of regulatory requirements is insufficient or missing

RR02

Specification of the debtor’s name and/or address needed for regulatory requirements is insufficient or missing

RR03

Specification of the creditor’s name and/or address needed for regulatory requirements is insufficient or missing

RR04

Regulatory Reason

RR05

Regulatory or Central Bank Reporting information missing, incomplete or invalid

RR06

Tax information missing, incomplete or invalid

RR07

Remittance information structure does not comply with rules for payment type

RR08

Remittance information truncated to comply with rules for payment type

RR09

Structured creditor reference invalid or missing

RR11

Invalid or missing identification of a bank proprietary service

RR12

Invalid or missing identification required within a particular country or payment type

RUTA

Return following investigation request and no remediation possible

SL01

Due to specific service offered by the Debtor Agent

SL02

Due to specific service offered by the Creditor Agent

SL11

Whitelisting service offered by the Debtor Agent; Debtor has not included the Creditor on its “Whitelist” (yet). In the Whitelist the
Debtor may list all allowed Creditors to debit Debtor bank account

SL12

Blacklisting service offered by the Debtor Agent; Debtor included the Creditor on his “Blacklist”. In the Blacklist the Debtor may
list all Creditors not allowed to debit Debtor bank account

SL13

Due to Maximum allowed Direct Debit Transactions per period service offered by the Debtor Agent

SL14

Due to Maximum allowed Direct Debit Transaction amount service offered by the Debtor Agent

SP01

Payment is stopped by account holder

SP02

Previously stopped by means of a stop payment advise

SVNR

The card payment is returned since a cash amount rendered was not correct or goods or a service was not rendered to the customer,
e.g. in an e-commerce situation

TM01

Associated message was received after agreed processing cut-off time

TRAC

Return following direct debit being removed from tracking process

UPAY

Payment is not justified



Responses

Responses

Code

Description

200

OK



Sample Successful Response



Failure Sample Responce



Failure Sample Responce



Failure Sample Responce



Failure Sample Responce



PUT /t2/rtgs/recall/request/reject

Description:

This API rejects an incoming recall request

Method: PUT

Endpoint: /t2/rtgs/recall/request/reject



Sample Request Body



Reject Reason Codes

Reject Reason Codes

Code

Description

AC04

Account number specified has been closed on the receiver’s books

ADAC

Reported when the cancellation request cannot be processed because customer has not yet provided the debit authority on its account

AGNT

Reported when the cancellation cannot be accepted because of an agent refuses to cancel

AM04

Amount of funds available to cover specified message amount is insufficient

ARDT

Cancellation not accepted as the transaction has already been returned

ARPL

Reported when the cancellation request cannot be processed because no reply has been received yet from the receiver of the request message

CUST

Reported when the cancellation cannot be accepted because of a customer decision (Creditor)

LEGL

Reported when the cancellation cannot be accepted because of regulatory rules

NARR

Reason is provided as narrative information in the additional reason information

NOAS

No response from beneficiary (to the cancellation request)

NOOR

Original transaction (subject to cancellation) never received

PTNA

Reported when the cancellation request cannot be accepted because the payment instruction has been passed to the next agent

RQDA

Reported when authority is required by the Creditor to return the payment

WSEQ

Reported when the cancellation request cannot be processed because the sequence referred to in the request is not valid

IDMN

Complementing a Pending or Reject Status. Payment cancellation request cannot be accepted until an indemnity agreement is established



Responses

Responses

Code

Description

200

OK



Sample Successful Response



Failure Sample Responce



Failure Sample Responce



Failure Sample Responce



Failure Sample Responce



PUT /t2/rtgs/update/payment/return



Description:

This API returns an incoming Target2 transfer. If userName is not used, then SYSTEM will be added.

Method: PUT

Endpoint: /t2/rtgs/update/payment/return



Sample Request Body



The same reason codes described in table above Return Reason Codes when accepting a recall request, are also used when returning a CBPR+ transfer

In case reasonCode is NARR then some additional info (up to 105 characters) required in property legalReason1 .

Responses

Responses

Code

Description

200

OK



Sample Successful Response



Failure Sample Responce



Failure Sample Responce



Failure Sample Responce



Failure Sample Responce