Mandate

Object

Name	Type	Mandatory	Description
class	string	Y	The type of object which is being returned. In this case it will be mandate
status	string	Y	The status of the mandate. See statuses.
currency	string	Y	The currency (ISO-4217).
end_reason	string	N	Reason why the mandate has ended.
start_date	string	N	The date when the mandate was authorized by the customer.
end_date	string	N	The date when the mandate ended.
authentification_3ds	object	Y	The 3ds authentication details. See authentication 3ds object. This will be null until the payment has been processed.

Mandate statuses

Status	Final	Description
ACTIVE	N	The mandate is active which means the token can be used to process new payments.
FAILED	Y	The mandate is failed and cannot be used to make further payments.
CANCELLED	Y	The mandate has been manually canceled and cannot be used to make further payments.
ENDED	Y	The mandate has ended and cannot be used to make further payments.
EXPIRED	Y	The mandate is expired and cannot be used to make further payments.
ERROR	Y	An error occured whilst trying to create the mandate.
TIMED_OUT	Y	The token has been cancelled because no card details were provided before the accept_until parameter date.
NOT_REQUESTED	N	The mandate was not requested, therefore it was not created.

Example

{
    "class":"mandate",
    "status":"ACTIVE",
    "currency":"EUR",
    "end_reason":null,
    "start_date":1423755674,
    "end_date":null
}