curl --request GET \
--url https://api.{gr4vy_id}.gr4vy.app/connections \
--header 'Authorization: Bearer <token>'
{
"items": [
{
"id": "7b5e02bd-fa53-4ef0-b11e-1609d0f48cc5",
"type": "connection",
"name": "My Connection",
"active": true,
"definition": {
"id": "stripe-card",
"type": "connection-definition",
"name": "Stripe",
"count": 1,
"group": "payment-service",
"category": "card",
"icon_url": "https://cdn.gr4vy.app/stripe.svg",
"provider": "Stripe"
}
}
]
}
This API is different from the list payment services endpoint because
it returns all service types including anti-fraud and gift card services.
This endpoint requires the connections.read
scope.
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Returns a list of connections.
A list of configured connections.
The ID of the connection.
The name of this connection.
Whether this connection is currently in use. Connections can
be deactivated to allow for them to be kept around and
re-activated at a later date.
A connection that can be configured.
The ID of the connection.
items.definition.type
default:connection-definition
The name of this connection.
The number of configured connections.
Available options:
anti-fraud-service
,
digital-wallet
,
gift-card-service
,
payment-service
items.definition.category
Available options:
anti-fraud
,
bank
,
bnpl
,
card
,
cash
,
stored-credit
,
wallet
items.definition.icon_url
An icon to display for the connection.
items.definition.provider
The provider for this connection.