SDD - Mandate - Create

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

email

string <email>

required

Customer's email address associated with the payment

>= 6 characters<= 128 characters

lastname

string

required

Customer's last name

>= 1 characters<= 128 characters

Match pattern:

^[A-Za-z0-9]+$

iban

string

required

Account's IBAN (ISO 13616)

>= 14 characters<= 34 characters

Match pattern:

^[A-Z]{2}[0-9]{2}[A-Z0-9]{10,30}$

address

string

required

Customer's address

>= 1 characters<= 128 characters

Match pattern:

^[A-Za-z0-9]+$

zipCode

string

required

Customer's postal code

>= 1 characters<= 16 characters

Match pattern:

^[A-Za-z0-9]+$

city

string

required

Customer's city

>= 1 characters<= 64 characters

Match pattern:

^[A-Za-z0-9]+$

country

string

required

Customer's country of residence (ISO 3166-1 Alpha 3)

>= 3 characters<= 3 characters

uid

string | null

optional

Your own customer ID

>= 1 characters<= 64 characters

Match pattern:

^[A-Za-z0-9]+$

bic

string | null

optional

Account's BIC (ISO 9362)

>= 8 characters<= 11 characters

Match pattern:

^[A-Z]{6}[A-Z0-9]{2}([A-Z0-9]{3})?$

accountOwner

string | null

optional

Account's owner (person or company)

>= 1 characters<= 64 characters

clientId

string | null

optional

Customer's Easytransac ID (only available if you have already made a payment for this customer)

>= 7 characters<= 7 characters

Match pattern:

^[A-Za-z0-9]{7}$

firstname

string | null

optional

Customer's first name

>= 1 characters<= 128 characters

Match pattern:

^[A-Za-z0-9]+$

callingCode

integer | null

optional

Customer's calling code

>= 1<= 999

phone

string | null

optional

Customer's phone number

>= 5 characters<= 18 characters

Match pattern:

^[0-9]{5,18}$

birthDate

string <date> | null

optional

Customer's birth date (ATOM)

>= 10 characters<= 10 characters

nationality

string | null

optional

Customer's nationality (ISO 3166-1 Alpha 3)

>= 3 characters<= 3 characters

Example

{
  "email": "abc@abc.com",
  "lastname": "ABCabc123",
  "iban": "FR7630001007941234567890185",
  "address": "ABCabc123",
  "zipCode": "ABCabc123",
  "city": "ABCabc123",
  "country": "FRA"
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://api.sandbox.easytransac.com/v2/sdd/mandate/create' \
--header 'Content-Type: application/json' \
--data-raw '{
    "email": "abc@abc.com",
    "lastname": "ABCabc123",
    "iban": "FR7630001007941234567890185",
    "address": "ABCabc123",
    "zipCode": "ABCabc123",
    "city": "ABCabc123",
    "country": "FRA"
}'

Responses

🟢200OK

application/json

OK

Body

success

boolean

required

Whether the action was successful

date

string <date-time>

required

Date of response (ATOM)

>= 25 characters<= 25 characters

data

object

required

Additional data

mandateId

string

required

Easytransac mandate ID

>= 20 characters<= 20 characters

Match pattern:

^[a-z0-9]{20}$

status

enum<string>

required

Mandate status

>= 6 characters<= 7 characters

Allowed values:

activeinvalidpending

dateCreated

string <date-time>

required

Date of creation of the resource (ATOM)

Example

{
  "success": true,
  "date": "2024-12-31T23:59:59+02:00",
  "data": {
    "mandateId": "abcabcabcabcabcabc12",
    "status": "active",
    "dateCreated": "2024-12-31T23:59:59+02:00"
  }
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠405405

🔴500Server Error

🔴502Bad Gateway

🔴504Gateway Timeout