GET
/
payment-service-definitions
/
{payment_service_definition_id}
curl --request GET \
  --url https://api.{gr4vy_id}.gr4vy.app/payment-service-definitions/{payment_service_definition_id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "stripe-card",
  "type": "payment-service-definition",
  "display_name": "Stripe",
  "method": "card",
  "fields": [
    {
      "key": "private_api_key",
      "display_name": "Private API key",
      "required": true,
      "format": "text",
      "secret": true
    }
  ],
  "reporting_fields": [
    {
      "key": "username",
      "display_name": "Reporting Username",
      "required": true,
      "format": "text",
      "secret": true
    }
  ],
  "supported_currencies": [
    "USD",
    "GBP",
    "EUR"
  ],
  "supported_countries": [
    "US",
    "GB",
    "DE"
  ],
  "mode": "card",
  "supported_features": {
    "delayed_capture": false,
    "digital_wallets": false,
    "network_tokens_default": true,
    "network_tokens_toggle": false,
    "open_loop": true,
    "open_loop_toggle": false,
    "partial_refunds": false,
    "payment_method_tokenization": true,
    "payment_method_tokenization_toggle": false,
    "refunds": true,
    "requires_webhook_setup": true,
    "three_d_secure_hosted": true,
    "three_d_secure_pass_through": false,
    "verify_credentials": false,
    "void": true
  },
  "icon_url": "https://cdn.gr4vy.app/stripe.svg",
  "configuration": {
    "approval_ui_height": "300px",
    "approval_ui_width": "300px",
    "approval_ui_target": "any"
  }
}

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

The unique ID of the payment service definition.

Example:

"stripe-card"

Response

200
application/json
Returns a payment service definition.

An available payment service that can be configured.

​
id
string

The ID of the payment service. This is the underlying provider followed by a dash followed by the payment method ID.

Example:

"stripe-card"

​
type
enum<string>
default:payment-service-definition

payment-service-definition.

Available options:
payment-service-definition
Example:

"payment-service-definition"

​
display_name
string

The display name of this service.

Example:

"Stripe"

​
method
enum<string>

The ID of the payment method that this services handles.

Available options:
afterpay,
alipay,
alipayhk,
applepay,
bacs,
bancontact,
banked,
becs,
bitpay,
boleto,
boost,
card,
cashapp,
chaseorbital,
checkout-session,
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,
id,
ideal,
kakaopay,
kcp,
klarna,
latitude,
latitudeds,
laybuy,
linepay,
linkaja,
maybankqrpay,
mercadopago,
multibanco,
multipago,
netbanking,
network-token,
oney_3x,
oney_4x,
oney_6x,
oney_10x,
oney_12x,
ovo,
oxxo,
payid,
paymaya,
paypal,
paypalpaylater,
payto,
venmo,
pix,
pse,
rabbitlinepay,
razorpay,
scalapay,
sepa,
shopeepay,
singteldash,
smartpay,
sofort,
spei,
stripedd,
thaiqr,
touchngo,
truemoney,
trustly,
trustlyeurope,
upi,
vipps,
waave,
webpay,
wechat,
zippay
Example:

"card"

​
fields
object[]

A list of fields that need to be submitted when activating the payment. service.

A single field that needs to be submitted for a payment service when it is created.

​
reporting_fields
object[]

A list of fields that need to be submitted when enabling the payment service settlement reporting.

A single field that needs to be submitted for a payment service when the settlement reporting is being enabled for it.

​
supported_currencies
string[]

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

Example:
["USD", "GBP", "EUR"]
​
supported_countries
string[]

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

Example:
["US", "GB", "DE"]
​
mode
enum<string>

The mode of this payment service.

Available options:
card,
redirect,
applepay,
googlepay,
click-to-pay,
checkout-session
Example:

"card"

​
supported_features
object

Features supported by the payment definition.

​
icon_url
string | null

An icon to display for the payment service.

Example:

"https://cdn.gr4vy.app/stripe.svg"

​
configuration
object

Configuration items for the payment service.

Was this page helpful?

List connection definitionsList payment services