GET
/
payment-services
curl --request GET \
  --url https://api.{id}.gr4vy.app/payment-services \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "type": "payment-service",
      "id": "fffd152a-9532-4087-9a4f-de58754210f0",
      "merchant_account_id": "default",
      "payment_service_definition_id": "stripe-card",
      "active": true,
      "method": "card",
      "display_name": "Stripe",
      "position": 1,
      "status": "created",
      "accepted_currencies": [
        "USD",
        "EUR",
        "GBP"
      ],
      "accepted_countries": [
        "US",
        "DE",
        "GB"
      ],
      "payment_method_tokenization_enabled": true,
      "network_tokens_enabled": true,
      "open_loop": true,
      "settlement_reporting_enabled": true,
      "three_d_secure_enabled": true,
      "merchant_profile": {},
      "webhook_url": "<string>",
      "fields": [
        {
          "key": "api_key",
          "value": "key-12345"
        }
      ],
      "reporting_fields": [
        {
          "key": "api_key",
          "value": "key-12345"
        }
      ],
      "is_deleted": false,
      "created_at": "2013-07-16T19:23:00.000+00:00",
      "updated_at": "2013-07-16T19:23:00.000+00:00"
    }
  ],
  "limit": 20,
  "next_cursor": "ZXhhbXBsZTE",
  "previous_cursor": "Xkjss7asS"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
x-gr4vy-merchant-account-id
string

The ID of the merchant account to use for this request.

Examples:

"default"

Query Parameters

​
method
enum<string> | null

Return any payment service for this method.

Available options:
abitab,
affirm,
afterpay,
alipay,
alipayhk,
applepay,
arcuspaynetwork,
bacs,
bancontact,
banked,
bcp,
becs,
bitpay,
boleto,
boost,
card,
cashapp,
chaseorbital,
clearpay,
click-to-pay,
dana,
dcb,
dlocal,
ebanx,
efecty,
eps,
everydaypay,
gcash,
gem,
gemds,
gift-card,
giropay,
givingblock,
gocardless,
googlepay,
googlepay_pan_only,
gopay,
grabpay,
ideal,
kakaopay,
kcp,
khipu,
klarna,
latitude,
latitudeds,
laybuy,
linepay,
linkaja,
maybankqrpay,
mercadopago,
multibanco,
multipago,
nequi,
netbanking,
network-token,
nupay,
oney_10x,
oney_12x,
oney_3x,
oney_4x,
oney_6x,
ovo,
oxxo,
pagoefectivo,
payid,
paymaya,
paypal,
paypalpaylater,
payto,
payvalida,
picpay,
pix,
pse,
rabbitlinepay,
razorpay,
rapipago,
redpagos,
scalapay,
sepa,
servipag,
shopeepay,
singteldash,
smartpay,
sofort,
spei,
stitch,
stripedd,
thaiqr,
touchngo,
truemoney,
trustly,
trustlyeurope,
upi,
venmo,
vipps,
waave,
webpay,
wechat,
yape,
zippay
Examples:

"card"

​
cursor
string | null

A pointer to the page of results to return.

Examples:

"ZXhhbXBsZTE"

​
limit
integer
default:20

The maximum number of items that are at returned.

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

20

​
deleted
boolean | null
default:false

Return any deleted payment service.

Examples:

true

Response

200
application/json
Successful Response

The response is of type object.