In order to notify core banking for every incoming direct debit or action, aplonHUB uses REST apis. It needs xxx urls for the following cases:

To notify core banking for new incoming direct debit
To notify for other actions like reversals or rejections

See bellow the definitions for the APIs expected by the core banking.

NOTE:

for all the above requests and responses the content-type should be text/plain
success is a request with status 200, and a non empty payload (in the payload you can return whatever you want like an ok or an id). It will be stored in aplonHUB for debugging reasons
sepaTrnHedSn is the aplonHUB's internal id. It's the id that uniquely identifies the payment in aplonHUB and you need it in order to make some actions with aplonHUB's exposed apis.

New incoming Direct Debit

Core banking should prepare an api to accept a payload like the following in order to be notified for any new incoming direct debit

Sample Request Body

{
  "settlementDate" : "2019/07/07",
  "currency" : "USD",
  "amount" : 1025,
  "creditorName" : "Virgay",
  "creditorAddress" : null,
  "creditorAccount" : "789123",
  "creditorAgent" : "AAAAUS29",
  "debtorName" : "Jones",
  "debtorAddress" : null,
  "debtorAccount" : "123456",
  "debtorAgent" : "BBBBUS39",
  "txId" : "AAAAUS29/100628/ad459",
  "endToEndId" : "VA060713/0124",
  "messageNameId" : "pacs.003.001.02",
  "sepaTrnHedSn" : 1569,
  "inOut" : "I",
  "chargesBearer" : "SHAR",
  "mandateId" : "VIRGAY123",
  "dateOfSignature" : "2008/07/13",
  "frequency" : "YEAR",
  "requestedCollectionDate" : "2010/07/13",
  "mandateStatus" : "PAUSED"
}

Incoming Direct Debit Reversal

For every incoming Direct Debit (pacs.003) we receive we may receive a reversal (pacs.007). In that case , aplonHub will send the following request to the core banking .

Sample Request Body

{
  "id": "String",
  "originalTransactionId" : "String",
  "sepaTrnHedSn": 123,
  "messageNameId": "pacs.007",
  "rejectionReason": "String"
}

Incoming Direct Debit Return

For every outgoing Direct Debit (pacs.003) we may receive a return (pacs.004). In that case , aplonHub will send the following request to the core banking .

Sample Request Body

{
  "id": "txId",
  "originalTransactionId" : "OrgnlTxId",
  "sepaTrnHedSn": 123,
  "messageNameId": "pacs.004.001.02",
  "rejectionReason": "String",
  "charges" :
   {
      "amount" : 1.50     // charges amount of the return
      "currency" : "EUR"  // charges currency of the return
   }
  "compensationAmount": 5.06,
  "interbankSettlementDate": "2021/05/22" 
}

Incoming Direct Debit Rejection

For every incoming Direct Debit (pacs.003) we may receive a rejection (pacs.002). In that case , aplonHub will send the following request to the core banking .

Sample Request Body

{
  "originalTransactionId" : "String",
  "originalSepaTrnHedSn": 123,
  "messageNameId": "pacs.002",
  "rejectionReason": "String"
}

Browser not supported