cancel_sdd_batch


POST  -- Mass cancellation of mandates

While SDD is not transmitted to the bank, it is possible to modify or cancel it.

Reminder :
Levy (SDD) is sent to the bank on (due_date - 1 day), at the end of the day. Once SDD is transmitted, it can't be modified or canceled.
If SDD cancellation worked levy status in response will be "CANCELED", "REMBOURSE" or "TOREMBOURSE" depending on its former status.
If cancellation failed, SDD keeps same status.



Search argument Description Type - Length Mandatory
sddsList of direct debit referencesJsonNO



Request

POST /ssp/cancel_sdd_batch HTTP/1.1
Host: xxx.safedebit.fr
Authorization: Basic JQheySHkalSNuakkmSmm==
Content-Type: application/json
Accept: application/json


{
    "sdds":["SDD-REFERENCE1","SDD-REFERENCE2","SDD-REFERENCE3"]
}


If levy successfully canceled

Response

HTTP/1.1 200 OK
Content-Type: application/json 


{
    result : true,
    sdds :[
    	{
    		sdd:"SDD-REFERENCE1",
    		status:"CANCELED",
    	},
    	{
    		sdd:"SDD-REFERENCE2",
    		status:"CANCELED",
    	},
    	{
    		sdd:"SDD-REFERENCE3",
    		status:"CANCELED",
    	}
    ]
}

If SDDs cancellation failed

Response

HTTP/1.1 200 OK
Content-Type: application/json 


{
    "result" : false,
    "code" : "XXXX"
}

Argument Description
result true or false :
true : action succeeded
false : action failed
sdds List of sdds with their status
sdd : sdd reference
status : sdd status
code See (error codes in annex).