GET
/
payment-service-definitions
/
{payment_service_definition_id}

This endpoint requires the payment-service-definitions.read scope.

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

payment_service_definition_id
string
required

The unique ID of the payment service definition.

Response

200 - application/json
id
string

The ID of the payment service. This is the underlying provider followed by a dash followed by the payment method ID.

type
enum<string>
default: payment-service-definition

payment-service-definition.

Available options:
payment-service-definition
display_name
string

The display name of this service.

method
enum<string>

The ID of the payment method that this services handles.

Available options:
afterpay,
alipay,
alipayhk,
applepay,
bacs,
bancontact,
banked,
becs,
bitpay,
boleto,
boost,
card,
cashapp,
chaseorbital,
checkout-session,
clearpay,
click-to-pay,
dana,
dcb,
dlocal,
ebanx,
eps,
everydaypay,
gcash,
giropay,
givingblock,
gocardless,
googlepay,
googlepay_pan_only,
gopay,
grabpay,
id,
ideal,
kakaopay,
kcp,
klarna,
laybuy,
linepay,
linkaja,
maybankqrpay,
multibanco,
multipago,
network-token,
oney_3x,
oney_4x,
oney_6x,
oney_10x,
oney_12x,
ovo,
oxxo,
payid,
paymaya,
paypal,
paypalpaylater,
payto,
venmo,
pix,
rabbitlinepay,
razorpay,
scalapay,
sepa,
shopeepay,
singteldash,
smartpay,
sofort,
spei,
stripedd,
thaiqr,
touchngo,
truemoney,
trustly,
trustlyeurope,
vipps,
waave,
wechat,
zippay
fields
object[]

A list of fields that need to be submitted when activating the payment. service.

supported_currencies
string[]

A list of three-letter ISO currency codes that this service supports.

supported_countries
string[]

A list of two-letter ISO country codes that this service supports.

mode
enum<string>

The mode of this payment service.

Available options:
card,
redirect,
applepay,
googlepay,
click-to-pay,
checkout-session
supported_features
object

Features supported by the payment definition.

icon_url
string | null

An icon to display for the payment service.

configuration
object

Configuration items for the payment service.