SDD - Mandate - Debit

Initializes a SDD (SEPA Direct Debit) from a mandateId.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Path Params

mandateId

string

required

Easytransac mandate ID

>= 20 characters<= 20 characters

Example:

Match pattern:

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

Body Params application/json

amount

integer

required

Transaction amount (cents)

>= 1

b2b

boolean | null

optional

The collection is a B2B direct debit and concerns payments between companies which aren't self-employed persons. It isn't contestable by the customer.

Default:

false

clientIp

string <ipv4> | null

optional

Customer's IP (v4 or v6)

>= 7 characters<= 45 characters

orderId

string | null

optional

Your own transaction/order ID

>= 1 characters<= 64 characters

description

string | null

optional

Description of the transaction

>= 1 characters<= 2048 characters

multiplePayments

boolean | null

optional

Splits the payment into several transactions

Default:

false

multiplePaymentsRepeat

integer | null

optional

Number of transactions by which the payment is split if multiplePayments is enabled

>= 2<= 10

Default:

downPayment

integer | null

optional

Amount of the first transaction if rebill or multiplePayments is enabled (cents)

>= 1

rebill

boolean | null

optional

Enables subscription recurring payments

Default:

false

recurrence

enum<string> | enum<null>

optional

Recurring payments frequency if rebill is enabled

>= 5 characters<= 10 characters

Allowed values:

dailyweeklymonthlybimonthlyquarterlybiannualyearly

Default:

monthly

payToEmail

string <email> | null

optional

Redirect the collection of this transaction to another Easytransac user account by its email

>= 6 characters<= 128 characters

payToId

integer | null

optional

Redirect the collection of this transaction to another Easytransac user account by its ID

>= 1<= 99999999999

userAgent

string | null

optional

Customer's browser's user agent

>= 1 characters<= 2048 characters

language

enum<string> | enum<null>

optional

Preferred language of the payment page (ISO 639)

>= 3 characters<= 3 characters

Allowed values:

DEUENGFREITASPA

Default:

FRE

Example

{
  "amount": 1000
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

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

tid

string

required

Transaction ID

>= 8 characters<= 14 characters

Match pattern:

^[A-Za-z0-9-]{8,14}$

status

enum<string>

required

Transaction status

>= 6 characters<= 10 characters

Allowed values:

authorizedcapturedfailedpendingrefunded

amount

integer

required

Transaction amount (cents)

>= 1

dateCreated

string <date-time>

required

Date of creation of the resource (ATOM)

orderId

string | null

optional

Your own transaction/order ID

>= 1 characters<= 64 characters

Example

{
  "success": true,
  "date": "2024-12-31T23:59:59+02:00",
  "data": {
    "tid": "ABC1-ABC1-ABC1",
    "status": "captured",
    "amount": 1000,
    "dateCreated": "2024-12-31T23:59:59+02:00",
    "orderId": "ABCabc123"
  }
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠405405

🔴500Server Error

🔴502Bad Gateway

🔴504Gateway Timeout