GET
/
payment-service-definitions
/
{payment_service_definition_id}
C#
using Gr4vy;
using Gr4vy.Models.Components;

var sdk = new Gr4vySDK(
    id: "example",
    server: SDKConfig.Server.Sandbox,
    bearerAuthSource: Auth.WithToken(privateKey),
    merchantAccountId: "default"
);

var res = await sdk.PaymentServiceDefinitions.GetAsync(paymentServiceDefinitionId: "adyen-ideal");

// handle response
{
  "id": "adyen-ideal",
  "type": "payment-service-definition",
  "display_name": "iDEAL",
  "method": "ideal",
  "fields": [
    {
      "key": "private_api_key",
      "display_name": "Private API key",
      "required": true,
      "format": "text",
      "secret": true
    }
  ],
  "reporting_fields": [
    {
      "key": "private_api_key",
      "display_name": "Private API key",
      "required": true,
      "format": "text",
      "secret": true
    }
  ],
  "supported_currencies": [
    "USD",
    "GBP",
    "EUR",
    "AUD"
  ],
  "supported_countries": "US",
  "mode": "card",
  "icon_url": "https://example.com/icons/adyen-ideal.svg",
  "supported_features": {},
  "required_checkout_fields": [
    {
      "required_fields": [
        "address.line1",
        "address.country",
        "address.city",
        "address.postal_code"
      ],
      "conditions": {
        "country": [
          "IN"
        ]
      }
    }
  ],
  "configuration": {
    "approval_ui_target": "any",
    "approval_ui_height": "100px",
    "approval_ui_width": "100px",
    "cart_items_limit": 100,
    "cart_items_required": true,
    "cart_items_should_match_amount": true
  }
}
This endpoint requires the payment-service-definitions.read scope.

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
payment_service_definition_id
string
required
Examples:

"adyen-ideal"

Response

Successful Response

​
id
string
required

The definition ID of the payment service that can be configured. This is the underlying provider followed by a dash followed by the method.

Required string length: 1 - 50
Examples:

"adyen-ideal"

"stripe-card"

​
display_name
string
required

A human friendly name for this service.

Required string length: 1 - 200
Examples:

"iDEAL"

"Stripe"

​
method
enum<string>
required

The method of the service

Available options:
abitab,
affirm,
afterpay,
alipay,
alipayhk,
applepay,
arcuspaynetwork,
bacs,
bancontact,
banked,
bcp,
becs,
bitpay,
blik,
boleto,
boost,
card,
cashapp,
chaseorbital,
clearpay,
click-to-pay,
dana,
dcb,
dlocal,
ebanx,
efecty,
eps,
everydaypay,
gcash,
gem,
gemds,
gift-card,
giropay,
givingblock,
gocardless,
googlepay,
googlepay_pan_only,
gopay,
grabpay,
ideal,
kakaopay,
kcp,
khipu,
klarna,
latitude,
latitudeds,
laybuy,
linepay,
linkaja,
maybankqrpay,
mercadopago,
multibanco,
multipago,
nequi,
netbanking,
network-token,
nupay,
oney_10x,
oney_12x,
oney_3x,
oney_4x,
oney_6x,
ovo,
oxxo,
p24,
pagoefectivo,
payid,
paymaya,
paypal,
paypalpaylater,
payto,
payvalida,
picpay,
pix,
pse,
rabbitlinepay,
razorpay,
rapipago,
redpagos,
scalapay,
sepa,
servipag,
shopeepay,
singteldash,
smartpay,
sofort,
spei,
stitch,
stripedd,
stripetoken,
tapi,
tapifintechs,
thaiqr,
touchngo,
truemoney,
trustly,
trustlyeurope,
upi,
venmo,
vipps,
waave,
webpay,
wechat,
yape,
zippay
Examples:

"ideal"

"card"

​
fields
DefinitionField · object[]
required

A list of credentials and related fields which can be configured for this service.

​
reporting_fields
DefinitionField · object[]
required

A list of reporting fields which can be configured for this service.

​
supported_currencies
string[]
required

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

Examples:
["USD", "GBP", "EUR", "AUD"]
​
supported_countries
string[]
required

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

Examples:

"US"

"GB"

"DE"

"AUD"

​
mode
enum<string>
required

The mode that defines the flow this payment service uses to process a payment.

Available options:
card,
redirect,
applepay,
googlepay,
checkout-session,
click-to-pay,
gift-card
Examples:

"card"

"redirect"

​
supported_features
object
required

Features supported by the payment service.

​
required_checkout_fields
RequiredCheckoutFields · object[]
required

A list of condition that define when some fields must be provided with a transaction request.

​
configuration
object
required

Additional configuration on how to present the approval UI.

​
type
string
default:payment-service-definition

Always payment-service-definition.

Allowed value: "payment-service-definition"
Examples:

"payment-service-definition"

​
icon_url
string | null

An icon to display for the payment service.

Examples:

"https://example.com/icons/adyen-ideal.svg"