DDICA 7 - Claim raised at service users request after DD applied to payers accounts

Claim raised at service users request after DD applied to payers accounts

Please see the settings in the custom profile for actions.
Please see the Webhook Subscription for which Webhooks will be sent out for the customised actions.

Object Action Webhook Subscription Criteria
Payment The payment status is set to “indemnity_claimed”. “DDMS Service” “Edit” on the Payment object.


V1

Payment Webhook - Structure

The fields that have been updated for this webhook are:

Submitted Payment that triggered the Rejection
Field Sample Value
description indemnity debit applied
status indemnity_claimed
bacs_reason_code DDICA7
bacs_description claim raised at service users request
bacs_reference 2022080301S102184102
bacs_filename Ddica020419111111.xml
{
 "events":
 [
  {
   "id" : {EVENTID},
   "created_at" : {CREATEDDATE},
   "resource_type": {RESOURCETYPE},
   "reference" : {REFERENCE},
   "status" : {STATUS},
   "description" : {DESCRIPTION},
   "event_source": {EVENTSOURCE},
   "bacs_reason_code" : {BACSCODE},
   "bacs_description" : {BACSDESCRIPTION},
   "collection_date": {COLLECTIONDATE},
   "amount": {AMOUNT},
   "debit_date": {DEBITDATE} ,
   "bacs_reference" : {BACSREFERENCE},
   "bacs_filename" : {BACSFILENAME},
   "record_type" : {RECORDTYPE},
   "custom_reference" : {CUSTOMREFERENCE},
   "customer_account" : {CUSTOMERACCOUNT},
   "card_id" : {CARDID},
   "payment_type" : {PAYMENTTYPE},
   "status_details" : {STATUSDETAILS},
   "status_code" : {STATUSCODE},
   "currency_code" : {CURRENCYCODE},
   "internal_payment_description" : {INTERNALPAYMENTDESCRIPTION},
   "gateway_payment_description" : {GATEWAYPAYMENTDESCRIPTION},
   "authorisation_code" : {AUTHORISATIONCODE},
   "transaction_id" : {TRANSACTIONID},
   "order_id" : {ORDERID},
   "charge_id" : {CHARGEID},
   "metadata" : {METADATA},
   "gateway_status" : {GATEWAYSTATUS},
   "gateway_status_code" : {GATEWAYSTATUSCODE},
   "gateway_status_details" : {GATEWAYSTATUSDETAILS},
   "related_payment_id" : {RELATEDPAYMENTID},
   "reference": {REFERENCE}
   }
 ]
}


V2

Direct Debit Payment Event - Structure

The fields that have been updated for this webhook are:

Submitted Payment that triggered the Rejection
Field Sample Value
event_type “payment.update”
event_source “DDMS service”
status “indemnity_claimed”
bacs_reason_code “DDICA7”
bacs_description “claim raised at service users request”
bacs_reference “XYZ0012345-0012345”
bacs_filename “Ddica020419111111.xml”
{
    "id":{VALUE},
    "idempotency_key":{VALUE},
    "sent_at":{VALUE},
    "client":{ 
		"id":{VALUE} 
	},
    "events":[
        {
            "id":{VALUE},
            "legacy_id":{VALUE},
            "created_at":{VALUE},
            "collection_date":{VALUE},
            "currency_code":{VALUE},
            "amount":{VALUE},
            "payment_type":{VALUE},          
            "status":{VALUE},            
            "edited_at":{VALUE},
            "represented_collection_date":{VALUE},
            "custom_reference":{VALUE},          
            "event_source":{VALUE},
            "record_type":{VALUE},
            "description":{VALUE},
            "event_type":{VALUE},
            "metadata":{VALUE},         
            "client":{
                "id":{VALUE}
            },
            "created_by":{
                "id":{VALUE}
            },
            "edited_by":{
                "id":{VALUE}
            },  
            "customer_account":{
                "id":{VALUE},
                "legacy_id":{VALUE}
            },
            "recurrence_schedule":{
                "id":{VALUE},
                "legacy_id":{VALUE}
            },
            "related_payment":{
                "id":{VALUE},
                "legacy_id":{VALUE}
            },
            "direct_debit":{
                "bacs_reference":{VALUE},
                "bacs_filename":{VALUE},
                "bacs_reason_code":{VALUE},
                "bacs_description":{VALUE},
                "overriding_name":{VALUE},
                "default_narrative":{VALUE},
                "originating_bank_account":{
                    "id":{VALUE},
                    "legacy_id":{VALUE},
                    "account_name":{VALUE},
                    "account_number":{VALUE},
                    "sort_code":{VALUE}
                },
                "service_user_number":{
                    "id":{VALUE},
                    "sun_name":{VALUE},
                    "sun_number":{VALUE}
                },
                "mandate":{
                    "id":{VALUE},
                    "auddis":{VALUE}
                }                
            },          
            "card_payment":{VALUE}
        }
    ]
 }

Note: Property display order for documentation purposes, actual order may vary.

  • Last modified: 2024/03/19 15:01