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.