GET
/
payment-service-definitions
using Gr4vy;
using Gr4vy.Models.Components;
using Gr4vy.Models.Requests;

var sdk = new Gr4vySDK(bearerAuth: "<YOUR_BEARER_TOKEN_HERE>");

ListPaymentServiceDefinitionsResponse? res = await sdk.PaymentServiceDefinitions.ListAsync(limit: 20);

while(res != null)
{
    // handle items

    res = await res.Next!();
}
{
  "items": [
    {
      "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
      }
    }
  ],
  "limit": 20,
  "next_cursor": "ZXhhbXBsZTE",
  "previous_cursor": "Xkjss7asS"
}

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
header
required

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

Query Parameters

​
cursor
string | null

A pointer to the page of results to return.

Examples:

"ZXhhbXBsZTE"

​
limit
integer
default:20

The maximum number of items that are at returned.

Required range: 1 <= x <= 100
Examples:

20

Response

200
application/json

Successful Response

The response is of type object.