Table of contents

1 MT Messages

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 SWIFT MT messages.

MT Messages

PUT /credit/mt/transfer

Description:

This API initiates an MT credit transfer

Method: PUT

Endpoint: /credit/mt/transfer

Sample Request Body

{
  "achId": 1,
  "actionUser": {
    "email": "string"
  },
  "bankId": 1,
  "chargesDetails": "string",
  "creditorAddrLn1": "string",
  "creditorAddrLn2": "string",
  "creditorBIC": "string",
  "creditorCountryCode": "string",
  "creditorIBAN": "string",
  "creditorName": "string",
  "currency": "string",
  "debtorAddrLn1": "string",
  "debtorAddrLn2": "string",
  "debtorCountryCode": "string",
  "debtorIBAN": "string",
  "debtorName": "string",
  "endToEndId": "string",
  "receiverCharges": "string",
  "remInfo": "string",
  "senderCharges": "string",
  "sttlmAmt": 0,
  "sttlmDt": "string",
  "txId": "string"
}

Responses

Responses
Code	Description
200	OK

Sucessful Sample Responce

{
  "status": "OK",
  "payload": 151,
  "errorCode": null,
  "errors": null
}

Failure Sample Responce

{
  "status": "FAILURE",
  "payload": null,
  "errorCode": null,
  "errors": [
    "Invalid creditor BIC : A"
  ]
}

Failure Sample Responce

PUT /v3/credit/mt/transfer

Description:

This API initiates an MT credit transfer.

In the response, in the payload property you will get the auto increment id of the new created payment in aplonHub. You should use this id to accept or reject the payment later on.

Method: PUT

Endpoint: v3/credit/mt/transfer

Sample Request Body

Responses

Responses
Code	Description
200	OK

Sucessful Sample Responce

Failure Sample Responce

PUT /mt/v2/recall/request

Description:

This API initiates a recall request for an outgoing MT transfer

Method: PUT

Endpoint: /mt/v2/recall/request

Sample Request Body

Responses

Responses
Code	Description
200	OK

Sample Response Body

Failure Sample Responce

PUT /mt/v2/recall/request/accept

Description:

This API accepts an incoming recall request

Method: PUT

Endpoint: /mt/v2/recall/request/accept

Sample Request Body

Reason Codes

Reason Codes
Code	Description
^AC01	^{Format of the account number specified is not correct(AC01)}
^AC02	^{Format of the account number specified is non-numeric(AC02)}
^AC03	^{Format of the account number specified is not valid for local sort/national clearing code(AC03)}
^AC04	^{Account number specified has been closed on the receiver's books(AC04)}
^AC05	^{Account number specified is not a valid account at the Account With Institution(AC05)}
^AC06	^{Account specified is blocked, prohibiting posting of transactions against it(AC06)}
^AM01	^{Specified transaction/message amount is equal to zero(AM01)}
^AM02	^{Specified transaction/message amount is greater than allowed maximum(AM02)}
^AM03	^{Specified transaction/message amount is in a non-processable currency outside of existing agreement(AM03)}
^AM04	^{Amount of funds available to cover specified transaction/message amount is insufficient(AM04)}
^AM05	^{This transaction/message appears to have been duplicated(AM05)}
^AM06	^{Specified transaction amount is less than agreed minimum(AM06)}
^AM07	^{Amount specified in transaction/message has been blocked by regulatory authorities(AM07)}
^AM08	^{Specified charges amount is not as agreed between sender and receiver(AM08)}
^BE01	^{Specification of beneficiary is not consistent with associated account number(BE01)}
^BE02	^{Beneficiary specified is not known at associated sort/national clearing code(BE02)}
^BE03	^{Beneficiary specified no longer exists in the books(BE03)}
^BE04	^{Specification of beneficiary address, which is required for payment, is missing/not correct(BE04)}
^BE05	^{Party who initiated the transaction/message is not recognised by the beneficiary(BE05)}
^AG01	^{No agreement is on file at the receiver for affecting associated transaction/message(AG01)}
^AG02	^{Bank Operation code specified in the transaction/message is not valid for receiver(AG02)}
^DT01	^{Invalid date (for example, wrong settlement date)(DT01)}
^MS01	^{Reason has not been specified due to sensitivities(MS01)}
^PY01	^{Unknown Account-With Institution(PY01)}
^RF01	^{Transaction reference is not unique within the message(RF01)}
^RC01	^{Routing code specified in the transaction/message has an incorrect format(RC01)}
^RC02	^{Routing code specified in the transaction/message is not numeric(RC02)}
^RC03	^{Routing code specified in the transaction/message is not valid for local clearing(RC03)}
^RC04	^{Routing code specified in the transaction/message refers to a closed branch(RC04)}
^RR01	^{Specification of the ordering customer's account or unique identification needed for reasons of regulatory requirements is insufficient or missing(RR01)}
^RR02	^{Specification of the ordering customer's name and/or address needed for regulatory requirements is insufficient or missing(RR02)}
^RR03	^{Specification of the beneficiary customer's name and/or address needed for regulatory requirements is insufficient or missing(RR03)}
^TM01	^{Associated transaction/message was received after agreed processing cut-off time(TM01)}
^{Or any 4 letter String that validates the regular expression → X[A-Z0-9][0-9]{2} (e.g., XR01)}

Return Reject Field : A valid mt103 Tag Name from the original message (e.g., 50K)

Responses

Responses
Code	Description
200	OK

Failure Sample Responce

Sample Response Body

Failure Sample Responce

PUT /mt/recall/request/reject

Description:

This API rejects an incoming recall request

Method: PUT

Endpoint: /mt/recall/request/reject

Sample Request Body

Actions

Actions
Code	Description
^PDCR	^{Pending Cancellation Request(PDCR)}
^RJCR	^{Rejected Cancellation Request(RJCR)}

Reason Codes

Reason Codes
Code	Description
^AC04	^{Closed Account Number(AC04)}
^AGNT	^{Agent Decision(AGNT)}
^AM04	^{Insufficient Funds(AM04)}
^ARDT	^{Already Returned(ARDT)}
^ARPL	^{Awaiting Reply(ARPL)}
^CUST	^{Customer Decision(CUST)}
^INDM	Indemnity Requested(INDM)
^LEGL	^{Legal Decision(LEGL)}
^NOAS	^{No Answer From Customer(NOAS)}
^NOOR	^{No Original Transaction Received(NOOR)}
^PTNA	^{Past To Next Agent(PTNA)}
^RQDA	^{Requested Debit Authority(RQDA)}

Responses

Responses
Code	Description
200	OK

Sample Response Body

Failure Sample Responce

PUT /mt/v3/update/payment/return

Description:

This API returns an incoming MT transfer

Method: PUT

Endpoint: /mt/v3/update/payment/return

Sample Request Body

Actions

Actions
Code	Description
^REJT	^REJECT
^RETN	^RETURN

Reason Codes

Reason Codes
Code	Description
^AC01	^{Format of the account number specified is not correct(AC01)}
^AC02	^{Format of the account number specified is non-numeric(AC02)}
^AC03	^{Format of the account number specified is not valid for local sort/national clearing code(AC03)}
^AC04	^{Account number specified has been closed on the receiver's books(AC04)}
^AC05	^{Account number specified is not a valid account at the Account With Institution(AC05)}
^AC06	^{Account specified is blocked, prohibiting posting of transactions against it(AC06)}
^AM01	^{Specified transaction/message amount is equal to zero(AM01)}
^AM02	^{Specified transaction/message amount is greater than allowed maximum(AM02)}
^AM03	^{Specified transaction/message amount is in a non-processable currency outside of existing agreement(AM03)}
^AM04	^{Amount of funds available to cover specified transaction/message amount is insufficient(AM04)}
^AM05	^{This transaction/message appears to have been duplicated(AM05)}
^AM06	^{Specified transaction amount is less than agreed minimum(AM06)}
^AM07	^{Amount specified in transaction/message has been blocked by regulatory authorities(AM07)}
^AM08	^{Specified charges amount is not as agreed between sender and receiver(AM08)}
^BE01	^{Specification of beneficiary is not consistent with associated account number(BE01)}
^BE02	^{Beneficiary specified is not known at associated sort/national clearing code(BE02)}
^BE03	^{Beneficiary specified no longer exists in the books(BE03)}
^BE04	^{Specification of beneficiary address, which is required for payment, is missing/not correct(BE04)}
^BE05	^{Party who initiated the transaction/message is not recognised by the beneficiary(BE05)}
^AG01	^{No agreement is on file at the receiver for affecting associated transaction/message(AG01)}
^AG02	^{Bank Operation code specified in the transaction/message is not valid for receiver(AG02)}
^DT01	^{Invalid date (for example, wrong settlement date)(DT01)}
^MS01	^{Reason has not been specified due to sensitivities(MS01)}
^PY01	^{Unknown Account-With Institution(PY01)}
^RF01	^{Transaction reference is not unique within the message(RF01)}
^RC01	^{Routing code specified in the transaction/message has an incorrect format(RC01)}
^RC02	^{Routing code specified in the transaction/message is not numeric(RC02)}
^RC03	^{Routing code specified in the transaction/message is not valid for local clearing(RC03)}
^RC04	^{Routing code specified in the transaction/message refers to a closed branch(RC04)}
^RR01	^{Specification of the ordering customer's account or unique identification needed for reasons of regulatory requirements is insufficient or missing(RR01)}
^RR02	^{Specification of the ordering customer's name and/or address needed for regulatory requirements is insufficient or missing(RR02)}
^RR03	^{Specification of the beneficiary customer's name and/or address needed for regulatory requirements is insufficient or missing(RR03)}
^TM01	^{Associated transaction/message was received after agreed processing cut-off time(TM01)}
^{Or any 4 letter String that validates the regular expression → X[A-Z0-9][0-9]{2} (e.g., XR01)}

Return Reject Field : A valid mt103 Tag Name from the original message (e.g., 50K)

Responses

Responses
Code	Description
200	OK

Sample Response Body

Failure Sample Responce

PUT /mt/create/free/format

Description:

This API creates an MT free format message (n99)

Method: PUT

Endpoint: /mt/create/free/format

Sample Request Body

Responses

Responses
Code	Description
200	OK

Sample Response Body

Failure Sample Responce

PUT /mt/create/query

Description:

This API creates an MT query message (n95)

Method: PUT

Endpoint: /mt/create/query

Sample Request Body

Responses

Responses
Code	Description
200	OK

Sample Response Body

Failure Sample Responce

PUT /mt/universal/confirmation

Description:

This API creates a MT universal confirmation (mt 199)

Method: PUT

Endpoint: /mt/universal/confirmation

Sample Request Body

Responses

Responses
Code	Description
200	OK

Sample Response Body

Failure Sample Responce

PUT /v2/mt/interbank/transfer

Description:

This API creates a MT interbank credit transfer (mt 202)

Method: PUT

Endpoint: /v2/mt/interbank/transfer

Sample Request Body

Responses

Responses
Code	Description
200	OK

Sample Response Body

Failure Sample Responce

PUT /v2/mt/interbank/own/transfer

Description:

This API creates a MT interbank own credit transfer (mt 200)

Method: PUT

Endpoint: /v2/mt/interbank/own/transfer

Sample Request Body

Sender to receiver information. should follow the syntax rules of tag 72 of MT200

Line 1	^{/8c/[additional information]}	^{(Code)(Narrative)}
Lines 2-6	^{[//continuation of additional information] or [/8c/[additional information]]}	^{(Narrative) or (Code)(Narrative)}

Responses

Responses
Code	Description
200	OK

Sample Response Body

Failure Sample Responce

PUT /mt/recall/request - DEPRACATED

Description:

This API initiates a recall request for an outgoing MT transfer.

If both actionUser and authUser are not used, both will have value 'SYSTEM'.
If actionUser is not used, it will have value 'SYSTEM'.

Method: PUT

Endpoint: /mt/recall/request

Sample Request Body

Responses

Responses
Code	Description
200	OK

Sample Response Body

Failure Sample Responce

PUT /mt/recall/request/accept - DEPRACATED

Description:

This API accepts an incoming recall request

Method: PUT

Endpoint: /mt/recall/request/accept

Sample Request Body

Reason Codes

Reason Codes
Code	Description
^AC01	^{Format of the account number specified is not correct(AC01)}
^AC02	^{Format of the account number specified is non-numeric(AC02)}
^AC03	^{Format of the account number specified is not valid for local sort/national clearing code(AC03)}
^AC04	^{Account number specified has been closed on the receiver's books(AC04)}
^AC05	^{Account number specified is not a valid account at the Account With Institution(AC05)}
^AC06	^{Account specified is blocked, prohibiting posting of transactions against it(AC06)}
^AM01	^{Specified transaction/message amount is equal to zero(AM01)}
^AM02	^{Specified transaction/message amount is greater than allowed maximum(AM02)}
^AM03	^{Specified transaction/message amount is in a non-processable currency outside of existing agreement(AM03)}
^AM04	^{Amount of funds available to cover specified transaction/message amount is insufficient(AM04)}
^AM05	^{This transaction/message appears to have been duplicated(AM05)}
^AM06	^{Specified transaction amount is less than agreed minimum(AM06)}
^AM07	^{Amount specified in transaction/message has been blocked by regulatory authorities(AM07)}
^AM08	^{Specified charges amount is not as agreed between sender and receiver(AM08)}
^BE01	^{Specification of beneficiary is not consistent with associated account number(BE01)}
^BE02	^{Beneficiary specified is not known at associated sort/national clearing code(BE02)}
^BE03	^{Beneficiary specified no longer exists in the books(BE03)}
^BE04	^{Specification of beneficiary address, which is required for payment, is missing/not correct(BE04)}
^BE05	^{Party who initiated the transaction/message is not recognised by the beneficiary(BE05)}
^AG01	^{No agreement is on file at the receiver for affecting associated transaction/message(AG01)}
^AG02	^{Bank Operation code specified in the transaction/message is not valid for receiver(AG02)}
^DT01	^{Invalid date (for example, wrong settlement date)(DT01)}
^MS01	^{Reason has not been specified due to sensitivities(MS01)}
^PY01	^{Unknown Account-With Institution(PY01)}
^RF01	^{Transaction reference is not unique within the message(RF01)}
^RC01	^{Routing code specified in the transaction/message has an incorrect format(RC01)}
^RC02	^{Routing code specified in the transaction/message is not numeric(RC02)}
^RC03	^{Routing code specified in the transaction/message is not valid for local clearing(RC03)}
^RC04	^{Routing code specified in the transaction/message refers to a closed branch(RC04)}
^RR01	^{Specification of the ordering customer's account or unique identification needed for reasons of regulatory requirements is insufficient or missing(RR01)}
^RR02	^{Specification of the ordering customer's name and/or address needed for regulatory requirements is insufficient or missing(RR02)}
^RR03	^{Specification of the beneficiary customer's name and/or address needed for regulatory requirements is insufficient or missing(RR03)}
^TM01	^{Associated transaction/message was received after agreed processing cut-off time(TM01)}
^{Or any 4 letter String that validates the regular expression → X[A-Z0-9][0-9]{2} (e.g., XR01)}

Return Reject Field : A valid mt103 Tag Name from the original message (e.g., 50K)

Responses

Responses
Code	Description
200	OK

Sample Response Body

Failure Sample Responce

PUT /mt/update/payment/return - DEPRECATED

Description:

This API returns an incoming MT transfer

Method: PUT

Endpoint: /mt/update/payment/return

Sample Request Body

Responses

Responses
Code	Description
200	OK

Sample Response Body

Failure Sample Responce

PUT /mt/v2/update/payment/return - DEPRECATED

Description:

This API returns an incoming MT transfer

Method: PUT

Endpoint: /mt/v2/update/payment/return

Sample Request Body

Actions

Actions
Code	Description
^REJT	^REJECT
^RETN	^RETURN

Reason Codes

Reason Codes
Code	Description
^AC01	^{Format of the account number specified is not correct(AC01)}
^AC02	^{Format of the account number specified is non-numeric(AC02)}
^AC03	^{Format of the account number specified is not valid for local sort/national clearing code(AC03)}
^AC04	^{Account number specified has been closed on the receiver's books(AC04)}
^AC05	^{Account number specified is not a valid account at the Account With Institution(AC05)}
^AC06	^{Account specified is blocked, prohibiting posting of transactions against it(AC06)}
^AM01	^{Specified transaction/message amount is equal to zero(AM01)}
^AM02	^{Specified transaction/message amount is greater than allowed maximum(AM02)}
^AM03	^{Specified transaction/message amount is in a non-processable currency outside of existing agreement(AM03)}
^AM04	^{Amount of funds available to cover specified transaction/message amount is insufficient(AM04)}
^AM05	^{This transaction/message appears to have been duplicated(AM05)}
^AM06	^{Specified transaction amount is less than agreed minimum(AM06)}
^AM07	^{Amount specified in transaction/message has been blocked by regulatory authorities(AM07)}
^AM08	^{Specified charges amount is not as agreed between sender and receiver(AM08)}
^BE01	^{Specification of beneficiary is not consistent with associated account number(BE01)}
^BE02	^{Beneficiary specified is not known at associated sort/national clearing code(BE02)}
^BE03	^{Beneficiary specified no longer exists in the books(BE03)}
^BE04	^{Specification of beneficiary address, which is required for payment, is missing/not correct(BE04)}
^BE05	^{Party who initiated the transaction/message is not recognised by the beneficiary(BE05)}
^AG01	^{No agreement is on file at the receiver for affecting associated transaction/message(AG01)}
^AG02	^{Bank Operation code specified in the transaction/message is not valid for receiver(AG02)}
^DT01	^{Invalid date (for example, wrong settlement date)(DT01)}
^MS01	^{Reason has not been specified due to sensitivities(MS01)}
^PY01	^{Unknown Account-With Institution(PY01)}
^RF01	^{Transaction reference is not unique within the message(RF01)}
^RC01	^{Routing code specified in the transaction/message has an incorrect format(RC01)}
^RC02	^{Routing code specified in the transaction/message is not numeric(RC02)}
^RC03	^{Routing code specified in the transaction/message is not valid for local clearing(RC03)}
^RC04	^{Routing code specified in the transaction/message refers to a closed branch(RC04)}
^RR01	^{Specification of the ordering customer's account or unique identification needed for reasons of regulatory requirements is insufficient or missing(RR01)}
^RR02	^{Specification of the ordering customer's name and/or address needed for regulatory requirements is insufficient or missing(RR02)}
^RR03	^{Specification of the beneficiary customer's name and/or address needed for regulatory requirements is insufficient or missing(RR03)}
^TM01	^{Associated transaction/message was received after agreed processing cut-off time(TM01)}
^{Or any 4 letter String that validates the regular expression → X[A-Z0-9][0-9]{2} (e.g., XR01)}

Return Reject Field : A valid mt103 Tag Name from the original message (e.g., 50K)

Responses

Responses
Code	Description
200	OK