ALL
Server API version 1.0
Java

icon-search-large

Get mandate

GET https://{domainname}/v1/{merchantId}/mandates/{uniqueMandateReference}

Mandates

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

Request

Gets a created mandate.

Request example

SDK: Java

This scenario you will probably use the most

  • GetMandateResponse response = client.merchant("merchantId").mandates().get("42268d8067df43e18a50a2ebf4bdb729");
    

Responses

Please find below an overview of the possible responses.

Response 200 - OKGetMandateResponse

The requested mandate is found. Data can be found in the body.

Property Type Required Details
mandate object no read close
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

Depends on:

Required for Create mandate and Create payment calls
  • SDK Object type
    BankAccountIban
close

Description

Name in which the account is held.

Depends on:

Required for the creation of a Payout
Required for Create and Update token calls.
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.

Depends on:

Required for the creation of a Payout
Required for Create and Update token.
Required for payments with product 9000 in Austria (AT) and Germany (DE).
Required for Create mandate and Create payment with mandate calls
close

Description

Name of company, as a consumer
close

Description

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

Description

Email address of the consumer
close

Description

Object containing billing address details

Depends on:

Required for Create mandate and Create payment calls.
Required for Create hostedCheckout calls where the IBAN is also provided.
  • SDK Object type
    MandateAddress
close

Description

City

Depends on:

Required for Create mandate and Create payment calls.
Required for Create hostedCheckout calls where the IBAN is also provided.
close

Description

ISO 3166-1 alpha-2 country code

Depends on:

Required for Create mandate and Create payment calls.
Required for Create hostedCheckout calls where the IBAN is also provided.
close

Description

House number
close

Description

Streetname

Depends on:

Required for Create mandate and Create payment calls.
Required for Create hostedCheckout calls where the IBAN is also provided.
close

Description

Zip code

Depends on:

Required for Create mandate and Create payment calls.
Required for Create hostedCheckout calls where the IBAN is also provided.
close

Description

Object containing personal information of the consumer

Depends on:

Required for Create mandate and Create payment calls
  • SDK Object type
    MandatePersonalInformation
close

Description

Object containing the name details of the consumer

Depends on:

Required for create mandate and Create payment calls
  • SDK Object type
    MandatePersonalName
close

Description

Given name(s) or first name(s) of the consumer

Depends on:

Required for create mandate and Create payment calls
close

Description

Surname(s) or last name(s) of the consumer

Depends on:

Required for create mandate and Create payment calls
close

Description

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

Depends on:

Required for create mandate and Create payment calls
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

Response example

SDK: Java

This scenario you will probably use the most

  • {
        "mandate" : {
            "customerReference" : "idonthaveareference",
            "customer" : {
                "bankAccountIban" : {
                    "iban" : "DE46940594210000012345"
                },
                "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 404 - Not foundErrorResponse

Mandate not found.

Property Type Required Details
errorId string yes read close
close

Description

Unique reference, for debugging purposes, of this error response
errors array of object yes read close
close

Description

List of one or more errors
close
  • 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 consumer 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: Java

This scenario you will probably use the most

  • {
        "errorId" : "15eabcd5-30b3-479b-ae03-67bb351c07e6-00000092",
        "errors" : [
            {
                "code" : "20000000",
                "message" : "MANDATE_NOT_FOUND"
            }
        ]
    }
    
icon_top_1