This site requires javascript to be enabled.

Results for

xxx

Create mandate

POST https://{domainname}/v1/{merchantId}/mandates

Mandates

The mandates REST services allow you to manage mandates, used in SEPA Direct Debit payments.

Request

Creates a mandate to be used in a SEPA Direct Debit payment.

Create mandate supports idempotent requests

PayloadCreateMandateRequest

Properties
Property Type Required Details
close

Description

An alias for the mandate. This can be used to visually represent the mandate.
Do not include any unobfuscated sensitive data in the alias.
Default value if not provided is the obfuscated IBAN of the customer.
close

Description

Customer object containing customer specific inputs
  • SDK Object type
    MandateCustomer
close

Description

Object containing IBAN information
  • SDK Object type
    BankAccountIban
close

Description

Name in which the account is held.
close

Description

The IBAN is the International Bank Account Number. It is an internationally agreed format for the BBAN and includes the ISO country code and two check digits.
close

Description

Name of company, as a customer
close

Description

Object containing contact details like email address and phone number
  • SDK Object type
    MandateContactDetails
close

Description

Email address of the customer
close

Description

Object containing billing address details
  • SDK Object type
    MandateAddress
close

Description

City
close

Description

ISO 3166-1 alpha-2 country code
close

Description

House number
close

Description

Streetname
close

Description

Zip code
close

Description

Object containing personal information of the customer
  • SDK Object type
    MandatePersonalInformation
close

Description

Object containing the name details of the customer
  • SDK Object type
    MandatePersonalName
close

Description

Given name(s) or first name(s) of the customer
close

Description

Surname(s) or last name(s) of the customer
close

Description

Object containing the title of the customer (Mr, Miss or Mrs)
close

Description

The unique identifier of a customer
close

Description

The language code of the customer, one of de, en, es, fr, it, nl, si, sk, sv.
close

Description

Specifies whether the mandate is for one-off or recurring payments. Possible values are:
  • UNIQUE
  • RECURRING
close

Description

Return url to use if the mandate signing requires redirection.
close

Description

Specifies whether the mandate is unsigned or singed by SMS. Possible values are:
  • UNSIGNED
  • SMS
close

Description

The unique identifier of the mandate

Request example

SDK: .NET

This scenario you will probably use the most

  • var bankAccountIban = new BankAccountIban();
    bankAccountIban.Iban = "DE46720200700359736690";
    
    var contactDetails = new MandateContactDetails();
    contactDetails.EmailAddress = "wile.e.coyote@acmelabs.com";
    
    var mandateAddress = new MandateAddress();
    mandateAddress.City = "Monumentenvallei";
    mandateAddress.CountryCode = "NL";
    mandateAddress.Street = "Woestijnweg";
    mandateAddress.Zip = "1337XD";
    
    var name = new MandatePersonalName();
    name.FirstName = "Wile";
    name.Surname = "Coyote";
    
    var personalInformation = new MandatePersonalInformation();
    personalInformation.Name = name;
    personalInformation.Title = "Miss";
    
    var customer = new MandateCustomer();
    customer.BankAccountIban = bankAccountIban;
    customer.CompanyName = "Acme labs";
    customer.ContactDetails = contactDetails;
    customer.MandateAddress = mandateAddress;
    customer.PersonalInformation = personalInformation;
    
    var body = new CreateMandateRequest();
    body.Customer = customer;
    body.CustomerReference = "idonthaveareference";
    body.Language = "nl";
    body.RecurrenceType = "UNIQUE";
    body.SignatureType = "UNSIGNED";
    
    var response = await client.V1.WithNewMerchant("merchantId").Mandates.Create(body);
    

Responses

Please find below an overview of the possible responses.

Response 201 - CreatedCreateMandateResponse

The create mandate request succeeded. Data on the resulting mandate can be found in the response.

Properties
Property Type Required Details
close

Description

Object containing information on a mandate
  • SDK Object type
    MandateResponse
close

Description

An alias for the mandate. This can be used to visually represent the mandate.
Do not include any unobfuscated sensitive data in the alias.
Default value if not provided is the obfuscated IBAN of the customer.
close

Description

Customer object containing customer specific inputs
  • SDK Object type
    MandateCustomer
close

Description

Object containing IBAN information
  • SDK Object type
    BankAccountIban
close

Description

Name in which the account is held.
close

Description

The IBAN is the International Bank Account Number. It is an internationally agreed format for the BBAN and includes the ISO country code and two check digits.
close

Description

Name of company, as a customer
close

Description

Object containing contact details like email address and phone number
  • SDK Object type
    MandateContactDetails
close

Description

Email address of the customer
close

Description

Object containing billing address details
  • SDK Object type
    MandateAddress
close

Description

City
close

Description

ISO 3166-1 alpha-2 country code
close

Description

House number
close

Description

Streetname
close

Description

Zip code
close

Description

Object containing personal information of the customer
  • SDK Object type
    MandatePersonalInformation
close

Description

Object containing the name details of the customer
  • SDK Object type
    MandatePersonalName
close

Description

Given name(s) or first name(s) of the customer
close

Description

Surname(s) or last name(s) of the customer
close

Description

Object containing the title of the customer (Mr, Miss or Mrs)
close

Description

The unique identifier of the customer to which this mandate is applicable
close

Description

Specifieds whether the mandate is for one-off or recurring payments.
close

Description

The status of the mandate. Possible values are:
  • ACTIVE
  • EXPIRED
  • CREATED
  • REVOKED
  • WAITING_FOR_REFERENCE
  • BLOCKED
  • USED

close

Description

The unique identifier of the mandate
close

Description

Object that contains the action, including the needed data, that you should perform next, showing the redirect to a third party to complete the payment or like showing instructions
  • SDK Object type
    MandateMerchantAction
close

Description

Action merchants needs to take in the online mandate process. Possible values are:
  • REDIRECT - The customer needs to be redirected using the details found in redirectData
close

Description

Object containing all data needed to redirect the customer
  • SDK Object type
    MandateRedirectData
close

Description

A Message Authentication Code (MAC) is used to authenticate the redirection back to merchant after the payment.
close

Description

The URL that the customer should be redirected to. Be sure to redirect using the GET method.

Response example

SDK: .NET

This scenario you will probably use the most

  • {
        "mandate" : {
            "customerReference" : "idonthaveareference",
            "customer" : {
                "bankAccountIban" : {
                    "iban" : "DE46720200700359736690"
                },
                "mandateAddress" : {
                    "street" : "Woestijnweg",
                    "city" : "Monumentenvallei",
                    "zip" : "1337XD",
                    "countryCode" : "NL"
                },
                "companyName" : "Acme labs",
                "contactDetails" : {
                    "emailAddress" : "wile.e.coyote@acmelabs.com"
                },
                "personalInformation" : {
                    "name" : {
                        "firstName" : "Wile",
                        "surname" : "Coyote"
                    },
                    "title" : "Miss"
                }
            },
            "recurrenceType" : "UNIQUE",
            "status" : "ACTIVE",
            "uniqueMandateReference" : "42268d8067df43e18a50a2ebf4bdb729"
        }
    }
    

Response 400 - Bad requestErrorResponse

Properties
Property Type Required Details
close

Description

Unique reference, for debugging purposes, of this error response
close

Description

List of one or more errors
close

Description

Contains detailed information on one single error.
  • SDK Object type
    APIError
close

Description

Category the error belongs to. The category should give an indication of the type of error you are dealing with. Possible values:
  • CONNECT_PLATFORM_ERROR - indicating that a functional error has occurred in the Connect platform.
  • PAYMENT_PLATFORM_ERROR - indicating that a functional error has occurred in the Payment platform.
  • IO_ERROR - indicating that a technical error has occurred within the Connect platform or between Connect and any of the payment platforms or third party systems.
close

Description

Error code
close

Description

HTTP status code for this error that can be used to determine the type of error
close

Description

ID of the error. This is a short human-readable message that briefly describes the error.
close

Description

Human-readable error message that is not meant to be relayed to customer as it might tip off people who are trying to commit fraud
close

Description

Returned only if the error relates to a value that was missing or incorrect.
Contains a location path to the value as a JSonata query.
Some common examples:
  • a.b selects the value of property b of root property a,
  • a[1] selects the first element of the array in root property a,
  • a[b='some value'] selects all elements of the array in root property a that have a property b with value 'some value'.
close

Description

ID of the request that can be used for debugging purposes

Response example

SDK: .NET

This scenario you will probably use the most

  • {
        "errorId" : "15eabcd5-30b3-479b-ae03-67bb351c07e6-00000092",
        "errors" : [
            {
                "code" : "20000000",
                "propertyName" : "customer.billingAddress.street",
                "message" : "PARAMETER_NOT_FOUND_IN_REQUEST"
            }
        ]
    }