AdyenClient.Checkout.Sessions (AdyenClient v1.0.0)

Copy Markdown View Source

Adyen Checkout Sessions API.

Manages payment sessions for the Drop-in and Components integration.

Summary

Functions

Create a payment session.

Get the result of a payment session.

Functions

create(params, opts \\ [])

@spec create(
  map(),
  keyword()
) :: AdyenClient.Client.response()

Create a payment session.

Required fields

  • amount%{currency: "USD", value: 1000} (value in minor units)
  • merchantAccount
  • returnUrl
  • reference — your unique order reference

Example

AdyenClient.Checkout.Sessions.create(%{
  amount: %{currency: "USD", value: 1000},
  merchantAccount: "YourMerchantECOM",
  returnUrl: "https://yoursite.com/result",
  reference: "order-123"
})

get(session_id, session_result \\ nil, opts \\ [])

@spec get(String.t(), String.t() | nil, keyword()) :: AdyenClient.Client.response()

Get the result of a payment session.

Parameters

  • session_id — the session ID returned by create/2
  • session_result — the sessionResult query param from the return URL (optional)