GET
/
payment-services
curl --request GET \
  --url https://api.{gr4vy_id}.gr4vy.app/payment-services \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "type": "payment-service",
      "id": "faaad066-30b4-4997-a438-242b0752d7e1",
      "accepted_countries": [
        "DE"
      ],
      "accepted_currencies": [
        "EUR"
      ],
      "active": true,
      "created_at": "2012-12-12T10:53:43+00:00",
      "display_name": "Stripe (Main)",
      "fields": [
        {
          "key": "secret_key",
          "value": "sk_test_26PHem9AhJZvU623DfE1x4sd"
        }
      ],
      "reporting_fields": [
        {
          "key": "ssh_username",
          "value": "test_ssh_username"
        }
      ],
      "merchant_account_id": "default",
      "merchant_profile": {
        "amex": {
          "merchant_acquirer_bin": "<string>",
          "merchant_url": "<string>",
          "merchant_acquirer_id": "<string>",
          "merchant_name": "<string>",
          "merchant_country_code": "<string>",
          "merchant_category_code": "<string>",
          "created_at": "2023-07-26T19:23:00.000+00:00"
        },
        "dankort": {
          "merchant_acquirer_bin": "<string>",
          "merchant_url": "<string>",
          "merchant_acquirer_id": "<string>",
          "merchant_name": "<string>",
          "merchant_country_code": "<string>",
          "merchant_category_code": "<string>",
          "created_at": "2023-07-26T19:23:00.000+00:00"
        },
        "discover": {
          "merchant_acquirer_bin": "<string>",
          "merchant_url": "<string>",
          "merchant_acquirer_id": "<string>",
          "merchant_name": "<string>",
          "merchant_country_code": "<string>",
          "merchant_category_code": "<string>",
          "created_at": "2023-07-26T19:23:00.000+00:00"
        },
        "jcb": {
          "merchant_acquirer_bin": "<string>",
          "merchant_url": "<string>",
          "merchant_acquirer_id": "<string>",
          "merchant_name": "<string>",
          "merchant_country_code": "<string>",
          "merchant_category_code": "<string>",
          "created_at": "2023-07-26T19:23:00.000+00:00"
        },
        "mastercard": {
          "merchant_acquirer_bin": "<string>",
          "merchant_url": "<string>",
          "merchant_acquirer_id": "<string>",
          "merchant_name": "<string>",
          "merchant_country_code": "<string>",
          "merchant_category_code": "<string>",
          "created_at": "2023-07-26T19:23:00.000+00:00"
        },
        "unionpay": {
          "merchant_acquirer_bin": "<string>",
          "merchant_url": "<string>",
          "merchant_acquirer_id": "<string>",
          "merchant_name": "<string>",
          "merchant_country_code": "<string>",
          "merchant_category_code": "<string>",
          "created_at": "2023-07-26T19:23:00.000+00:00"
        },
        "visa": {
          "merchant_acquirer_bin": "<string>",
          "merchant_url": "<string>",
          "merchant_acquirer_id": "<string>",
          "merchant_name": "<string>",
          "merchant_country_code": "<string>",
          "merchant_category_code": "<string>",
          "created_at": "2023-07-26T19:23:00.000+00:00"
        }
      },
      "method": "card",
      "network_tokens_enabled": true,
      "open_loop": true,
      "payment_method_tokenization_enabled": true,
      "payment_service_definition_id": "stripe-card",
      "settlement_reporting_enabled": true,
      "status": "pending",
      "three_d_secure_enabled": true,
      "updated_at": "2012-12-12T10:53:43+00:00",
      "webhook_url": "https://api.example.app.gr4vy.com/i/ViYUjDkUSoiQ0ColeigGwnN0..."
    }
  ],
  "limit": 1,
  "next_cursor": "ZXhhbXBsZTE",
  "previous_cursor": null
}

This API is different from the list connections because it only returns payment services and not anti-fraud and gift card services.

This endpoint requires the payment-services.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"

​
method
enum<string>

Filters the results to only the items for which the method has been set to this value. For example card.

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,
gift-card,
giropay,
givingblock,
gocardless,
googlepay,
googlepay_pan_only,
gopay,
grabpay,
id,
ideal,
kakaopay,
kcp,
klarna,
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"

​
deleted
boolean
default:false

Filters the results to only show items which have been deleted. By default, deleted items will not be returned.

Example:

true

Response

200
application/json
Returns a list of payment services.

A list of active, configured payment services.

​
items
object[]

An active, configured payment service.

​
limit
integer
default:20

The limit applied to request. This represents the number of items that are at maximum returned by this request.

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

1

​
next_cursor
string | null

The cursor that represents the next page of results. Use the cursor query parameter to fetch this page of items.

Required string length: 1 - 1000
Example:

"ZXhhbXBsZTE"

​
previous_cursor
string | null

The cursor that represents the next page of results. Use the cursor query parameter to fetch this page of items.

Required string length: 1 - 1000
Example:

null

Was this page helpful?

Suggest edits
Get service definitionNew payment service