If the value of "countryCode" is "US" (United States of America) or "CA" (Canada) the "state" parameter is required. The value of "state" must be a valid State Code. (ex. "countryCode": "US", "state": "NY",)
SEPA
Last changes: 10-28-2022
- Get Financial Institution Data
- Initiate Authorization
- Collect Payment Option Details via SDK
- SEPA Mandate Acceptance Page
- Complete Authorization
Before initializing the authorization process, call the API method 1.84 Get Financial Institution Data.
Get Financial Institution Data Request
Path:
GET {baseURL}/settings/getFinancialInstitutionData?localDate=2017-08- 21&localTime=170911&partnerReference=TEST-4H363TJC68
Header:
Content-Type: application/json
Accept-Language: en-US
This will provide you with information about the financial institution, which will act as a Creditor in the SEPA Direct Debit process. This information is necessary for the SEPA Mandate Acceptance Page.
Get Financial Institution Data Response
Status Code:
200 (OK)
Header:
Content-Type: application/json
Accept-Language: en-US
{
"name": "Volkswagen Payments S.A. (SANDBOX)",
"addr1": "19-21, Route d’Arlon",
"city": "Luxembourg",
"state": "Strassen",
"countryName": "Germany",
"countryCode": "DE",
"countryCode3": "DEU",
"postCode": "L-8009",
"creditorIdentifier": "DE98ZZZ09999999999",
"contactPhone": "+49 892 488 5811",
"contactEmail": "user@example.com",
"partnerReference": "DEV-SVR001-DE_CUSTID-T8933PXJPK_CARTID-DJ7JKK662D_FK8K3MPJBQ",
"localDate": "2018-10-24",
"localTime": "093028",
"sysDate": "2018-10-24",
"sysTime": "073028",
"responseCode": "0000",
"responseDescription": "Successful execution",
"additionalInformation": {
"requestId": "aff2728481a181dc36daedc14055b516"
}
}
Each mandate must include certain mandatory legal wording and mandatory information. The page contains not only the details of customer (name, address, etc.) and creditor information (see 1. Get Financial Institution Data), but also the mandate parameters (mandate reference number, date, time). You must display the following standard authorization text (replacing {FI name} with the name of the creditor) clearly visible and close to the accept button.
With the SEPA direct debit authorization, you authorize {FI name} to send instructions to your bank account. You also authorize your bank to debit your account in accordance with the instructions from {FI name}. A refund must be claimed within 8 weeks, starting from the date on which your account was debited.
We suggest to display the mandate in a modal window as depicted in the mockup below.
We highly recommend to use a GUID (Globally Unique Identifier) with the canonical 8-4-4-4-12 format as the mandate reference number.
With accepting the SEPA Mandate, the customer authorizes you to collect a payment for the specified amount from their bank account using SEPA Direct Debit and is redirected to the specified “callbackURL”.
Note, that the 1.39 Complete Authorize response includes the internal representation of the Account Number (indicated by the parameter Account Number Type).
The response includes the Transaction Status under the return parameter "statusCode", which at this point should be set to "AUTHORIZED" and indicates that the payment was authorized.
Please note if "responseCode": "0035" is returned this indicates the transaction is already "Authorized" and it should be treated as a Successful Response.
This can occur if 1.39 Complete Authorize is called twice.
In such a case it is safe to continue with 1.29 Capture.