Direct Debit Collection Notification Response Confirmation

Direct Debit Collection Notification Confirmation message is sent to client to confirm or reject Direct Debit Collection Notification Response message.

Direct Debit Collection Notification Confirmation can be requested via the Messages service.

HTTP Header Message-Response-Type: DIRECT_DEBIT_COLLECTION_CONFIRMATION

See the Examples section for a confirmation message.

Message structure

For this message, JSON format is used.

Name	Value	Description
GrpHdr.MsgId		Mandatory. Related pain.002 message id. (GrpHdr.MsgId from pain.002)
OrgnlMsgInf.MsgId		Mandatory. Original pain.008 message id. (GrpHdr.MsgId from pain.008)
AcceptanceStatus	OK - All acceptances are processed successfully PARTIAL - Some of the acceptances failed to process FAILED - The file was failed to process	Mandatory. pain.002 fail processing status.
Messages.OrgnlPmtInfId		Mandatory. Original payment id. (PmtInf.PmtInfId from pain.008)
Messages.Confirmed	true - response is confirmed false - response is not confirmed	Mandatory. Direct Debit response status: If the value is true, the Direct Debit response was processed successfully. If the value is false, an error occurred and the ErrorInfo section is presented with error details.
Messages.ErrorInfo.ErrorCode	List of error codes can be found here	Optional. Only presented when Message.confirmed is false.
Messages.ErrorInfo.ErrorDescription	List of error code descriptions can be found here	Optional. Only presented when Message.confirmed is false.

OK

All Direct Debit responses in pain.002 have been processed successfully.

{
  "GrpHdr.MsgId": "pain002_message_id",
  "OrgnlMsgInf.MsgId": "message_id_pain008",
  "AcceptanceStatus": "OK",
  "Messages": [
    {
      "OrgnlPmtInfId": "paymentId_1",
      "Confirmed": true
    },
    {
      "OrgnlPmtInfId": "paymentId_2",
      "Confirmed": true
      }
    }
  ]
}

PARTIAL

Some Direct Debit responses in pain.002 have failed to process.

{
  "GrpHdr.MsgId": "pain002_message_id",
  "OrgnlMsgInf.MsgId": "message_id_pain008",
  "AcceptanceStatus": "PARTIAL",
  "Messages": [
    {
      "OrgnlPmtInfId": "paymentId_1",
      "Confirmed": true
    },
    {
      "OrgnlPmtInfId": "paymentId_2",
      "Confirmed": false,
      "ErrorInfo": {
        "ErrorCode": "DIRECT_DEBIT_NOT_FOUND",
        "ErrorDescription": "Direct Debit not found"
      }
    }
  ]
}

FAILED

Pain.002 has failed to process.

{
  "GrpHdr.MsgId": "pain002_message_id",
  "OrgnlMsgInf.MsgId": "message_id_pain008",
  "AcceptanceStatus": "FAILED",
  "Messages": [
    {
      "OrgnlPmtInfId": "paymentId_2",
      "Confirmed": false,
      "ErrorInfo": {
        "ErrorCode": "DIRECT_DEBIT_FILE_INVALID",
        "ErrorDescription": "Payment doesn’t exists in corresponding pain.008 file"
      }
    }
  ]
}

Error codes

Error Code	Error Description	Comment
DIRECT_DEBIT_NOT_FOUND	Direct Debit not found	Direct Debit payment is not found.
DIRECT_DEBIT_INVALID_STATUS	Direct Debit is expected to be in status RECEIVED, but is in status ...	A Direct Debit can be confirmed or rejected only when it is in received status. If the Direct Debit is already confirmed, returned, etc., it can no longer be accepted or rejected.
DUPLICATE_PAYMENT_ID	Duplicate payment in file	There is duplicate payment id on pain.002 file.
DIRECT_DEBIT_RESPONSE_PROCESSED	Direct Debit response already processed	Direct Debit response is already received and processed.
DIRECT_DEBIT_FILE_NOT_FOUND	pain.008 message file not found	Original Direct Debit Notification does not exist. The pain.008 id may be invalid in pain.002 message (OrgnlGrpInfAndSts.OrgnlMsgId)
NO_RIGHTS_TO_DEBTOR_ACCOUNT	User have no rights to debtor account	User have no rights to debtor account.
DIRECT_DEBIT_FILE_INVALID	Payment doesn’t exist in corresponding pain.008 file	Payment doesn't exist in corresponding pain.008 file. The payment id may be invalid in pain.002 message (OrgnlPmtInfAndSts.OrgnlPmtInfId)
INVALID_REASON_CODE	Provided reason code is invalid	Acceptance data in pain.002 is invalid. Status and reason code must be filled correctly.