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.
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Defines the maximum number of items to return for this request.
Required range: 1 < x < 100
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.
A list of available payment services definitions.
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
The display name of this service.
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
A list of fields that need to be submitted when activating the payment. service.
The key of a field that needs to be submitted.
items.fields. display_name
The name to display for a field in the dashboard.
Defines if this field is required when the service is created.
Defines the type of input that needs to be rendered for this field.
Available options:
text,
multiline,
number
Defines if this field is secret. When true the field is not
returned when querying the payment service.
A list of fields that need to be submitted when enabling the payment service settlement reporting.
items.reporting_fields. key
The key of a field that needs to be submitted.
items.reporting_fields. display_name
The name to display for a field in the dashboard.
items.reporting_fields. required
Defines if this field is required when the reporting is being enabled.
items.reporting_fields. format
Defines the type of input that needs to be rendered for this field.
Available options:
text,
multiline,
number
items.reporting_fields. secret
Defines if this field is secret. When true the field is not
returned when querying the payment service.
items. supported_currencies
A list of three-letter ISO currency codes that this service supports.
items. supported_countries
A list of two-letter ISO country codes that this service supports.
The mode of this payment service.
Available options:
card,
redirect,
applepay,
googlepay,
click-to-pay,
checkout-session
Features supported by the payment definition.
items.supported_features. delayed_capture
items.supported_features. digital_wallets
Supports passing decrypted digital wallet (e.g. Apple Pay)
tokens to the underlying processor.
items.supported_features. network_tokens_default
Supports processing network tokens by default.
items.supported_features. network_tokens_toggle
Supports toggling processing of network tokens on or off.
items.supported_features. open_loop
Supports processing transactions with either raw PAN details or
network tokens.
items.supported_features. open_loop_toggle
Supports toggling processing as open-loop on or off.
items.supported_features. partial_refunds
items.supported_features. payment_method_tokenization
Supports storing a payment method via tokenization.
items.supported_features. payment_method_tokenization_toggle
Supports toggling tokenization for a payment method on or off
from the dashboard.
items.supported_features. refunds
items.supported_features. requires_webhook_setup
Requires merchant to set up webhook_url manually with provider.
items.supported_features. three_d_secure_hosted
Supports hosted 3-D Secure with a redirect.
items.supported_features. three_d_secure_pass_through
Supports passing 3-D Secure data to the underlying processor.
items.supported_features. verify_credentials
Supports verifying the credentials entered while setting up the
underlying processor. This is for internal use only.
items.supported_features. void
Supports voiding authorized
transactions.
An icon to display for the payment service.
Configuration items for the payment service.
items.configuration. approval_ui_height
Height of the approval interface in either pixels or view height (vh).
items.configuration. approval_ui_width
Width of the approval interface in either pixels or view width (vw).
items.configuration. approval_ui_target
The browser target that an approval URL must be opened in. If any or null, then there is no specific requirement.
Available options:
any,
new_window
The limit applied to request. This represents the number of items that are at
maximum returned by this request.
Required range: 1 < x < 100
The cursor that represents the next page of results. Use the cursor query
parameter to fetch this page of items.
Required string length: 1 - 1000
The cursor that represents the next page of results. Use the cursor query
parameter to fetch this page of items.
Required string length: 1 - 1000
