Returns a list of all available payment service definitions.
GET
/
payment-service-definitions
This API is different from the list connection definitions because
it only returns definitions for payment services and not anti-fraud and gift card services.
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.
Query Parameters
limit
integer
default: 20
Defines the maximum number of items to return for this request.
cursor
string
A cursor that identifies the page of results to return. This is used to
paginate the results of this API.
For the first page of results, this parameter can be left out.
For additional pages, use the value returned by the API in
the next_cursor field. Similarly the previous_cursor can be used to
reverse backwards in the list.
Response
200 - application/json
items
object[]
items.id
string
The ID of the payment service. This is the underlying provider followed by a dash followed by the payment method ID.
items.type
enum<string>
default: payment-service-definition
payment-service-definition.
Available options:
payment-service-definition
items.display_name
string
The display name of this service.
items.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,
gopay,
grabpay,
ideal,
kakaopay,
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,
stripedd,
thaiqr,
touchngo,
truemoney,
trustly,
trustlyeurope,
vipps,
waave,
wechat,
zippay
items.fields
object[]
A list of fields that need to be submitted when activating the payment. service.
items.fields.key
string
The key of a field that needs to be submitted.
items.fields.display_name
string
The name to display for a field in the dashboard.
items.fields.required
boolean
Defines if this field is required when the service is created.
items.fields.format
enum<string>
Defines the type of input that needs to be rendered for this field.
Available options:
text,
multiline,
number
items.fields.secret
boolean
Defines if this field is secret. When true the field is not
returned when querying the payment service.
items.supported_currencies
string[]
A list of three-letter ISO currency codes that this service supports.
items.supported_countries
string[]
A list of two-letter ISO country codes that this service supports.