SEPA through Adyen integration guide
The SEPA (Single Euro Payments Area) through Adyen is a pan-European network that allows consumers to send and receive payments in euros (€) between two cross-border bank accounts in the eurozone. With SEPA, sending money within the eurozone is as easy as making your usual domestic bank transfers.
A SEPA credit transfer is a single transfer of euros from one person or organization to another. For example, this could be to pay the deposit for a holiday rental or to settle an invoice. A SEPA direct debit is a recurring payment. For example, to pay monthly rent or for a service like a mobile phone contract.
Services and compatibility
Payment method gateway name | Adyen |
Supported transaction types | Note: SEPA through Adyen does not support chargebacks. |
Supported integration methods |
|
Supported processing currencies | EUR |
Webhook event types |
|
Configuration
Apart from working with Integrations Support to add SEPA as a payment method, you do not need to do any other configuration steps.
Required fields
The following table shows the required and conditional fields for SEPA transactions in the Create APM one-time-use token request.
Field | Required? | Description |
---|---|---|
isAuthOnly | N | Set to true to run an auth only transaction. |
data.amount | Y | The transaction amount. |
data.currency | Y | The three-character ISO currency code for the transaction. Note: Nexio only supports EUR with SEPA. |
data.paymentMethod | Y | The desired alternative payment method. This value must be adyenSepa . |
data.dueDate | N | The date by which the customer must complete the payment. |
data.description | N | A description of the transaction. |
data.customer.orderNumber | Y | The order number. |
data.customer.firstName | Y | The customer's first name, as it appears on the card. |
data.customer.lastName | Y | The customer's last name, as it appears on the card. |
data.customer.email | Y | The customer's email address. |
data.customer.billToAddressOne | N | The customer's billing street address. |
data.customer.billToAddressTwo | N | Additional street address information, if required. |
data.customer.city | N | The customer's billing city. |
data.customer.billToCountry | Y | The two-character (Alpha-2) ISO country code. |
data.customer.billToPhone | N | The billing phone number. |
data.customer.billToPostal | N | The customer's billing postal code. |
data.customer.billToState | N | The state or province on file with the credit card provider. |
data.customer.customerRef | N | Customer identifier. You can use this field to pass a customer ID to the gateway or APM or to manage user subscriptions. |
data.customer.shipToAddressOne | N | The shipping address, if different from the billing address. |
data.customer.shipToAddressTwo | N | Additional shipping address information, if required. |
data.customer.shipToCity | N | The shipping city. |
data.customer.shipToCountry | N | The two-character (Alpha-2) ISO country code. |
data.customer.shipToPhone | N | The shipping phone number. |
data.customer.shipToPostal | N | The shipping postal code. |
data.customer.shipToState | N | The shipping state or province. |
processingOptions.paymentOptionTag | N | A custom value used to route transactions to a specific gateway or merchant account. |
processingOptions.merchantId | N | The merchant ID (MID). |
data.paymentMethod | Optional | The identifier for the alternative payment method. Use this parameter when you want to only return the SEPA iframe button URL (rather than data for all payment methods associated with the account). The value to use is adyenSepa . |
Transaction types and implementation methods
Regardless of the implementation workflow you implement, consumers will be redirected to SEPA to complete their transactions.
Nexio supports the following transaction types for SEPA:
- Sale
- In an iframe that displays all payment methods available to the customer (based on the customer’s location and the merchant’s configured payment methods)
Testing data
Adyen has an extensive list of test accounts. For more information, see SEPA Direct Debit on Adyen's site.
Response handling
In the one-time-use token request, SEPA gets returned in the paymentMethod
parameter as adyenSepa
.
Nexio responds with transaction results in one of the following ways, depending on your integration workflow:
- Event messages: This applies to integrations that do not pass a
customerRedirectUrl
in the request. - Response fields in the URL: This applies to integrations that do provide a
customerRedirectUrl
in the request.
In addition to one of the above, if your merchant account is configured to receive webhooks, Nexio provides responses to the webhook URLs that have been registered. For further explanation of the webhook event types, see the webhook Event types table.
- Webhook notification: For SEPA, these are the possible webhook event types:
- TRANSACTION_AUTHORIZED
- TRANSACTION_CAPTURED
- TRANSACTION_REFUNDED
- TRANSACTION_SETTLED
For information about how to run each of the integration workflows, see Transaction types above.
Status workflows
The status of a successful transaction with SEPA varies, depending on the options you choose.
Sale
When isAuthOnly
is false
, successful sale transactions will have the following statuses:
- pending (called "authorized" when querying transactions and in Nexio Dashboard)
- settled
When isAuthOnly
is true
, successful sale transactions will have the following status:
- authOnly
Capture
Successful capture transactions will have the following status:
- settled
Next steps
Now, you are ready to get started with running transactions:
If you have any additional questions or feedback, see Contact us.
Updated 8 months ago