Payment service definitions
List payment service definitions
Account updater
Buyers - Payment methods
Payment methods
Payment methods - Payment service tokens
Payment methods - Network tokens
Buyers - Gift cards
Buyers - Shipping details
Card scheme definitions
Digital wallets - Setup
Digital wallets - Sessions
Transactions
Refunds
Payment options
Payment service definitions
Payment services
Audit logs
Checkout sessions
Merchant accounts
Payment service definitions
List payment service definitions
List the definitions of each payment service that can be configured.
GET
/
payment-service-definitions
curl --request GET \
--url https://api.{id}.gr4vy.app/payment-service-definitions \
--header 'Authorization: Bearer <token>'
{
"items": [
{
"id": "adyen-ideal",
"type": "payment-service-definition",
"display_name": "iDEAL",
"method": "ideal",
"fields": [
{
"key": "private_api_key",
"display_name": "Private API key",
"required": true,
"format": "text",
"secret": true
}
],
"reporting_fields": [
{
"key": "private_api_key",
"display_name": "Private API key",
"required": true,
"format": "text",
"secret": true
}
],
"supported_currencies": [
"USD",
"GBP",
"EUR",
"AUD"
],
"supported_countries": "US",
"mode": "card",
"icon_url": "https://example.com/icons/adyen-ideal.svg",
"supported_features": {},
"required_checkout_fields": [
{
"required_fields": [
"address.line1",
"address.country",
"address.city",
"address.postal_code"
],
"conditions": {
"country": [
"IN"
]
}
}
],
"configuration": {
"approval_ui_target": "any",
"approval_ui_height": "100px",
"approval_ui_width": "100px",
"cart_items_limit": 100,
"cart_items_required": true,
"cart_items_should_match_amount": true
}
}
],
"limit": 20,
"next_cursor": "ZXhhbXBsZTE",
"previous_cursor": "Xkjss7asS"
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Query Parameters
A pointer to the page of results to return.
Examples:
"ZXhhbXBsZTE"
The maximum number of items that are at returned.
Required range:
1 <= x <= 100
Examples:
20
Response
200
application/json
Successful Response
The response is of type object
.
Was this page helpful?
curl --request GET \
--url https://api.{id}.gr4vy.app/payment-service-definitions \
--header 'Authorization: Bearer <token>'
{
"items": [
{
"id": "adyen-ideal",
"type": "payment-service-definition",
"display_name": "iDEAL",
"method": "ideal",
"fields": [
{
"key": "private_api_key",
"display_name": "Private API key",
"required": true,
"format": "text",
"secret": true
}
],
"reporting_fields": [
{
"key": "private_api_key",
"display_name": "Private API key",
"required": true,
"format": "text",
"secret": true
}
],
"supported_currencies": [
"USD",
"GBP",
"EUR",
"AUD"
],
"supported_countries": "US",
"mode": "card",
"icon_url": "https://example.com/icons/adyen-ideal.svg",
"supported_features": {},
"required_checkout_fields": [
{
"required_fields": [
"address.line1",
"address.country",
"address.city",
"address.postal_code"
],
"conditions": {
"country": [
"IN"
]
}
}
],
"configuration": {
"approval_ui_target": "any",
"approval_ui_height": "100px",
"approval_ui_width": "100px",
"cart_items_limit": 100,
"cart_items_required": true,
"cart_items_should_match_amount": true
}
}
],
"limit": 20,
"next_cursor": "ZXhhbXBsZTE",
"previous_cursor": "Xkjss7asS"
}