Requesting Direct Debit Services
SEPA Direct Debit Services
Standalone Direct Debit Services
Direct Debit Validation
Direct debit validation does not include negative files, availability of funds, or account status. If the bank account information is valid, the transaction is submitted to the country’s direct debit clearing system for collection.
To request a direct debit validation including the IBAN:
Step 1
Include the following fields in the request.
Example 1
Direct Debit Validate Request including the IBAN
<requestMessage xmlns="urn:schemas-cybersource-com:transaction-data-1.24">
<merchantID>dd_test</merchantID>
<merchantReferenceCode>testmerchrefnu</merchantReferenceCode>
<billTo>
<firstName>Bob</firstName>
<lastName>Smith</lastName>
<street1>1st Test Way</street1>
<city>Vienna</city>
<country>Austria</country>
<email>example@example.com</email>
</billTo>
<purchaseTotals>
<currency>EUR</currency>
<grandTotalAmount>50</grandTotalAmount>
</purchaseTotals>
<fundTransfer>
<iban>AT611904300234573201</iban>
</fundTransfer>
<bankInfo>
<country>AT</country>
<swiftCode>RVSAAT2S024</swiftCode>
</bankInfo>
<directDebitService run="false">
<recurringType>1</recurringType>
<mandateID>1234564798</mandateID>
<mandateAuthenticationDate>20150909</mandateAuthenticationDate>
</directDebitService>
<directDebitValidateService run="true"/>
</requestMessage>
Below are the transaction reply fields.
Example 2
Direct Debit Validate Reply
<c:replyMessage xmlns:c="urn:schemas-cybersource-com:transaction-data-1.24">
<c:merchantReferenceCode>testmerchrefnu</c:merchantReferenceCode>
<c:requestID>4419573943745000001520</c:requestID>
<c:decision>ACCEPT</c:decision>
<c:reasonCode>100</c:reasonCode>
<c:purchaseTotals>
<c:currency>eur</c:currency>
</c:purchaseTotals>
<c:directDebitValidateReply>
<c:reasonCode>100</c:reasonCode>
<c:amount>50.00</c:amount>
<c:requestDateTime>2015-09-11T07:43:14Z</c:requestDateTime>
<c:reconciliationID>02WWNTQG000000IE49RQHA</c:reconciliationID>
<c:processorResponse>100</c:processorResponse>
<c:iban>AT611904300234573201</c:iban>
<c:bankSwiftCode>RVSAAT2S024</c:bankSwiftCode>
</c:directDebitValidateReply>
</c:replyMessage>
For detailed descriptions of all request fields see Request Fields and for reply fields see Reply Fields.
 
To request a direct debit validation including the BBAN:
Step 1
Include the fields in Example 1.
Step 2
Replace the fundTransfer_iban and the bankInfo_swiftcode request fields with the BBAN request fields below.
 
<fundTransfer>
<accountNumber>6576456576453546</accountNumber>
</fundTransfer>
<bankInfo>
<bankCode>123465</bankCode>
</bankInfo>
For detailed descriptions of all request fields see Request Fields and for reply fields see Reply Fields.
 
Direct Debit
To request a direct debit including the IBAN:
Step 1
Include the following fields in the request.
Example 3
Direct Debit Request including the IBAN
<requestMessage xmlns="urn:schemas-cybersource-com:transaction-data-1.24">
<merchantID>dd_test</merchantID>
<merchantReferenceCode>testmerchrefnu</merchantReferenceCode>
<billTo>
<firstName>Bob</firstName>
<lastName>Smith</lastName>
<street1>1st Test Way</street1>
<city>Vienna</city>
<country>Austria</country>
<email>example@example.com</email>
</billTo>
<purchaseTotals>
<currency>EUR</currency>
<grandTotalAmount>50.00</grandTotalAmount>
</purchaseTotals>
<fundTransfer>
<iban>AT611904300234573201</iban>
</fundTransfer>
<bankInfo>
<country>AT</country>
<swiftCode>RVSAAT2S024</swiftCode>
</bankInfo>
<directDebitService run="true">
<recurringType>1</recurringType>
<mandateID>1234564798</mandateID>
<mandateAuthenticationDate>20150909</mandateAuthenticationDate>
</directDebitService>
</requestMessage>
Below are the transaction reply fields.
Example 4
Direct Debit Reply
<c:replyMessage xmlns:c="urn:schemas-cybersource-com:transaction-data-1.24">
<c:merchantReferenceCode>testmerchrefnu</c:merchantReferenceCode>
<c:requestID>4419575367615000001521</c:requestID>
<c:decision>ACCEPT</c:decision>
<c:reasonCode>100</c:reasonCode>
<c:purchaseTotals>
<c:currency>eur</c:currency>
</c:purchaseTotals>
<c:directDebitReply>
<c:reasonCode>100</c:reasonCode>
<c:amount>50.00</c:amount>
<c:requestDateTime>2015-09-11T07:45:36Z</c:requestDateTime>
<c:reconciliationID>02WWNTRG000000IE49RT3N</c:reconciliationID>
</c:directDebitReply>
</c:replyMessage>
For detailed descriptions of all request fields see Request Fields and for reply fields see Reply Fields.
 
To request a direct debit validation including the BBAN:
Step 1
Include the fields in Example 1.
Step 2
Replace the fundTransfer_iban and the bankInfo_swiftcode request fields with the BBAN request fields below.
 
<fundTransfer>
<accountNumber>6576456576453546</accountNumber>
</fundTransfer>
<bankInfo>
<bankCode>123465</bankCode>
</bankInfo>
For detailed descriptions of all request fields see Request Fields and for reply fields see Reply Fields.
 
Direct Debit Refund
To request a direct debit refund including the IBAN:
Step 1
Include the following fields in the request.
Example 5
Direct Debit Refund Request including the IBAN
<requestMessage xmlns="urn:schemas-cybersource-com:transaction-data-1.24">
<merchantID>dd_test</merchantID>
<merchantReferenceCode>testmerchrefnu</merchantReferenceCode>
<billTo>
<firstName>Bob</firstName>
<lastName>Smith</lastName>
<street1>1st Test Way</street1>
<city>Vienna</city>
<country>Austria</country>
<email>example@example.com</email>
</billTo>
<purchaseTotals>
<currency>EUR</currency>
<grandTotalAmount>50.00</grandTotalAmount>
</purchaseTotals>
<fundTransfer>
<iban>AT611904300234573201</iban>
</fundTransfer>
<bankInfo>
<country>AT</country>
<swiftCode>RVSAAT2S024</swiftCode>
</bankInfo>
<directDebitRefundService run="true">
<recurringType>1</recurringType>
<mandateID>1234564798</mandateID>
<mandateAuthenticationDate>20150909</mandateAuthenticationDate>
</directDebitRefundService>
</requestMessage>
Below are the transaction reply fields.
Example 6
Direct Debit Refund Reply
<c:replyMessage xmlns:c="urn:schemas-cybersource-com:transaction-data-1.24">
<c:merchantReferenceCode>testmerchrefnu</c:merchantReferenceCode>
<c:requestID>4419579878515000001520</c:requestID>
<c:decision>ACCEPT</c:decision>
<c:reasonCode>100</c:reasonCode>
<c:purchaseTotals>
<c:currency>eur</c:currency>
</c:purchaseTotals>
<c:directDebitRefundReply>
<c:reasonCode>100</c:reasonCode>
<c:amount>50.00</c:amount>
<c:requestDateTime>2015-09-11T07:53:07Z</c:requestDateTime>
<c:reconciliationID>02WWNTQG000000IE49RQW1</c:reconciliationID>
</c:directDebitRefundReply>
</c:replyMessage>
For detailed descriptions of all request fields see Request Fields and for reply fields see Reply Fields.
 
To request a direct debit refund including the BBAN:
Step 1
Include the fields in Example 1.
Step 2
Replace the fundTransfer_iban and the bankInfo_swiftcode request fields with the BBAN request fields below.
 
<fundTransfer>
<accountNumber>6576456576453546</accountNumber>
</fundTransfer>
<bankInfo>
<bankCode>123465</bankCode>
</bankInfo>
For detailed descriptions of all request fields see Request Fields and for reply fields see Reply Fields.
 
Follow-On Direct Debit Services
Direct Debit
To request a follow-on direct debit:
 
Step 1
Include the following fields in the request.
Example 7
Follow-On Direct Debit Request
<requestMessage xmlns="urn:schemas-cybersource-com:transaction-data-1.24">
<merchantID>dd_test</merchantID>
<merchantReferenceCode>testmerchrefnu</merchantReferenceCode>
<billTo>
<firstName>Bob</firstName>
<lastName>Smith</lastName>
<street1>1st Test Way</street1>
<city>Vienna</city>
<country>Austria</country>
<email>example@example.com</email>
</billTo>
<purchaseTotals>
<currency>EUR</currency>
<grandTotalAmount>50.00</grandTotalAmount>
</purchaseTotals>
<fundTransfer>
<accountNumber>6576456576453546</accountNumber>
</fundTransfer>
<bankInfo>
<bankCode>123465</bankCode>
<country>AT</country>
</bankInfo>
<directDebitService run="true">
<validateRequestID>4419572039695000001515</validateRequestID>
<recurringType>1</recurringType>
<mandateID>1234564798</mandateID>
<mandateAuthenticationDate>20150909</mandateAuthenticationDate>
</directDebitService>
</requestMessage>
 
* 
The directDebitService_validateRequestID field must be set to the requestID value that is returned from the original direct debit validate request.
Below are the transaction reply fields.
Example 8
Follow-on Direct Debit Reply
<c:replyMessage xmlns:c="urn:schemas-cybersource-com:transaction-data-1.24">
<c:merchantReferenceCode>testmerchrefnu</c:merchantReferenceCode>
<c:requestID>4419582421045000001518</c:requestID>
<c:decision>ACCEPT</c:decision>
<c:reasonCode>100</c:reasonCode>
<c:purchaseTotals>
<c:currency>eur</c:currency>
</c:purchaseTotals>
<c:directDebitReply>
<c:reasonCode>100</c:reasonCode>
<c:amount>50.00</c:amount>
<c:requestDateTime>2015-09-11T07:57:23Z</c:requestDateTime>
<c:reconciliationID>02WWNTOG000000IE49QIH2</c:reconciliationID>
</c:directDebitReply>
</c:replyMessage>
For detailed descriptions of all request fields see Request Fields and for reply fields see Reply Fields.
 
Direct Debit Refund
To request a follow-on direct debit refund:
 
Step 1
Include the following fields in the request.
Example 9
Follow-On Direct Debit Refund Request
<requestMessage xmlns="urn:schemas-cybersource-com:transaction-data-1.24">
<merchantID>dd_test</merchantID>
<merchantReferenceCode>testmerchrefnu</merchantReferenceCode>
<billTo>
<firstName>Bob</firstName>
<lastName>Smith</lastName>
<street1>1st Test Way</street1>
<city>Vienna</city>
<country>Austria</country>
<email>example@example.com</email>
</billTo>
<purchaseTotals>
<currency>EUR</currency>
<grandTotalAmount>50.00</grandTotalAmount>
</purchaseTotals>
<fundTransfer>
<accountNumber>6576456576453546</accountNumber>
</fundTransfer>
<bankInfo>
<bankCode>123465</bankCode>
<country>AT</country>
</bankInfo>
<directDebitRefundService run="true">
<directDebitRequestID>4419582421045000001518</directDebitRequestID>
<recurringType>1</recurringType>
<mandateID>1234564798</mandateID>
<mandateAuthenticationDate>20150909</mandateAuthenticationDate>
</directDebitRefundService>
</requestMessage>
 
* 
The directDebitRefundService_directDebitRequestID field must be set to the requestID value that is returned from the original direct debit request.
Below are the transaction reply fields.
Example 10
Follow-on Direct Debit Refund Reply
<c:replyMessage xmlns:c="urn:schemas-cybersource-com:transaction-data-1.24">
<c:merchantReferenceCode>testmerchrefnu</c:merchantReferenceCode>
<c:requestID>4419584464565000001520</c:requestID>
<c:decision>ACCEPT</c:decision>
<c:reasonCode>100</c:reasonCode>
<c:purchaseTotals>
<c:currency>eur</c:currency>
</c:purchaseTotals>
<c:directDebitRefundReply>
<c:reasonCode>100</c:reasonCode>
<c:amount>50.00</c:amount>
<c:requestDateTime>2015-09-11T08:00:46Z</c:requestDateTime>
<c:reconciliationID>02WWNTQG000000IE49RRNC</c:reconciliationID>
</c:directDebitRefundReply>
</c:replyMessage>
For detailed descriptions of all request fields see Request Fields and for reply fields see Reply Fields.
 
 
Direct Debit Void
 
To request a follow-on direct debit void:
Step 1
Include the following fields in the request.
Example 11
Follow-On Direct Debit Void Request
<requestMessage xmlns="urn:schemas-cybersource-com:transaction-data-1.24">
<merchantID>dd_test</merchantID>
<merchantReferenceCode>testmerchrefnu</merchantReferenceCode>
<voidService run="true">
<voidRequestID>4419577124885000001518</voidRequestID>
</voidService>
</requestMessage>
 
* 
The voidService_voidRequestID field must be set to the requestID value that is returned from the original direct debit request.
Below are the transaction reply fields.
Example 12
Follow-On Direct Debit Void Reply
<c:replyMessage xmlns:c="urn:schemas-cybersource-com:transaction-data-1.24">
<c:merchantReferenceCode>testmerchrefnu</c:merchantReferenceCode>
<c:requestID>4419587288875000001514</c:requestID>
<c:decision>ACCEPT</c:decision>
<c:reasonCode>100</c:reasonCode>
<c:purchaseTotals>
<c:currency>EUR</c:currency>
</c:purchaseTotals>
<c:voidReply>
<c:reasonCode>100</c:reasonCode>
<c:requestDateTime>2015-09-11T08:05:28Z</c:requestDateTime>
<c:amount>50.00</c:amount>
<c:currency>eur</c:currency>
</c:voidReply>
</c:replyMessage>
For detailed descriptions of all request fields see Request Fields and for reply fields see Reply Fields.
 
Direct Debit Refund Void
 
To request a follow-on direct debit refund void:
Step 1
Include the following fields in the request.
Example 13
Follow-On Direct Debit Void Request
<requestMessage xmlns="urn:schemas-cybersource-com:transaction-data-1.24">
<merchantID>dd_test</merchantID>
<merchantReferenceCode>testmerchrefnu</merchantReferenceCode>
<voidService run="true">
<voidRequestID>4419577124885000001518</voidRequestID>
</voidService>
</requestMessage>
 
* 
The directDebitVoidService_requestID field must be set to the requestID value that is returned from the original direct debit refund request.
Below are the transaction reply fields.
Example 14
Direct Debit Refund Void Reply
<c:replyMessage xmlns:c="urn:schemas-cybersource-com:transaction-data-1.24">
<c:merchantReferenceCode>testmerchrefnu</c:merchantReferenceCode>
<c:requestID>4419587288875000001514</c:requestID>
<c:decision>ACCEPT</c:decision>
<c:reasonCode>100</c:reasonCode>
<c:purchaseTotals>
<c:currency>EUR</c:currency>
</c:purchaseTotals>
<c:voidReply>
<c:reasonCode>100</c:reasonCode>
<c:requestDateTime>2015-09-11T08:05:28Z</c:requestDateTime>
<c:amount>50.00</c:amount>
<c:currency>eur</c:currency>
</c:voidReply>
</c:replyMessage>
For detailed descriptions of all request fields see Request Fields and for reply fields see Reply Fields.
 
UK Domestic Direct Debits (BACS)
Based on the BACS (Bankers’ Automated Clearing Services) Automated Direct Debit Instruction Service (AUDDIS), U.K. merchants must lodge the direct debit mandate prior to a direct debit deposit. This process requires the biller to send a pre-notification to the payer at least five calendar days before collecting the payment from the payer’s account.
Direct Debit Mandate Lodgement
To lodge a UK direct debit mandate:
Step 1
Include the following fields in the request.
Example 15
UK Direct Debit Mandate Lodgement
<requestMessage xmlns="urn:schemas-cybersource-com:transaction-data-1.24">
<merchantID>dd_test</merchantID>
<merchantReferenceCode>testmerchrefnu</merchantReferenceCode>
<billTo>
<firstName>Bob</firstName>
<lastName>Smith</lastName>
<street1>1st Test Way</street1>
<city>London</city>
<country>United Kingdom</country>
<email>example@example.com</email>
</billTo>
<purchaseTotals>
<currency>GBP</currency>
<grandTotalAmount>0</grandTotalAmount>
</purchaseTotals>
<fundTransfer>
<accountNumber>6576456576453546</accountNumber>
</fundTransfer>
<bankInfo>
<bankCode>123465</bankCode>
<country>GB</country>
</bankInfo>
<directDebitService run="true">
<recurringType>5</recurringType>
<mandateID>1234564798</mandateID>
<mandateAuthenticationDate>20150909</mandateAuthenticationDate>
</directDebitService>
<prenoteTransaction>true</prenoteTransaction>
</requestMessage>
 
 
* 
The prenoteTransaction field must be set to true to indicate that the request is to lodge a direct debit mandate and is not a direct debit request. The purchaseTotals_grandTotalAmount field must be set to 0 and the directDebitService_recurringType field must be set to 5, 6, or 7.
Below are the transaction reply fields.
Example 16
Direct Debit Mandate Lodgement Reply
<c:replyMessage xmlns:c="urn:schemas-cybersource-com:transaction-data-1.24">
<c:merchantReferenceCode>testmerchrefnu</c:merchantReferenceCode>
<c:requestID>4422189794305000001515</c:requestID>
<c:decision>ACCEPT</c:decision>
<c:reasonCode>100</c:reasonCode>
<c:purchaseTotals>
<c:currency>gbp</c:currency>
</c:purchaseTotals>
<c:directDebitReply>
<c:reasonCode>100</c:reasonCode>
<c:amount>0.00</c:amount>
<c:requestDateTime>2015-09-14T08:22:59Z</c:requestDateTime>
<c:reconciliationID>02WWNTMG000000IE4A4IL4</c:reconciliationID>
</c:directDebitReply>
</c:replyMessage>
For detailed descriptions of all request fields see Request Fields and for reply fields see Reply Fields.
 
Direct Debit
 
To request a UK direct debit:
Step 1
Include the following fields in the request.
Example 17
UK Direct Debit Request
<requestMessage xmlns="urn:schemas-cybersource-com:transaction-data-1.24">
<merchantID>dd_test</merchantID>
<merchantReferenceCode>testmerchrefnu</merchantReferenceCode>
<billTo>
<firstName>Bob</firstName>
<lastName>Smith</lastName>
<street1>1st Test Way</street1>
<city>London</city>
<country>United Kingdom</country>
<email>example@example.com</email>
</billTo>
<purchaseTotals>
<currency>GBP</currency>
<grandTotalAmount>50.00</grandTotalAmount>
</purchaseTotals>
<fundTransfer>
<accountNumber>6576456576453546</accountNumber>
</fundTransfer>
<bankInfo>
<bankCode>123465</bankCode>
<country>GB</country>
</bankInfo>
<directDebitService run="true">
<recurringType>1</recurringType>
<mandateID>1234564798</mandateID>
<mandateAuthenticationDate>20150909</mandateAuthenticationDate>
</directDebitService>
</requestMessage>
 
* 
The directDebitService_recurringType field must be set to 1, 2, or 3. The purchaseTotals_grandTotalAmount field must greater than 0.
Below are the transaction reply fields.
Example 18
UK Direct Debit Reply
<c:replyMessage xmlns:c="urn:schemas-cybersource-com:transaction-data-1.24">
<c:merchantReferenceCode>testmerchrefnu</c:merchantReferenceCode>
<c:requestID>4422195345155000001516</c:requestID>
<c:decision>ACCEPT</c:decision>
<c:reasonCode>100</c:reasonCode>
<c:purchaseTotals>
<c:currency>gbp</c:currency>
</c:purchaseTotals>
<c:directDebitReply>
<c:reasonCode>100</c:reasonCode>
<c:amount>50.00</c:amount>
<c:requestDateTime>2015-09-14T08:32:14Z</c:requestDateTime>
<c:reconciliationID>02WWNTNG000000IE4A4JRM</c:reconciliationID>
</c:directDebitReply>
</c:replyMessage>
For detailed descriptions of all request fields see Request Fields and for reply fields see Reply Fields.