Skip to main content
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
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.Get(ctx, "adyen-ideal")
if err != nil {
log.Fatal(err)
}
if res != nil {
// handle response
}
}
package hello.world;

import com.gr4vy.sdk.Gr4vy;
import com.gr4vy.sdk.models.errors.*;
import com.gr4vy.sdk.models.operations.GetPaymentServiceDefinitionResponse;
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();

GetPaymentServiceDefinitionResponse res = sdk.paymentServiceDefinitions().get()
.paymentServiceDefinitionId("adyen-ideal")
.call();

if (res.paymentServiceDefinition().isPresent()) {
System.out.println(res.paymentServiceDefinition().get());
}
}
}
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();



$response = $sdk->paymentServiceDefinitions->get(
paymentServiceDefinitionId: 'adyen-ideal'
);

if ($response->paymentServiceDefinition !== null) {
// 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.get(payment_service_definition_id="adyen-ideal")

# Handle response
print(res)
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.get("adyen-ideal");

console.log(result);
}

run();
curl --request GET \
--url https://api.sandbox.{id}.gr4vy.app/payment-service-definitions/{payment_service_definition_id} \
--header 'Authorization: Bearer <token>'
{
  "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"
}
{
"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 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

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,
bank,
bcp,
becs,
bitpay,
blik,
ach,
boleto,
boost,
breb,
capitec,
card,
cashapp,
cashappafterpay,
chaseorbital,
clearpay,
click-to-pay,
custom_push,
custom_redirect,
custom_tokenize,
dana,
dcb,
dlocal,
ebanx,
eckoh,
efecty,
eps,
everydaypay,
gcash,
gem,
gemds,
gift-card,
giropay,
givingblock,
gocardless,
googlepay,
googlepay_pan_only,
gopay,
grabpay,
ideal,
interac,
kakaopay,
kcp,
khipu,
klarna,
konbini,
latitude,
latitudeds,
laybuy,
linepay,
linkaja,
maybankqrpay,
mercadopago,
multibanco,
multipago,
nequi,
netbanking,
network-token,
nupay,
oney_10x,
oney_12x,
oney_3x,
oney_4x,
oney_6x,
onlinebankingcz,
onelink,
ovo,
oxxo,
p24,
pagoefectivo,
paybybank,
payid,
paymaya,
paysquad,
paypal,
paypalpaylater,
paypay,
payto,
payvalida,
paze,
picpay,
pix,
plaid,
pse,
rabbitlinepay,
razorpay,
rapipago,
redpagos,
scalapay,
sepa,
servipag,
seveneleven,
shopeepay,
singteldash,
smartpay,
sofort,
spei,
stitch,
swish,
stripe,
stripedd,
stripetoken,
tapi,
tapifintechs,
thaiqr,
touchngo,
truemoney,
trustly,
trustlyeurope,
upi,
venmo,
vipps,
waave,
webpay,
wechat,
wero,
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.

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
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,
paze
Examples:

"card"

"redirect"

supported_features
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
PaymentServiceConfiguration · object
required

Additional configuration on how to present the approval UI.

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"]
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"