GET
/
payment-service-definitions
curl --request GET \
  --url https://api.{gr4vy_id}.gr4vy.app/payment-service-definitions \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "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"
      }
    }
  ],
  "limit": 1,
  "next_cursor": "ZXhhbXBsZTE",
  "previous_cursor": null
}

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

​
limit
integer
default:20

Defines the maximum number of items to return for this request.

Required range: 1 <= x <= 100
Example:

1

​
cursor
string

A cursor that identifies the page of results to return. This is used to paginate the results of this API.

For the first page of results, this parameter can be left out. For additional pages, use the value returned by the API in the next_cursor field. Similarly the previous_cursor can be used to reverse backwards in the list.

Example:

"ZXhhbXBsZTE"

Response

200
application/json
Returns a list of payment service definitions.

A list of available payment services definitions.