aplonHUB, Outgoing Payment Status Report
- Alexandrakis Alexandros
- Developers
In some cases, aplonHUB may need to create outgoing payment status reports (PACS.002s) for the ACH. This is not enabled by default since in most of the cases is not needed. You can go to the System Properties → Custom System Properties and switch the Enable Outgoing PACS.002 indicator on.
Once you enable it , you have to update the status of each incoming payment you received with a positive or negative status. Once all transactions of an incoming PACS.008 are answered, then aplonHUBwill generate an outgoing PACS.002 with the status of the payments.
The following 2 apis are needed for that:
Mark Payment as Settled
PUT /sepa/update/payment/settled
Description:
This API is used to change a status of an incoming payment with current status 01-Received or 10-Pending to 08-Settled.
Method: PUT
Endpoint: /sepa/update/payment/settled
{
"sepaTrnHedSn": 00 //The aplonhub sn of the incoming payment
} |
Responses | |
|---|---|
Code | Description |
200 | OK |
{
"status": "OK",
"payload": 1,
"errorCode": null,
"errors": null
} |
In case the system cannot find an incoming pacs.008 in status 01-Received or 10-Pending you will get the above error.
{
"status": "FAILURE",
"payload": null,
"errorCode": null,
"errors": [
"settled.transaction.failed"
]
} |
Mark Payment as Rejected
PUT /sepa/update/payment/reject
Description:
This API is used to change a status of an incoming payment with current status 01-Received or 10-Pending to 12-To Be Rejected.
Method: PUT
Endpoint: /sepa/update/payment/reject
{
"sepaTrnHedSn": 00, //The aplonhub sn of the incoming payment
"rejectReason": "AC01"
} |
Reject Reason could be a free text up to 70 characters , or a 4 digit error code from the above list
Code | Description |
|---|---|
AM01 | Specified message amount is equal to zero |
AM02 | Specific transaction/message amount is greater than allowed maximum |
AM05 | Duplication |
DT01 | Invalid date (eg, wrong settlement date) |
ED05 | Settlement of the transaction has failed. |
Responses | |
|---|---|
Code | Description |
200 | OK |
{
"status": "OK",
"payload": 1,
"errorCode": null,
"errors": null
} |
In case the system cannot find an incoming pacs.008 in status 01-Received or 10-Pending you will get the above error.
{
"status": "FAILURE",
"payload": null,
"errorCode": null,
"errors": [
"reject.transaction.failed"
]
} |