PAY-101 - Initiate a payment

post

https://example.com/v1/shop/payments

This endpoint initializes a payment transaction.

It supports:

Card authorizations with or without 3D Secure (3DS).
3DS authentication flows, including redirection steps if required.
Bank transfer payment initialization using virtual IBAN feature.

The response indicates the result of the transaction attempt and may contain an action (such as a redirection or bank transfer instructions) that must be followed to complete the payment.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

browserInfo

object

required

Information from the customer's browser as provided by the Adyen Drop-in widget.

countryCode

string

required

Shopper’s country or region in ISO 3166-1 alpha-2 format.<br>
This is required for all payment methods.
It determines which payment methods are offered and is essential for bank transfers to generate a virtual IBAN and regional instructions.

customerUserIP

string

required

The IP address of the customer initiating the transaction.

locale

string

Locale to use for localized fields (e.g., name).
The provided locale must belong to the allowed locales of the store bound to the Operation.
If the provided locale is unknown for that store, the store default locale is used (fallback).

paymentMethodData

required

reference

string

required

The order reference linked to the payment transaction. Example: "174-107-9164387". Order Djust IDs or external IDs are not allowed.

referenceType

string

Defaults to COMMERCIAL

deprecated

The reference type of the order. Possible values: ["COMMERCIAL", "LOGISTIC"].

returnPath

string

The path to which the shopper will be redirected in case of 3D Secure authentication or any other external redirection.

storePaymentMethod

boolean

Defaults to false

User choice to store the payment method.

Headers

dj-client

string

enum

required

Specifies the client type making the request.

OPERATOR: Platform operator user.
ACCOUNT: Customer account user.
SUPPLIER: Supplier managing orders.

Allowed:

dj-api-key

string

required

API key required for authentication. Must be valid and linked to the requesting user.

dj-store

string

(Optional) Store ID in multi-store environments.

dj-store-view

string

(Optional) Store view ID in multi-store environments.

customer-account-id

string

(Optional) Customer account ID in multi-account customer user.

Response

200Payment successfully processed or further action required