Get hosted mandate management status
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.
Request example
This scenario you will probably use the most
-
var response = await client.V1.WithNewMerchant("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.
Properties
|
|||
Property | Type | Required | Details |
---|---|---|---|
object | no | read close | |
close
DescriptionWhen a mandate has been created during the hosted mandate management session this object will return the details.
|
|||
close
DescriptionAn 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
DescriptionCustomer object containing customer specific inputs
|
|||
close
DescriptionObject containing IBAN information
Depends on:Required for Create mandate and Create payment calls
|
|||
close
DescriptionName in which the account is held.
Depends on:Required for the creation of a Payout
Required for Create and Update token calls. |
|||
close
DescriptionThe 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 (AfterPay Installments) in Austria (AT) and Germany (DE). Required for Create mandate and Create payment with mandate calls |
|||
close
DescriptionName of company, as a customer
|
|||
close
DescriptionObject containing contact details like email address and phone number
|
|||
close
DescriptionEmail address of the customer
|
|||
close
DescriptionObject 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.
|
|||
close
DescriptionCity
Depends on:Required for Create mandate and Create payment calls.
Required for Create hostedCheckout calls where the IBAN is also provided. |
|||
close
DescriptionISO 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
DescriptionHouse number
|
|||
close
DescriptionStreetname
Depends on:Required for Create mandate and Create payment calls.
Required for Create hostedCheckout calls where the IBAN is also provided. |
|||
close
DescriptionZip code
Depends on:Required for Create mandate and Create payment calls.
Required for Create hostedCheckout calls where the IBAN is also provided. |
|||
close
DescriptionObject containing personal information of the customer
Depends on:Required for Create mandate and Create payment calls
|
|||
close
DescriptionObject containing the name details of the customer
Depends on:Required for create mandate and Create payment calls
|
|||
close
DescriptionGiven name(s) or first name(s) of the customer
Depends on:Required for create mandate and Create payment calls
|
|||
close
DescriptionSurname(s) or last name(s) of the customer
Depends on:Required for create mandate and Create payment calls
|
|||
close
DescriptionObject containing the title of the customer (Mr, Miss or Mrs)
Depends on:Required for create mandate and Create payment calls
|
|||
close
DescriptionThe unique identifier of the customer to which this mandate is applicable
|
|||
close
DescriptionSpecifieds whether the mandate is for one-off or recurring payments.
|
|||
close
DescriptionThe status of the mandate. Possible values are:
|
|||
close
DescriptionThe unique identifier of the mandate
|
|||
status | enum | no | read close |
close
DescriptionThis is the status of the hosted mandate management. Possible values are:
|
|||
Property | Type | Required | Details |
Response example
This scenario you will probably use the most
-
{ "status" : "MANDATE_CREATED", "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 |
---|---|---|---|
errorId | string | yes | read close |
close
DescriptionUnique reference, for debugging purposes, of this error response
|
|||
array of object | yes | read close | |
close
DescriptionList of one or more errors
|
|||
close
DescriptionCategory the error belongs to. The category should give an indication of the type of error you are dealing with.
Possible values:
|
|||
close
DescriptionError code
|
|||
close
DescriptionHTTP status code for this error that can be used to determine the type of error
|
|||
close
DescriptionID of the error. This is a short human-readable message that briefly describes the error.
|
|||
close
DescriptionHuman-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
DescriptionReturned 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:
|
|||
close
DescriptionID of the request that can be used for debugging purposes
|
|||
Property | Type | Required | Details |
Response example
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" } ] }