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: Node.js
This scenario you will probably use the most
-
const sdkResponse = await client.v1.hostedmandatemanagements.get("merchantId", "hostedMandateManagementId"); // sdkResponse has the following properties: // - status: the HTTP status code // - body: the response body // - isSuccess: true if the call was successful, // or false if the Worldline Global Collect platform returned an error response
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.
|
|||
| alias | string | no | read close |
|
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. |
|||
| object | no | read close | |
|
close
DescriptionCustomer object containing customer specific inputs
|
|||
| object | depends | read close | |
| accountHolderName | string (30) | depends | read close |
|
close
DescriptionName in which the account is held.
|
|||
| iban | string (50) | depends | read close |
|
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.
|
|||
| companyName | string (40) | no | read close |
|
close
DescriptionName of company, as a customer
|
|||
| object | no | read close | |
|
close
DescriptionObject containing contact details like email address and phone number
|
|||
| emailAddress | string (70) | no | read close |
|
close
DescriptionEmail address of the customer
|
|||
| object | depends | read close | |
| city | string (40) | depends | read close |
|
close
DescriptionCity
|
|||
| countryCode | string (2) | depends | read close |
|
close
DescriptionISO 3166-1 alpha-2 country code
|
|||
| houseNumber | string (15) | no | read close |
|
close
DescriptionHouse number
|
|||
| street | string (50) | depends | read close |
|
close
DescriptionStreetname
|
|||
| zip | string (10) | depends | read close |
|
close
DescriptionZip code
|
|||
| object | depends | read close | |
|
close
DescriptionObject containing personal information of the customer
|
|||
| object | depends | read close | |
|
close
DescriptionObject containing the name details of the customer
|
|||
| firstName | string (15) | depends | read close |
|
close
DescriptionGiven name(s) or first name(s) of the customer
|
|||
| surname | string (70) | depends | read close |
|
close
DescriptionSurname(s) or last name(s) of the customer
|
|||
| title | enum | depends | read close |
|
close
DescriptionObject containing the title of the customer (Mr, Miss or Mrs)
|
|||
| customerReference | string (35) | yes | read close |
|
close
DescriptionThe unique identifier of the customer to which this mandate is applicable
|
|||
| recurrenceType | enum | yes | read close |
|
close
DescriptionSpecifieds whether the mandate is for one-off or recurring payments.
|
|||
| status | enum | no | read close |
|
close
DescriptionThe status of the mandate. Possible values are:
|
|||
| uniqueMandateReference | string | no | read close |
|
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:
|
|||
Response example
SDK: Node.js
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
|
|||
| object | no | read close | |
| category | string | no | read close |
|
close
DescriptionCategory the error belongs to. The category should give an indication of the type of error you are dealing with.
Possible values:
|
|||
| code | string | yes | read close |
|
close
DescriptionError code
|
|||
| httpStatusCode | integer | no | read close |
|
close
DescriptionHTTP status code for this error that can be used to determine the type of error
|
|||
| id | string | no | read close |
|
close
DescriptionID of the error. This is a short human-readable message that briefly describes the error.
|
|||
| message | string | no | read close |
|
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
|
|||
| propertyName | string | no | read close |
|
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:
|
|||
| requestId | string | no | read close |
|
close
DescriptionID of the request that can be used for debugging purposes
|
|||
Response example
SDK: Node.js
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" } ] }