Server API version 1.0
Java

Results for

icon-search-large No search results yet
Enter your search query above

Get hosted mandate management status

GET https://{domainname}/v1/{merchantId}/hostedmandatemanagements/{hostedMandateManagementId}

Hosted Mandate Management

Using hostedMandateManagement you can create mandates through our easy to use hosted responsive pages.

Request

You can retrieve the current status of the hosted mandate management by doing a get on the hostedMandateManagementId. When a mandate has been created during the hosted mandate management session the details are returned in this object.

Sessions have a maximum life span of 2 hours. This means that you can only retrieve this information while the session has not timed-out.
The status of the hostedMandateManagement and the mandate will change when the consumer is still busy completing the hosted mandate management session.
The request does not have any additional input parameters.

Request example

SDK: Java

This scenario you will probably use the most

  • GetHostedMandateManagementResponse response = client.merchant("merchantId").hostedmandatemanagements().get("hostedMandateManagementId");
    

Responses

In case the hostedMandateManagementId has not yet expired the response to the GET request will contain the status of the hosted mandate management. In case the consumer has also createad a mandate during the session a mandate object is returned containing the details of the created mandate object.

Response 200 - OKGetHostedMandateManagementResponse

The request was processed correctly and a valid response is returned. In case a mandate was created during the hosted mandate management the details are returned in the mandate object.

       Property Type Required Description
object no SDK object type: MandateResponse
When a mandate has been created during the hosted mandate management session this object will return the details.
alias string no

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.

object no SDK object type: MandateCustomer
Customer object containing customer specific inputs
object depends SDK object type: BankAccountIban
Object containing IBAN information
Depends on: Required for Create mandate and Create payment calls
accountHolderName string (30) depends

Name in which the account is held.
Depends on: Required for the creation of a Payout
Required for Create and Update token calls.

iban string (50) depends

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

companyName string (40) no

Name of company, as a consumer

object no SDK object type: MandateContactDetails
Object containing contact details like email address and phone number
emailAddress string (70) no

Email address of the consumer

object depends SDK object type: MandateAddress
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.
city string (40) depends

City
Depends on: Required for Create mandate and Create payment calls.
Required for Create hostedCheckout calls where the IBAN is also provided.

countryCode string (2) depends

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.

houseNumber string (15) no

House number

street string (50) depends

Streetname
Depends on: Required for Create mandate and Create payment calls.
Required for Create hostedCheckout calls where the IBAN is also provided.

zip string (10) depends

Zip code
Depends on: Required for Create mandate and Create payment calls.
Required for Create hostedCheckout calls where the IBAN is also provided.

object depends SDK object type: MandatePersonalInformation
Object containing personal information of the consumer
Depends on: Required for Create mandate and Create payment calls
object depends SDK object type: MandatePersonalName
Object containing the name details of the consumer
Depends on: Required for create mandate and Create payment calls
firstName string (15) depends

Given name(s) or first name(s) of the consumer
Depends on: Required for create mandate and Create payment calls

surname string (70) depends

Surname(s) or last name(s) of the consumer
Depends on: Required for create mandate and Create payment calls

title enum depends

Object containing the title of the consumer (Mr, Miss or Mrs)
Depends on: Required for create mandate and Create payment calls

customerReference string (35) yes

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

recurrenceType enum yes

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

status enum no

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

uniqueMandateReference string no

The unique identifier of the mandate

status enum no

This is the status of the hosted mandate management. Possible values are:
  • IN_PROGRESS - The session has been created, but no mandate has been created yet.
  • MANDATE_CREATED - A mandate has been created, the consumer might still need to sign the mandate.
  • FAILED - There was an error while creating the mandate, the session can not continue.
  • CANCELLED_BY_CONSUMER - The session was cancelled before a mandate was created
.

Response example

SDK: Java

This scenario you will probably use the most

  • {
        "status" : "MANDATE_CREATED",
        "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 400 - Bad requestErrorResponse

     Property Type Required Description
errorId string yes

Unique reference, for debugging purposes, of this error response

array yes
List of one or more errors
object no SDK object type: APIError
category string no

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.

code string yes

Error code

httpStatusCode integer no

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

id string no

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

message string no

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

propertyName string no

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

requestId string no

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",
                "propertyName" : "bankAccountBban.accountNumber",
                "message" : "PARAMETER_NOT_FOUND_IN_REQUEST"
            }
        ]
    }
    
icon_top_1