List payment service definitions

List the definitions of each payment service that can be configured.

GET /payment-service-definitions

C#

C#

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(
    cursor: "ZXhhbXBsZTE",
    limit: 20
);

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

    res = await res.Next!();
}

package main

import(
	"context"
	"os"
	gr4vygo "github.com/gr4vy/gr4vy-go"
	"log"
)

func main() {
    ctx := context.Background()

    s := gr4vy.New(
		gr4vy.WithID("example"),
		gr4vy.WithServer(gr4vy.ServerSandbox),
		gr4vy.WithSecuritySource(withToken),
		gr4vy.WithMerchantAccountID("default"),
	)

    res, err := s.PaymentServiceDefinitions.List(ctx, gr4vygo.Pointer("ZXhhbXBsZTE"), gr4vygo.Pointer[int64](20))
    if err != nil {
        log.Fatal(err)
    }
    if res != nil {
        for {
            // handle items

            res, err = res.Next()

            if err != nil {
                // handle error
            }

            if res == nil {
                break
            }
        }
    }
}

package hello.world;

import com.gr4vy.sdk.Gr4vy;
import com.gr4vy.sdk.models.errors.*;
import com.gr4vy.sdk.models.operations.ListPaymentServiceDefinitionsResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Exception {

        Gr4vy sdk = Gr4vy.builder()
                .id("example")
                .server(AvailableServers.SANDBOX)
                .merchantAccountId("default")
                .securitySource(new BearerSecuritySource.Builder(privateKey).build())
            .build();


        sdk.paymentServiceDefinitions().list()
                .cursor("ZXhhbXBsZTE")
                .limit(20L)
                .callAsStream()
                .forEach((ListPaymentServiceDefinitionsResponse item) -> {
                   // handle page
                });

    }
}

declare(strict_types=1);

require 'vendor/autoload.php';

use Gr4vy;

$sdk = Gr4vy\SDK::builder()
    ->setId('example')
    ->setServer('sandbox')
    ->setSecuritySource(Auth::withToken($privateKey))
    ->setMerchantAccountId('default')
    ->build();



$responses = $sdk->paymentServiceDefinitions->list(
    cursor: 'ZXhhbXBsZTE',
    limit: 20

);


foreach ($responses as $response) {
    if ($response->statusCode === 200) {
        // handle response
    }
}

from gr4vy import Gr4vy
import os


with Gr4vy(
    id="example",
    server="sandbox",
    merchant_account_id="default",
    bearer_auth=auth.with_token(open("./private_key.pem").read())
):

    res = g_client.payment_service_definitions.list(cursor="ZXhhbXBsZTE", limit=20)

    while res is not None:
        # Handle items

        res = res.next()

import { Gr4vy, withToken } from "@gr4vy/sdk";
import fs from "fs";

const gr4vy = new Gr4vy({
    id: "example",
    server: "sandbox",
    merchantAccountId: "default",
    bearerAuth: withToken({
      privateKey: fs.readFileSync("private_key.pem", "utf8"),
    }),
});

async function run() {
  const result = await gr4vy.paymentServiceDefinitions.list();

  for await (const page of result) {
    console.log(page);
  }
}

run();

curl --request GET \
  --url https://api.sandbox.{id}.gr4vy.app/payment-service-definitions \
  --header 'Authorization: Bearer <token>'

200

{
  "items": [
    {
      "id": "<string>",
      "display_name": "<string>",
      "fields": [
        {
          "key": "<string>",
          "display_name": "<string>",
          "required": true,
          "secret": true,
          "verifiable": true
        }
      ],
      "reporting_fields": [
        {
          "key": "<string>",
          "display_name": "<string>",
          "required": true,
          "secret": true,
          "verifiable": true
        }
      ],
      "supported_currencies": [
        "<string>"
      ],
      "supported_countries": [
        "<string>"
      ],
      "supported_features": {},
      "required_checkout_fields": [
        {
          "required_fields": [
            "<string>"
          ],
          "conditions": {
            "country": [
              "IN"
            ]
          }
        }
      ],
      "configuration": {
        "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"
}

{
  "type": "error",
  "code": "bad_request",
  "status": 400,
  "message": "Generic error",
  "details": []
}

{
  "type": "error",
  "code": "unauthorized",
  "status": 401,
  "message": "No valid API authentication found",
  "details": []
}

{
  "type": "error",
  "code": "forbidden",
  "status": 403,
  "message": "Generic error",
  "details": []
}

{
  "type": "error",
  "code": "not_found",
  "status": 404,
  "message": "The resource could not be found",
  "details": []
}

{
  "type": "error",
  "code": "method_not_allowed",
  "status": 405,
  "message": "Method Not Allowed",
  "details": []
}

{
  "type": "error",
  "code": "duplicate_record",
  "status": 409,
  "message": "Generic error",
  "details": [],
  "resource_id": "cdc70639-cb9c-4222-a73f-b8ce39f7821b"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

{
  "type": "error",
  "code": "too_early",
  "status": 425,
  "message": "Generic error",
  "details": []
}

{
  "type": "error",
  "code": "too_many_requests",
  "status": 429,
  "message": "Generic error",
  "details": []
}

{
  "type": "error",
  "code": "server_error",
  "status": 500,
  "message": "Request could not be processed",
  "details": []
}

{
  "type": "error",
  "code": "bad_gateway",
  "status": 502,
  "message": "Request could not be processed",
  "details": []
}

{
  "type": "error",
  "code": "gateway_timeout",
  "status": 504,
  "message": "Request could not be processed",
  "details": []
}

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.

Example:

"ZXhhbXBsZTE"

limit · integer · default: 20

The maximum number of items that are at returned.

Required range: 1 <= x <= 100

Example:

20

Response

200

application/json

Successful Response

items · PaymentServiceDefinition · object[] · required

A list of items returned for this request.

Show child attributes

limit · integer · default: 20

The number of items for this page.

Required range: 1 <= x <= 100

Example:

20

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"