Get payment methods

/v2/adyen/payment_methods

Target audience: Developers

Get payment methods¶

Release version: 4.7.5

Introduction¶

This endpoint returns Adyen payment methods available for purchase.

Attention

This API gives access to Adyen related endpoints. Since this section is quite specific it has it's own section of documentation. See here for more information.

URI¶

Environment	URI
Stage	https://payway-api.stage.adeprimo.se/external/api/v2/adyen/payment_methods
Production	https://backend.worldoftulo.com/external/api/v2/adyen/payment_methods

Requirements¶

Identity	Scope
No	`/external/adyen/r`

Curl Examples¶

Period id¶

Return Adyen payment method setup for supplied period id.

curl --request GET \
  --url https://payway-api.stage.adeprimo.se/external/api/v2/adyen/payment_methods?period_id=585a4768edce2c5e6f000001&product_code=adeprimo_digital&origin=https%3A%2F%2Fpurchase.example.org \
  --header 'accept: application/json' \
  --header 'authorization: Bearer <token>'

Parameter	Description	Required	Format	Type
period_id	Id of the payment period	Yes	Size range ..24 Allowed values: "/^[a-f\d]{24}$/i"	String
product_code	The product code for a package/campaign.	Yes	Size range ..100 Allowed values: "/^[a-f\d]{100}$/i"	String
origin	URI where purchase is performed (E.g. https://purchase.example.org). Must be URL-encoded. Must be the same as the origin value that is set in the PAP payment configuration.	Yes	Size range: ..1024 Allowed values: uri regex that is too long to show here. Must be absolute	String

Product code¶

Returns all Adyen payment methods for package or campaign.

curl --request GET \
  --url https://payway-api.stage.adeprimo.se/external/api/v2/adyen/payment_methods?product_code=adeprimo_digital&origin=https%3A%2F%2Fpurchase.example.org \
  --header 'accept: application/json' \
  --header 'authorization: Bearer <token>'

Parameters

Parameter	Description	Required	Format	Type
product_code	The product code for a package/campaign.	Yes	Size range ..100 Allowed values: "/^[a-f\d]{100}$/i"	String
origin	URI where purchase is performed (E.g. https://purchase.example.org). Must be URL-encoded. Must be the same as the origin value that is set in the PAP payment configuration.	Yes	Size range: ..1024 Allowed values: uri regex that is too long to show here. Must be absolute	String

Order Id¶

Returns all Adyen payment methods based on order id. Most often used for 0 amount verification transactions.

curl --request GET \
  --url https://payway-api.stage.adeprimo.se/external/api/v2/adyen/payment_methods?order_id=ADEPRIMOSE-123&origin=https%3A%2F%2Fpurchase.example.org \
  --header 'accept: application/json' \
  --header 'authorization: Bearer <token>'

Parameters

Parameter	Description	Required	Format	Type
order_id	The payway order id	Yes	Size range: ..1024 and match format /\A[A-Z]+[-{1}]\d+/	String
origin	URI where purchase is performed (E.g. https://purchase.example.org). Must be URL-encoded. Must be the same as the origin value that is set in the PAP payment configuration.	Yes	Size range: ..1024 Allowed values: uri regex that is too long to show here. Must be absolute	String

Response¶

Example response¶

HTTP 200
{
  "items": [
    {
      "details": [],
      "name": "Credit Card",
      "type": "scheme"
    }
    ...
  ]
}

The result is used to initiate the Adyen drop-in widget. The contents of "items", not the entire result.

Errors¶

This API uses the common error conventions of the Payway API

See common error responses