Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
stylenone
Child pages (Children Display)
allChildrentrue

What are Mandates?

Mandates are containers for storing information needed to perform transactions which do NOT require consumer interaction. Mandates can be used for SEPA and for creditcards.

...

  • Transaction-based: A Mandate is created by performing an /createPayment which contains a Recurrence element. This is described in One-time or periodically recurring payment .

  • Transactionless: A Mandate is created without reference to an ‘original transaction’.

Creating a Transactionless Mandate

Url: https://sandbox.globadyme.com/api/globadymeGateway/mandate/create

Authorization: JWT

Request example:

Code Block
{ 
    "agreed" : true, 
    "consumerEmail": "consumer@email.com",
    "mandateSignatureDate": "2024-11-22T11:11:11.00Z",
    "consumerBic": "test bic",
    "consumerIban" : "NL02ABNA0123456789",
    "consumerName": "test consumerName",
    "consumerAddress": "test consumerAddress",
    "paymentMethod": "SEPA",
    "country": "NL"
}

Properties for request:

...

Name

...

Description

...

Type

...

M/O/C

...

agreed

...

Whether or not the consumer agreed to the creation of this Mandate

...

boolean

...

Mandatory

...

consumerEmail

...

Consumer’s emailaddress

...

String

...

Mandatory

...

mandateSignatureDate

...

Timestamp reflecting when the consumer agreed to the Mandate. Formatted conforming to ISO-8601 using Date and Time in UTC.

...

String

...

Mandatory

...

consumerBic

...

Consumer’s BIC.

...

String

...

Optional

...

consumerIban

...

Consumer’s IBAN

...

String

...

Mandatory

...

consumerName

...

Consumer’s full name

...

String

...

Mandatory

...

consumerAddress

...

Consumer’s address

...

String

...

Mandatory

...

paymentMethod

...

  • .

...

String

...

Mandatory

...

country

...

Country where the Consumer lives.

...

String

...

Mandatory

Response example:

Code Block
{
    "message": "mandate",
    "details": {
        "mandateCreated": {
            "merchantId": "a323f135-28b3-f0a1-3b12-2e00000000",
            "mandateReference": "eede9564ba194ff1a26d78e5751567ab",
            "mandateCreated": "2025-01-08T13:50:10.432141756Z",
            "agreed": true,
            "agreementTimestamp": "2024-11-22T11:11:11Z",
            "consumerName": "test consumerName",
            "consumerEmail": "consumer@email.com",
            "consumerBic": "test bic",
            "consumerIban": "NL02ABNA0123456789",
            "consumerAddress": "test consumerAddress",
            "mandateType": "Transactionless",
            "paymentMethod": "SEPA",
            "country": "NL"
        }
    }
}

The only fields present in the response which were not part of the request are:

...

Name

...

Description

...

Type

...

merchantId

...

Merchant’s merchantId

...

String

...

mandateReference

...

The reference to be used for this Mandate. This is the one you’ll want to store

...

String

...

mandateCreated

...

Timestamp when this Mandate was created

...