Table of contents

1 Credit Transfers

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 ISO20022 or SEPA payments.

Credit Transfers

PUT /p27/credit/transfer

Description:

This API is used to initiate a SEPA credit transfer.

Method: PUT

Endpoint: /p27/credit/transfer

Sample Request Body

{
  "achId": 1,
  "bankId": 1,
  "actionUser": {
    "email": "string",
  },
  "creditorAddrLn1": "string",
  "creditorAddrLn2": "string",
  "creditorBIC": "string",
  "creditorCountryCode": "string",
  "creditorIBAN": "string",
  "creditorName": "string",
  "debtorAddrLn1": "string",
  "debtorAddrLn2": "string",
  "debtorCountryCode": "string",
  "debtorIBAN": "string",
  "debtorName": "string",
  "endToEndId": "string",
  "remInfo": "string",
  "sttlmAmt": 0,
  "sttlmDt": "string",
  "txId": "string",
  "instrId": "82C7182198D466B6",
  "sttlmCur": "SEK"
}

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": null,
  "errors": [
    "Invalid creditor BIC : A"
  ]
}

Failure Sample Responce

PUT /p27/recall/request

Description:

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

Method: PUT

Endpoint: /p27/recall/request

Sample Request Body

Responses

Responses
Code	Description
200	OK

Recall Request Reason Codes

Recall Request Reason Codes
CUST	Cancellation requested by the Debtor
DUPL	Payment is a duplicate of another payment.
AC03	Invalid Creditor Account Number Wrong unique identifier of the Beneficiary account
AM09	Wrong Amount
FRAD	Fraudulent Originated.
TECH	Technical Problems

Sample Successful Response

Failure Sample Responce

Failure Sample Response

Failure Sample Response

PUT /p27/recall/request/accept

Description:

This API accepts an incoming recall request

Method: PUT

Endpoint: /p27/recall/request/accept

Sample Request Body

Return Reason Codes

Return Reason Codes
Code	Description
AC01	Incorrect Account Number(AC01)
AC04	Closed Account Number
AC06	Blocked Account
AG01	Transaction Forbidden
AG02	Invalid Bank Operation Code
AM05	Duplication
AM09	Amount received is not the amount agreed or expected
BE04	Missing Creditor Address
CNOR	Creditor bank is not registered under this BIC in the CSM
ERIN	The Extended Remittance Information (ERI) option is not supported.
FOCR	Return due to a Recall
MD07	End Customer Deceased
MS02	Not Specified Reason Customer Generated
MS03	Not Specified Reason Agent Generated
RC01	Bank Identifier code specified in the message has an incorrect format (formerly IncorrectFormatForRoutingCode).
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
RR09	Structured creditor reference invalid or missing.

Responses

Responses
Code	Description
200	OK

Sample Successful Response

Failure Sample Responce

PUT /p27/recall/request/reject

Description:

This API rejects an incoming recall request

Method: PUT

Endpoint: /p27/recall/request/reject

Sample Request Body

Reject Reason Codes

Reject Reason Codes
Code	Description
LEGL	Reported when the cancellation cannot be accepted for regulatory reasons.
CUST	Reported when the cancellation cannot be accepted because of a customer's decision (creditor).
AC04	Account number specified has been closed on the receiver's books.
AM04	Amount of funds available to cover specified message amount is insufficient.
ARDT	Cancellation not accepted as the transaction has already been returned.
LATE
NOAS	No response from beneficiary (to the cancellation request).
NOOR	Original transaction (subject to cancellation) never received.

Responses

Responses
Code	Description
200	OK

Sample Successful Response

Failure Sample Responce

PUT /p27/update/payment/return

Description:

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

Method: PUT

Endpoint: /p27/update/payment/return

Sample Request Body

Return Reason Codes

Return Reason Codes
Code	Description
AC01	Format of the account number specified is not correct
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.
AG01	Transaction forbidden on this type of account (formerly NoAgreement)
AG02	Bank Operation code specified in the message is not valid for receiver
AM05	Duplication
AM09	Amount received is not the amount agreed or expected
BE04	pecification of creditor's address, which is required for payment, is missing/not correct (formerly IncorrectCreditorAddress).
CNOR	Creditor bank is not registered under this BIC in the CSM
ERIN	The Extended Remittance Information (ERI) option is not supported.
FOCR	Return following a cancellation request
MD07	End customer is deceased.
MS02	Reason has not been specified by agent.
MS03	Not Specified Reason Agent Generated(MS03)
RC01	Bank Identifier code specified in the message has an incorrect format (formerly IncorrectFormatForRoutingCode).
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
RR09	Structured creditor reference invalid or missing.

Responses

Responses
Code	Description
200	OK

Sample Successful Response

Failure Sample Responce

PUT /p27/update/payment/claim/non/receipt

Description:

This API accepts the id of an outgoing pacs.008 and generates a camt.027 message for the given pacs.008.

Method: PUT

Endpoint: /p27/update/payment/claim/non/receipt

Sample Request Body

Responses

Responses
Code	Description
200	OK

Sample Successful Response

Failure Sample Responce

Failure Sample Response

PUT /p27/update/payment/request/to/modify/payment

Description:

This API accepts the id of an outgoing pacs.008 and a date and generates a camt.087 message for the given pacs.008.

Method: PUT

Endpoint: /p27/update/payment/request/to/modify/payment

Sample Request Body

Responses

Responses
Code	Description
200	OK

Sample Successful Response

Failure Sample Responce

Failure Sample Response

PUT /p27/update/payment/resolution/of/investigation

Charges according to SEPA 2021 rulebook

Description:

This API accepts the id of an incoming camt.027.001.06/camt.087.001.05/pacs.028.001.01 and generates a camt.029.001.08 for the given id.

Method: PUT

Endpoint: /p27/update/payment/resolution/of/investigation

Sample Request Body

Status Codes

Status Codes
Code	Description
ACNR	Accepted Claim Non Receipt(ACNR)
RJNR	Default. Rejected Claim Non Receipt(RJNR)
ACVA	Accepted Value Date Adjustment(ACVA)
RJVA	Rejected Value date Adjustment(RJVA)
CVAA	Correct Value date Already Applied(CVAA)
MODI	Modified As Per Request(MODI)

Responses

Responses
Code	Description
200	OK