Requesting Direct Debit Services

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


ics_applications=ics_direct_debit_validate merchant_id=dd_test merchant_ref_number=testmerchrefnu customer_firstname=Bob customer_lastname=smith bill_address1=1 Test way bill_city=Vienna bill_country=Austria bank_country=AT bank_iban=AT611904300234573201 bank_swiftcode=RVSAAT2S024 customer_email=example@example.com direct_debit_mandate_authentication_date=20150909 direct_debit_recurring_type=1 mandate_id=1234658799 grand_total_amount=50.00 currency=EUR

Below are the transaction reply fields.

Example 2

Direct Debit Validate Reply


direct_debit_validate_trans_ref_no=02WWNTRG000000IE49QL2C direct_debit_validate_time=2015-09-10T141603Z direct_debit_validate_amount=50.00 direct_debit_validate_response_code=100 direct_debit_validate_rflag=SOK direct_debit_validate_rmsg=Request was processed successfully direct_debit_validate_rcode=1 direct_debit_validate_iban=AT611904300234573201 direct_debit_validate_bank_swift_code=RVSAAT2S024 ics_rcode=1 ics_rmsg=Request was processed successfully. ics_rflag=SOK request_id=4418945624900170574175 currency=eur merchant_ref_number=testmerchrefnu

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 bank_iban and the bank_swiftcode request fields wi th the BBAN request fields below.

Example 3

BBAN Request Fields


bank_account_number=1234568 bank_code=12345678

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 4

Direct Debit Request including the IBAN


ics_applications=ics_direct_debit merchant_id=dd_test merchant_ref_number=testmerchrefnu customer_firstname=Bob customer_lastname=smith bill_address1=1 Test way bill_city=Vienna bill_country=Austria bank_country=AT bank_iban=AT611904300234573201 bank_swiftcode=RVSAAT2S024 customer_email=example@example.com direct_debit_mandate_authentication_date=20150909 direct_debit_recurring_type=1 mandate_id=1234658799 grand_total_amount=50.00 currency=EUR

Below are the transaction reply fields.

Example 5

Direct Debit Request Reply


direct_debit_time=2015-09-10T141803Z direct_debit_amount=50.00 direct_debit_trans_ref_no=02WWNTLG000000IE49ZCRY direct_debit_rmsg=Request was processed successfully. direct_debit_rcode=1 direct_debit_rflag=SOK ics_rcode=1 ics_rflag=SOK ics_rmsg=Request was processed successfully. request_id=4418946831850170574175 currency=eur merchant_ref_number=testmerchrefnu

For detailed descriptions of all request fields see Request Fields and for reply fields see Reply Fields.

To request a direct debit including the BBAN:

Step 1

Include the fields in Example 4.

Step 2

Replace the bank_iban and the bank_swiftcode request fields with the BBAN request fields below.

Example 6

BBAN Request Fields


bank_account_number=1234568 bank_code=12345678

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 7

Direct Debit Refund Request including the IBAN


ics_applications=ics_direct_debit_refund merchant_id=dd_test merchant_ref_number=testmerchrefnu customer_firstname=Bob customer_lastname=smith bill_address1=1 Test way bill_city=Vienna bill_country=Austria bank_country=AT bank_iban=AT611904300234573201 bank_swiftcode=RVSAAT2S024 customer_email=example@example.com direct_debit_mandate_authentication_date=20150909 direct_debit_recurring_type=1 mandate_id=1234658799 grand_total_amount=50.00 currency=EUR

Below are the transaction reply fields.

Example 8

Direct Debit Refund Reply


direct_debit_refund_time=2015-09-10T142248Z direct_debit_refund_trans_ref_no=02WWNTKG000000IE49ZAAA direct_debit_refund_rflag=SOK direct_debit_refund_rmsg=Request was processed successfully direct_debit_refund_rcode=1 direct_debit_refund_amount=50.00 ics_rflag=SOK ics_rcode=1 ics_rmsg=Request was processed successfully. request_id=4418949672590170574175 currency=eur merchant_ref_number=testmerchrefnu

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 7.

Step 2

Replace the bank_iban and the bank_swiftcode request fields wi th the BBAN request fields below.

Example 9

BBAN Request Fields


bank_account_number=1234568 bank_code=12345678

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 10

Follow-On Direct Debit Request


ics_applications=ics_direct_debit validate_request_id=4418986822850170574175 merchant_id=dd_test merchant_ref_number=testmerchrefnu customer_firstname=Bob customer_lastname=smith bill_address1=1 Test way bill_city=Vienna bill_country=Austria bank_country=AT bank_iban=AT611904300234573201 bank_swiftcode=RVSAAT2S024 customer_email=example@example.com direct_debit_mandate_authentication_date=20150909 direct_debit_recurring_type=1 mandate_id=1234658799 grand_total_amount=50.00 currency=EUR


	The validate_request_id field must be set to the request_id value that is returned from the original direct debit validate request.

Below are the transaction reply fields.

Example 11

Follow-On Direct Debit Reply


direct_debit_time=2015-09-10T152458Z direct_debit_amount=50.00 direct_debit_trans_ref_no=02WWNTRG000000IE49QM6Z direct_debit_rmsg=Request was processed successfully direct_debit_rcode=1 direct_debit_rflag=SOK ics_rcode=1
ics_rmsg=Request was processed successfully. ics_rflag=SOK request_id=4418986976850170574175 currency=eur merchant_ref_number=testmerchrefnu

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 12

Follow-On Direct Debit Refund Request


ics_applications=ics_direct_debit_refund direct_debit_request_id=4418986822850170574175 merchant_id=dd_test merchant_ref_number=testmerchrefnu customer_firstname=Bob customer_lastname=smith bill_address1=1 Test way bill_city=Vienna bill_country=Austria bank_country=AT bank_iban=AT611904300234573201 bank_swiftcode=RVSAAT2S024 customer_email=example@example.com direct_debit_mandate_authentication_date=20150909 direct_debit_recurring_type=1 mandate_id=1234658799 grand_total_amount=50.00 currency=EUR


	The direct_debit_request_id field must be set to the request_id value that is returned from the original direct debit request.

Below are the transaction reply fields.

Example 13

Follow-On Direct Debit Refund Reply


direct_debit_refund_time=2015-09-10T152749Z direct_debit_refund_trans_ref_no=02WWNTPG000000IE49PBGU direct_debit_refund_rflag=SOK direct_debit_refund_rcode=1 direct_debit_refund_rmsg=Request was processed successfully direct_debit_refund_amount=50.00 ics_rflag=SOK ics_rcode=1 ics_rmsg=Request was processed successfully. request_id=4418988690300170574175 currency=eur merchant_ref_number=testmerchrefnu

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 14

Follow-On Direct Debit Void


ics_applications=ics_void void_request_id=4419575367615000001521 merchant_ref_number=testmerchrefnu merchant_id=dd_test


	The void_request_id field must be set to the request_id value that is returned from the original direct debit request.

Below are the transaction reply fields.

Example 15

Direct Debit Void Reply


void_void_request_time=2015-09-11T080259Z void_void_currency=eur void_void_amount=50.00 void_rmsg=Request was processed successfully. void_rcode=1 void_rflag=SOK ics_rcode=1 ics_rmsg=Request was processed successfully. ics_rflag=SOK request_id=4419585779580171399324 currency=EUR merchant_ref_number=testmerchrefnu

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 16

Follow-On Direct Debit Refund Void


ics_applications=ics_void void_request_id=4419575367615000001521 merchant_ref_number=testmerchrefnu merchant_id=dd_test


	The void_request_id field must be set to the request_id value that is returned from the original direct debit refund request.

Below are the transaction reply fields.

Example 17

Direct Debit Refund Void Reply


void_void_request_time=2015-09-11T080259Z void_void_currency=eur void_void_amount=50.00 void_rcode=1 void_rmsg=Request was processed successfully. void_rflag=SOK request_id=4419585779580171399324 currency=EUR ics_rflag=SOK ics_rcode=1 ics_rmsg=Request was processed successfully. merchant_ref_number=testmerchrefnu

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 18

UK Direct Debit Mandate Lodgement


ics_applications=ics_direct_debit merchant_id=dd_test merchant_ref_number=testmerchrefnu customer_firstname=Bob customer_lastname=smith bill_address1=1 Test way bill_city=London bill_country=United Kingdom bank_country=GB bank_account_number=12345645 bank_code=123456 customer_email=example@example.com direct_debit_mandate_authentication_date=20150909 direct_debit_recurring_type=5 mandate_id=1234658799 prenote_transaction=1 grand_total_amount=0 currency=GBP


	The prenote_transaction field must be set to 1 to indicate that the request is to lodge a direct debit mandate and is not a direct debit request. The grand_total_amount field must be set to 0 and the direct_debit_recurring_type field must be set to 5, 6, or 7.

Below are the transaction reply fields.

Example 19

Direct Debit Mandate Lodgement Reply


direct_debit_time=2015-09-14T073013Z direct_debit_amount=0.00 direct_debit_trans_ref_no=02WWNTQG000000IE49UU40 direct_debit_rmsg=Request was processed successfully direct_debit_rcode=1 direct_debit_rflag=SOK currency=gbp ics_rflag=SOK ics_rcode=1 ics_rmsg=Request was processed successfully. request_id=4422158122250170574238 merchant_ref_number=testmerchrefnu

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 20

UK Direct Debit Request


ics_applications=ics_direct_debit merchant_id=dd_test merchant_ref_number=testmerchrefnu customer_firstname=Bob customer_lastname=smith bill_address1=1 Test way bill_city=London bill_country=United Kingdom bank_country=GB bank_account_number=12345645 bank_code=123456 customer_email=example@example.com direct_debit_mandate_authentication_date=20150909 direct_debit_recurring_type=1 mandate_id=1234658799 grand_total_amount=50.00 currency=GBP


	The direct_debit_recurring_type field must be set to 1, 2, or 3. The grand_total_amount field must greater than 0.

Below are the transaction reply fields.

Example 21

Direct Debit Mandate Lodgement Reply


direct_debit_time=2015-09-14T083859Z direct_debit_amount=50.00 direct_debit_trans_ref_no=02WWNTKG000000IEEGB7PA direct_debit_rmsg=Request was processed successfully direct_debit_rcode=1 direct_debit_rflag=SOK currency=gbp ics_rflag=SOK ics_rcode=1 ics_rmsg=Request was processed successfully. request_id=4422199389180170574238 merchant_ref_number=testmerchrefnu

For detailed descriptions of all request fields see Request Fields and for reply fields see Reply Fields.