Import a Mandate

On This Page
You must import a mandate to the
Cybersource
 database if you create a mandate in your own system and do not use the
Cybersource
 create mandate service.
You can import a mandate to the
Cybersource
 database in these circumstances:
  • You have existing customers with signed and active mandates
  • You manage mandates outside of
    Cybersource
When you import an existing mandate to the
Cybersource
 database, you must provide a unique value for the mandate ID in the
mandateID
 field.

Confirmation Email

To have an email sent to the customer to confirm the mandate's creation, include the optional
billTo_email
 field. The sent email includes an e-mandate PDF.

Endpoints

Set the
apImportMandateService_run
 field to
true
, and send the request to one of these endpoints:
Production:
https://ics2ws.ic3.com/commerce/1.x/transactionProcessor
Test:
https://ics2wstest.ic3.com/commerce/1.x/transactionProcessor

Response Statuses

The import mandate service responds with one of these statuses in the
apImportMandateReply_status
 field:
  • Active
    : the import mandate request is accepted.
  • Failed
    : the import mandate request is not accepted.
The import mandate service also responds with a reason code in the
apImportMandateReply_reasonCode
 field. For more information about reason codes, see the Reason Codes for SEPA Direct Debits for the Simple Order API.

Optional Fields for Importing a Mandate

billTo_company
billTo_county
billTo_middleName
billTo_title

Test Trigger for Importing a Mandate

In the
Cybersource
 test environment, you can simulate specific response messages that you receive from transaction requests by including certain values in your transaction requests. The simulated environment enables you to become familiar with the response messages and develop methods for error handling.
Your account must be configured for testing trigger values. Contact your
Cybersource
 account manager for more details.

Test Endpoint

For test transactions, send an API request to the test endpoint.
Test:
https://ics2wstest.ic3.com/commerce/1.x/transactionProcessor

Trigger Value

To test for importing a mandate, send a mandate import request and set the
merchantReferenceCode
 field to a value listed in the Trigger Value column. The
Cybersource
 response status is returned in the
apImportMandateReply_status
 field.
Direct Debit Test Triggers for Importing a Mandate
Cybersource
 Response Status
Trigger Value
Active
No trigger.

Simple Order Example: Importing a Mandate Service

Light Dark
Request
1234567891011121314151617181920212223
<="urn:schemas-cybersource-com:transaction-data-1.214">
	<merchantID>test-merchant</merchantID>
	<merchantReferenceCode>refnum-1234</merchantReferenceCode>
	<paymentScheme>sepa</paymentScheme>
	<mandateID>12345678912345</mandateID>
	<billTo>
		<firstName>John</firstName>
		<lastName>Smith</lastName>
		<street1>321 Trafalgar Square</street1>
		<city>Sunnyville</city>
		<postalCode>55555</postalCode>
		<country>FR</country>
		<email>test@cybs.com</email>
		<customerID>ddd09876543212434</customerID>
	</billTo>
	<fundTransfer>
            <iban>GB82HLFX11087412413569</iban>
       </fundTransfer>
	<apPaymentType>STS</apPaymentType>
	<apImportMandateService run="true">
		<dateSigned>20240220</dateSigned>
	</apImportMandateService>
</>
Response to a Successful Request
1234567891011121314151617
<:c="urn:schemas-cybersource-com:transaction-data-1.214">
    <merchantReferenceCode>refnum-1234</merchantReferenceCode>
    <requestID>7084683629286990803007</requestID>
    <decision>ACCEPT</decision>
    <reasonCode>100</reasonCode>
    <requestToken>Axin7wSTgA+8cJLsU/A///8ZYjWmdmnTkx5TiwnvvwyjXoA/Thk0ky9GK/uLAD6TgA+8cJLsU/A/AAAA9xPv</requestToken>
    <apImportMandateReply>
        <reasonCode>100</reasonCode>
        <mandateID>AKXEASSG5J5Z</mandateID>
        <status>ACTIVE</status>
        <responseCode>00015</responseCode>
        <processorTransactionID>b1344353-cb24-4d19-b27e-f43bc1963613</processorTransactionID>
        <dateSigned>20240220</dateSigned>
        <dateCreated>20240220</dateCreated>
        <dateTime>2024-02-20T22:32:44Z</dateTime>
    </apImportMandateReply>
</>