Show full documentation

 Show full documentation

Definition

An interface to manage the direct debit mandates of customers.

Business Context and Use

The web service interface Manage Direct Debit Mandate offers the operations MaintainBundle and CheckMaintainBundle.

MaintainBundle will execute a save at the end of its process if no errors occur, where as CheckMaintainBundle will not persist the changes made.

The operation MaintainBundle allows you to adjust the following fields:

• DebtorIdentificationCode

• Description

• SingleUseIndicator

• BlockedIndicator

• MandateType

• ValidityPeriod

• SignatureDate

• SignatureCity

• AlternativePayer

It also allows you to change the status of the mandate and to add attachments.

Prerequisites

The operation MaintainBundle can be used to create direct debit mandates providing that the customer data and financial data has already been created. The customer data refers to the creation of a business partner as a customer. The financial data for the company and customer combination must also be present for the creation to succeed. If, for example, there is financial data present for Company A and a mandate create is attempted with Company B then there will not be a success.

Mandates without a status provided will be created in a In Preparation status. This can then be activated by setting the status to Active. A prerequisite of this is that the Signature City and Signature Date must be filled. From an active state it is also possible to set a mandate to Obsolete. When providing the payload you can use the following codes when refering to statuses.

2 - Active

5 - Obsolete

More Information

General Information

You can find general information about Web services, their structure and consumption in the Web Services documentation. Please open the Web Services document in a new window.

Here is an example of a simple web service request:

<n0:DirectDebitMandateBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
 <BasicMessageHeader>
  <ID>MsgID 1</ID>
 </BasicMessageHeader>
 <DirectDebitMandate actionCode="01">
  <ObjectNodeSenderTechnicalID>Tech ID 1 </ObjectNodeSenderTechnicalID>
  <MandateID>2018</MandateID>
  <CompanyID>Company_A</CompanyID>
  <PayerID>Customer X</PayerID>
  <DebtorIdentificationCode>123</DebtorIdentificationCode>
  <PayerBankDetailsID>0001</PayerBankDetailsID>
  <Description>Mandate Created in Store by Salesperson</Description>
  <SingleUseIndicator>false</SingleUseIndicator>
  <BlockedIndicator>false</BlockedIndicator>
  <MandateType>1</MandateType>
  <ValidityPeriod>
   <StartDate>2018-01-01</StartDate>
   <EndDate>2028-01-01</EndDate>
  </ValidityPeriod>
  <SignatureDate>2018-01-01</SignatureDate>
  <SignatureCity>London</SignatureCity>
  <Status>2</Status>
 </DirectDebitMandate>
</n0:DirectDebitMandateBundleMaintainRequest_sync>

This will create a mandate with ID 2018 for Customer X in Company A. The status 2 in this case will update the status to Active.

 Show full documentation

 Show full documentation

Definition

To create, update or delete direct debit mandate data.

Business Context and Use

The request message of the operation MaintainBundle contains a BasicMessageHeader node element as well as a DirectDebitMandate node element that contains the Direct Debit Mandate data to be created or updated. The DirectDebitMandate node can occur multiple times in the request message.

The response message contains log items, processing information and specific information per Direct Debit Mandate node passed - ReferenceObjectNodeSenderTechnicalID, ChangeStateID, as well as Direct Debit Mandate ID and UUID

Structure

DirectDebitMandate

The Direct Debit Mandate structure contains all general DDM informtion.

The identifying information is needed in the create scenarios in every case:

• Company Information (either UUID or ID)

• Payer Information (either UUID or ID)

• PayerBankDetailsID

The following information is optional in a create sceanrio:

• MandateID (if this is not passed, it will be auto-generated)

• DebtorIdentificationCode (default is blank)

• Description (default is blank)

• SingleUseIndicator (default is false)

• BlockedIndicator (default is false)

• MandateType (1 - SEPA Core(default), 2 - SEPA B2B, 3 - SEPA COR1)

• ValidityPeriod

• SignatureDate (default is blank)

• SignatureCity (default is blank)

• Status (2 - Active, 5 - Obsolete, 6 - In Preparation(default))

For update and delete scenarios an key must be used to uniquely identify the DDM. You can use the following keys to find the DDM:

• Mandate UUID

• Company ID/UUID AND Mandate ID

AlternativePayer

The Alternative Payer structure contains information referring to the Alternative Payer seen on the UI. It is not mandatory to provide this node. In this node the following elements can be passed:

• AlternativePayerName

• HouseNumber

• Street

• City

• Country

• State

• PostalCode

Attachment Folder

The AttachmentFolder node element can be used to add and remove DDM attachments.

Data for this node can be found on the DDM UI as attachments. On the user interface, files and links can be created. In the web service request, links and files are differentiated through the CategoryCode:

Category code	Description
2	Document
3	Link

The different types of attachments are differentiated by the TypeCode:

Type code	Description
10001	Standard attachment
10016	Business partner image
10017	Business card

To create link attachments, document elements must be as follows:

Element	Value
VisibleIndicator	true
CategoryCode	3
TypeCode	<none>
AlternativeName	<Document Title>
ExternalLinkWebURI	<link URI>
Description	<Comment>

To create file attachments, document elements must be as follows:

Element	Value
VisibleIndicator	true
CategoryCode	2
TypeCode	<none>
Name	<Document Title>
AlternativeName	<Document Title>
Description	<Comment>

Example

• This will create a DDM and set its status to active

<n0:DirectDebitMandateBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
 <BasicMessageHeader>
 </BasicMessageHeader> 
  <DirectDebitMandate actionCode="01">
  <ObjectNodeSenderTechnicalID>Tech ID 1 </ObjectNodeSenderTechnicalID>
  <CompanyID>Comp A</CompanyID>
  <PayerID>Cust X</PayerID>
  <PayerBankDetailsID>0001</PayerBankDetailsID>
  <Description>TEST</Description>
  <Status>2</Status>
  <SignatureDate>2018-05-01</SignatureDate>
  <SignatureCity>Galway</SignatureCity>
  <AlternativePayer>
   <AlternativePayerName>Jon Doe</AlternativePayerName>
   <HouseNumber>11</HouseNumber>
   <Street>Sample Street</Street>
   <City>Galway</City>
   <Country>IE</Country>
   <State>GW</State>
   <PostalCode>12345</PostalCode>
  </AlternativePayer>
  </DirectDebitMandate>
</n0:DirectDebitMandateBundleMaintainRequest_sync>	

• This will set the status of a mandate to obsolete. The key in this case is the combination of Company, Payer and PayerBankDetailsID

<n0:DirectDebitMandateBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> 
	<BasicMessageHeader>
	</BasicMessageHeader>
	<DirectDebitMandate actionCode="02">
		<ObjectNodeSenderTechnicalID>Tech ID 1</ObjectNodeSenderTechnicalID> 
		<CompanyID>Company A</CompanyID>
		<MandateID>2018</MandateID>
		<Status>5</Status>
	</DirectDebitMandate>
</n0:DirectDebitMandateBundleMaintainRequest_sync>

 Show full documentation

 Show full documentation

Definition

To check if a Direct Debit Mandate can be created without errors.

Business Context and Use

This operation is the same as MaintainBundle without the save at the end of the process. Please refer to this documentation for a thorough explaination.