SDD payment and mandate Copy section link Copied!

SDD payment Copy section link Copied!

The Single Euro Payments Area (SEPA) Direct Debit is a standardised payment method for bank-to bank transactions within the European Union.

AgoraPay supports:

  • Both one-off and recurring SEPA payments
  • B2B customers (professionals only). In this case, a copy of the SDD mandate must be transmitted by the payer to its bank when the signature or certification occurs, in order for the bank to register the mandate's characteristics. It's important to remind this to the payers to avoid payment rejections.
  • B2C customers (individuals or professionals). In this case, the payer has 8 weeks to reject the payment after the payment has occurred.

SDD Payment characteristics Copy section link Copied!

Payment method

B2B / B2C direct debit

Countries

SEPA Europe zone

Payment execution

Marketplace initiative

Currency

EUR

Funds collection

+1 working days

Payment dispute

Yes

Refunds

Yes

Partial refunds

Yes

Partial captures

No

Recurring payments

Yes

Available countries Copy section link Copied!

Name

Country code

BIC

IBAN

Currency Code

Mandatory address

Andorra

AND

AD

AD

EUR

Austria

AUT

AT

AT

EUR

Belgium

BEL

BE

BE

EUR

Bulgaria

BGR

BG

BG

BGN

Yes

Croatia

HRV

HR

HR

HRK

Yes

Cyprus

CYP

CY

CY

EUR

Czech Republic

CZE

CZ

CZ

CZK

Yes

Denmark

DNK

DK

DK

DKK

Yes

Estonia

EST

EE

EE

EUR

Finland

FIN

FI

FI

EUR

France

FRA

FR

FR

EUR

French Guiana

GIN

GF

FR

EUR

Germany

DEU

DE

DE

EUR

Gibraltar

GIB

GI

GI

GIP

Yes

Greece

GRC

GR

GR

EUR

Guadeloupe

GLP

GP

FR

EUR

Guernsey

GGY

GG

GB

GBP

Yes

Hungary

HUN

HU

HU

HUF

Yes

Iceland

ISL

IS

IS

ISK

Yes

Ireland

IRL

IE

IE

EUR

Isle of Man

GBR

IM

GB

GBP

Yes

Italy

ITA

IT

IT

EUR

Jersey

JEY

JE

GB

GBP

Yes

Latvia

LVA

LV

LV

EUR

Liechtenstein

LIE

LI

LI

CHF

Yes

Lithuania

LTU

LT

LT

EUR

Luxembourg

LUX

LU

LU

EUR

Malta

MLT

MT

MT

EUR

Martinique

MTQ

MQ

FR

EUR

Mayotte

MYT

YT

FR

EUR

Yes

Monaco

MCO

MC

MC

EUR

Yes

Netherlands

NLD

NL

NL

EUR

Norway

NOR

NO

NO

NOK

Yes

Poland

POL

PL

PL

PLN

Yes

Portugal

PRT

PT

PT

EUR

Réunion

REU

RE

FR

EUR

Romania

ROU

RO

RO

RON

Yes

Saint Barthélémy

BLM

BL

FR

EUR

Saint Martin

MAF

MF

FR

EUR

Yes

Saint Martin

SXM

MF

FR

EUR

Yes

Saint Pierre and Miquelon

SPM

PM

FR

EUR

Yes

San Marino

SMR

SM

SM

EUR

Slovakia

SVK

SK

SK

EUR

Slovenia

SVN

SI

SI

EUR

Spain

ESP

ES

ES

EUR

Sweden

SWE

SE

SE

SEK

Yes

Switzerland

CHE

CH

CH

CHF

Yes

United Kingdom

GBR

GB

GB

GBP

Yes

Vatican City State

VAT

VA

VA

EUR

Yes

SDD Direct Debit Mandate payment processing workflow Copy section link Copied!

The main steps for a SDD payment transaction include

  1. The buyer validates his cart on the marketplace
  2. The buyer selects SDD as a payment method on the marketplace website
  3. The SDD e-mandate is subject to signature validation beyond a pre established threshold. Pin will be sent by sms.
  4. Agorapay redirect the buyer to the Marketplace
  5. The Marketplace displays the SDD mandat confirmation
  6. Pre notification e-mail is sent to the buyer

Please note : in case of Recurring SDD payment, except for the first SDD payment, Mandate Reference (RUM) is directly transmitted via the API Payment. No path.

Please note, the SDD Business to Business (SDD BtoB) and Business to Customer (SDD BtoC) workflow are the same.
But few differencies must be underlined :

For a BtoB SDD

  • Debtor must be a business
  • Mandate signature is required only beyond pre established threshold.
  • Mandate registration by Debtor bank is required
  • Mandate is undisputable

For a BtoC SDD

  • Debtor can be a consumer or a business
  • Mandate signature is required only beyond pre established threshold
  • Mandate is disputable

SDD Payment processing (BtoB or BtoC) / Bounce API Mode Copy section link Copied!

SDD mandate Copy section link Copied!

The SDD mandate is delivered in PDF format, base-64 encoded.

There is two separate ways to retrieve a mandate:

  1. On the transaction identifier when its status is 'COMPLETED' or 'REFUSED'
  2. On the unique mandate reference (RUM/UMR), without condition on the SDD transaction(s) associated to this reference


cURL
Copy
Copied
1
2
3
curl -X 'GET' \\
'<https://api.live.agorapay.com/api/v1/payin/mandate>' \\
-H 'accept: application/json
Copy
Copied
Request Url
Copy
Copied
1
https://api.live.agorapay.com/api/v1/payin/mandate
Copy
Copied

SDD Mandate parameters Copy section link Copied!

Parameter Name
Required
Type
Description
transactionId
string
Must be a transaction for SDD. Must be provided if reference is not present.
reference
string
Mandate reference (UMR). Must be provided if transationId is not present

Example Copy section link Copied!

cURL
Copy
Copied
1
2
3
4
5
curl --get 'https://API_URL/mkp/v1/payin/mandate'  
-H 'Authorization: Bearer <your_access_token>'
-H 'id_token: <your_id_token>'
-d 'transactionId=165231523612'
-d 'reference=202111191439350V8211102'
Copy
Copied

Retrieving the result Copy section link Copied!

If your request is successful, you will receive a getMandate response, containing the following information:

Parameter Name
Type
Description
resultCode
string
resultCodeMessage
string
transactionId
string
reference
string
signedFileContent
string

PDF file base64 encoded

Example Copy section link Copied!

Here is a successful response example:

cURL
Copy
Copied
1
2
3
4
curl --get 'https://API_URL/mkp/v1/payin/mandate'  
-H 'Authorization: Bearer <your_access_token>'
-H 'id_token: <your_id_token>'
-d 'reference=2020110907201100Y0H1102'
Copy
Copied

If the request is not successful, you will receive a response error with no SDD mandate.

Unpaid SDD management Copy section link Copied!

It is possible to receive unpaid before or after the payment effective date.
This leads to 2 distinct behaviors:

  1. Collection of an unpaid amount before the compensation (after payment effective date) leads to the cancellation of the direct debit.
    An operation before the effective date is in status 'W'. The reception of the unpaid amount will result to an operation update to status 'C ' and a webhook being sent.
  2. Collection of an unpaid after compensation (after payment effective date) possible up to 13 months in the event of a contestation by the debitor. The operation after the payment effective date is in status 'E'. The collection of the unpaid will lead to the creation of a new UNPAID type operation with status W and the sending of a webhook.
JSON
Copy
Copied
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{"amount":"100.00",
"currencyCode":"EUR",
"eventCode":"operation",
"operationDate":"20220211",
"operationMasterId":"838221",
"operationSide":"-1",
"operationStatus":"W",
"operationType":"9",
"orderRef":"1643327181103ref6",
"paymentMethodTypeId":"1",
"transactionId":"UNPAID-838221",
"versionNumber":"1.0"}
Copy
Copied

This webhook has the following specificity:

  • The operationType = 9 (for unpaid type)
  • The transactionId respects the following nomenclature: UNPAID-XXXXX where XXXXX corresponds to the transaction which caused the unpaid
  • The operationMasterId corresponds to the transaction that suffered the chargeback.
  • Once the unpaid funds have been cleared, the status of the UNPAID type transaction will change to E and a webhook will be issued.