List payment service definitions

using Gr4vy;
using Gr4vy.Models.Components;
using Gr4vy.Models.Requests;

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

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

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

    res = await res.Next!();
}

{
  "items": [
    {
      "id": "<string>",
      "display_name": "<string>",
      "method": "abitab",
      "fields": [
        {
          "key": "<string>",
          "display_name": "<string>",
          "required": true,
          "format": "text",
          "secret": true
        }
      ],
      "reporting_fields": [
        {
          "key": "<string>",
          "display_name": "<string>",
          "required": true,
          "format": "text",
          "secret": true
        }
      ],
      "supported_currencies": [
        "<string>"
      ],
      "supported_countries": [
        "<string>"
      ],
      "mode": "card",
      "supported_features": {},
      "required_checkout_fields": [
        {
          "required_fields": [
            "<string>"
          ],
          "conditions": {
            "country": [
              "IN"
            ]
          }
        }
      ],
      "configuration": {
        "approval_ui_target": "new_window",
        "approval_ui_height": "<string>",
        "approval_ui_width": "<string>",
        "cart_items_limit": 123,
        "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"
    }
  ],
  "limit": 20,
  "next_cursor": "ZXhhbXBsZTE",
  "previous_cursor": "Xkjss7asS"
}

GET

payment-service-definitions

using Gr4vy;
using Gr4vy.Models.Components;
using Gr4vy.Models.Requests;

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

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

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

    res = await res.Next!();
}

{
  "items": [
    {
      "id": "<string>",
      "display_name": "<string>",
      "method": "abitab",
      "fields": [
        {
          "key": "<string>",
          "display_name": "<string>",
          "required": true,
          "format": "text",
          "secret": true
        }
      ],
      "reporting_fields": [
        {
          "key": "<string>",
          "display_name": "<string>",
          "required": true,
          "format": "text",
          "secret": true
        }
      ],
      "supported_currencies": [
        "<string>"
      ],
      "supported_countries": [
        "<string>"
      ],
      "mode": "card",
      "supported_features": {},
      "required_checkout_fields": [
        {
          "required_fields": [
            "<string>"
          ],
          "conditions": {
            "country": [
              "IN"
            ]
          }
        }
      ],
      "configuration": {
        "approval_ui_target": "new_window",
        "approval_ui_height": "<string>",
        "approval_ui_width": "<string>",
        "cart_items_limit": 123,
        "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"
    }
  ],
  "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. A pointer to the page of results to return.

Example:

"ZXhhbXBsZTE"

limit

integer

default:20

The maximum number of items that are at returned. The maximum number of items that are at returned.

Required range: 1 <= x <= 100

Response

Successful Response

items

PaymentServiceDefinition · object[]

required

A list of items returned for this request.

Show child attributes

items.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

items.display_name

string

required

A human friendly name for this service.

Required string length: 1 - 200

items.method

enum<string>

required

The method of the service

Available options:

abitab,

affirm,

afterpay,

alipay,

alipayhk,

applepay,

arcuspaynetwork,

bacs,

bancontact,

bank,

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,

plaid,

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

items.fields

DefinitionField · object[]

required

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

Show child attributes

items.fields.key

string

required

The key of a field that can be submitted.

Required string length: 1 - 50

items.fields.display_name

string

required

The human readable name for this field.

Required string length: 1 - 200

items.fields.required

boolean

required

Defines if this field is required when the service is created.

items.fields.format

enum<string>

required

Defines the type of input that needs to be rendered for this field.

Available options:

text,

multiline,

number,

timezone,

boolean

items.fields.secret

boolean

required

Defines if this field is secret. When true the field's value is not returned when querying the payment service information.

items.reporting_fields

DefinitionField · object[]

required

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

Show child attributes

items.reporting_fields.key

string

required

The key of a field that can be submitted.

Required string length: 1 - 50

items.reporting_fields.display_name

string

required

The human readable name for this field.

Required string length: 1 - 200

items.reporting_fields.required

boolean

required

Defines if this field is required when the service is created.

items.reporting_fields.format

enum<string>

required

Defines the type of input that needs to be rendered for this field.

Available options:

text,

multiline,

number,

timezone,

boolean

items.reporting_fields.secret

boolean

required

Defines if this field is secret. When true the field's value is not returned when querying the payment service information.

items.supported_currencies

string[]

required

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

items.supported_countries

string[]

required

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

items.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,

bank

items.supported_features

Supported Features · object

required

Features supported by the payment service.

Show child attributes

items.supported_features.{key}

boolean

items.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

items.required_checkout_fields.required_fields

string[]

required

A list of transaction fields that are required to process a payment for this service.

items.required_checkout_fields.conditions

Conditions · object

The conditions under which these fields are required

Example:

{ "country": ["IN"] }

items.configuration

PaymentServiceConfiguration · object

required

Additional configuration on how to present the approval UI.

Show child attributes

items.configuration.approval_ui_target

enum<string>

required

The browser target that an approval URL must be opened in. If any or null, then there is no specific requirement.

Available options:

new_window,

any

items.configuration.approval_ui_height

string

required

Height of the approval interface in either pixels or view height (vh).

items.configuration.approval_ui_width

string

required

Width of the approval interface in either pixels or view width (vw).

items.configuration.cart_items_limit

integer

required

The maximum number of cart items supported by this connector before we will truncate the list.

items.configuration.cart_items_required

boolean

required

Defines if cart items are required by this connector.

items.configuration.cart_items_should_match_amount

boolean

required

Defines if the cart items sum value should match the transaction amount.

items.supported_integration_clients

enum<string>[] | null

required

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

Available options:

redirect,

web,

android,

ios

Example:

["redirect"]

items.type

string

default:payment-service-definition

Always payment-service-definition.

Allowed value: "payment-service-definition"

items.icon_url

string | null

An icon to display for the payment service.

Example:

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

limit

integer

default:20

The number of items for this page.

Required range: 1 <= x <= 100

next_cursor

string | null

The cursor pointing at the next page of items.

Required string length: 1 - 1000

Example:

"ZXhhbXBsZTE"

previous_cursor

string | null

The cursor pointing at the previous page of items.

Required string length: 1 - 1000

Example:

"Xkjss7asS"

⌘I

Introduction

Transactions

Buyers

Checkout Sessions

Payment links

Payment options

Payouts

Refunds

Sessions

Settlement records

Disputes

Instruments

Vault

Connections

Errors

Other

List payment service definitions

Authorizations

Query Parameters

Response