Get a payment service definition

Get the definition of a payment service that can be configured.

GET /payment-service-definitions/{payment_service_definition_id}

C#

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

200

{
  "id": "adyen-ideal",
  "display_name": "iDEAL",
  "method": "ideal",
  "fields": [
    {
      "key": "private_api_key",
      "display_name": "Private API key",
      "required": true,
      "format": "text",
      "secret": true,
      "verifiable": true
    }
  ],
  "reporting_fields": [
    {
      "key": "private_api_key",
      "display_name": "Private API key",
      "required": true,
      "format": "text",
      "secret": true,
      "verifiable": true
    }
  ],
  "supported_currencies": [
    "USD",
    "GBP",
    "EUR",
    "AUD"
  ],
  "supported_countries": "US",
  "mode": "card",
  "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
  },
  "supported_integration_clients": [
    "redirect"
  ],
  "type": "payment-service-definition",
  "icon_url": "https://example.com/icons/adyen-ideal.svg"
}

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

Example:

"adyen-ideal"

Response

200

application/json

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 · string · required

The method of the service

Examples:

"ideal"

"card"

fields · DefinitionField · object[] · required

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

Show child attributes

reporting_fields · DefinitionField · object[] · required

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

Show child attributes

supported_currencies · string[] · required

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

Pattern: ^[A-Z]{3}$

Example:

["USD", "GBP", "EUR", "AUD"]

supported_countries · string[] · required

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

Pattern: ^[A-Z]{2}$

Examples:

"US"

"GB"

"DE"

"AUD"

mode · string · required

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

Examples:

"card"

"redirect"

supported_features · Supported Features · object · required

Features supported by the payment service.

Show child attributes

required_checkout_fields · RequiredCheckoutFields · object[] · required

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

Show child attributes

configuration · PaymentServiceConfiguration · object · required

Additional configuration on how to present the approval UI.

Show child attributes

supported_integration_clients · string[] | null · required

List of supported integration clients. Defaults to redirect for most redirect connectors.

Example:

["redirect"]

type · string · default: payment-service-definition

Always payment-service-definition.

Allowed value: "payment-service-definition"

Example:

"payment-service-definition"

icon_url · string | null

An icon to display for the payment service.

Example:

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