Lists the currently configured and activated payment services.
GET
/
payment-services
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
headerrequired
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.
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.
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,
eps,
everydaypay,
gcash,
giropay,
givingblock,
gocardless,
googlepay,
gopay,
grabpay,
ideal,
kakaopay,
klarna,
laybuy,
linepay,
linkaja,
maybankqrpay,
multibanco,
multipago,
network-token,
oney_3x,
oney_4x,
oney_6x,
oney_10x,
oney_12x,
ovo,
oxxo,
payid,
paymaya,
paypal,
paypalpaylater,
payto,
venmo,
pix,
rabbitlinepay,
razorpay,
scalapay,
sepa,
shopeepay,
singteldash,
smartpay,
sofort,
stripedd,
thaiqr,
touchngo,
truemoney,
trustly,
trustlyeurope,
vipps,
waave,
wechat,
zippay
deleted
boolean
default: false
Filters the results to only show items which have been deleted.
By default, deleted items will not be returned.
Response
200 - application/json
items
object[]
items.type
enum<string>
The type of this resource.
Available options:
payment-service
items.id
string
The ID of this payment service.
items.accepted_countries
string[]
A list of countries for which this service is enabled, in ISO two-letter
code format.
items.accepted_currencies
string[]
A list of currencies for which this service is enabled, in ISO 4217
three-letter code format.
items.active
boolean
default: true
Defines if this service is currently active or not.
items.created_at
string
The date and time when this service was created.
items.display_name
string
The custom name set for this service.
items.fields
object[]
A list of fields, each containing a key-value pair for each field
configured for this payment service. Fields marked as secret
(see Payment Service Definition) are not returned.
items.fields.key
string
The key of the field.
items.fields.value
string
The value of the field.
items.merchant_account_id
string
The unique ID for a merchant account.
items.merchant_profile
object
An object containing a key for each supported card scheme (Amex,
Discover, Mastercard and Visa), and for each key an object with
the merchant profile for this service and the corresponding scheme.
items.merchant_profile.amex
object
Merchant profile for Amex.
items.merchant_profile.amex.merchant_acquirer_bin
string
Acquirer bin to use when calling 3DS through this scheme.
items.merchant_profile.amex.merchant_url
string
URL to send when calling 3DS through this scheme.
items.merchant_profile.amex.merchant_acquirer_id
string
Merchant ID to use when calling 3DS through this scheme.
items.merchant_profile.amex.merchant_name
string
Merchant name to use when calling 3DS through this scheme.
items.merchant_profile.amex.merchant_country_code
string
Merchant country code to use when calling 3DS through this scheme.
Merchant category code to use when calling 3DS through this scheme.
items.merchant_profile.visa.created_at
string
The date and time when this profile was created.
items.method
enum<string>
The payment method that this service handles.
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,
eps,
everydaypay,
gcash,
giropay,
givingblock,
gocardless,
googlepay,
gopay,
grabpay,
ideal,
kakaopay,
klarna,
laybuy,
linepay,
linkaja,
maybankqrpay,
multibanco,
multipago,
network-token,
oney_3x,
oney_4x,
oney_6x,
oney_10x,
oney_12x,
ovo,
oxxo,
payid,
paymaya,
paypal,
paypalpaylater,
payto,
venmo,
pix,
rabbitlinepay,
razorpay,
scalapay,
sepa,
shopeepay,
singteldash,
smartpay,
sofort,
stripedd,
thaiqr,
touchngo,
truemoney,
trustly,
trustlyeurope,
vipps,
waave,
wechat,
zippay
items.network_tokens_enabled
boolean
Defines if network tokens are enabled for the service. This feature
can only be enabled if the payment service is set as open_loop and
the PSP is set up to accept network tokens.
items.open_loop
boolean
Defines if the service works as an open-loop service. This feature
can only be enabled if the PSP is set up to accept previous scheme
transaction IDs.
items.payment_method_tokenization_enabled
boolean
default: false
Defines if tokenization is enabled for the service. This feature
can only be enabled if the payment service is NOT set as open_loop
and the PSP is set up to tokenize.
items.payment_service_definition_id
string
The ID of the payment service definition used to create this service.
items.status
enum<string>
The current status of this service. This will start off as pending, move
to created, and might eventually move to an error status if and when the
credentials are no longer valid.
Available options:
pending,
created,
failed
items.three_d_secure_enabled
boolean
default: false
Defines if 3-D Secure is enabled for the service (can only be
enabled if the payment service definition supports
the three_d_secure_hosted feature).
This does not affect pass through 3-D Secure data.
items.updated_at
string
The date and time when this service was last updated.
items.webhook_url
string | null
The URL that needs to be configured with this payment service as the
receiving endpoint for webhooks from the service to Gr4vy. Currently,
Gr4vy does not yet automatically register webhooks on setup, and
therefore webhooks need to be registered manually by the merchant.
limit
integer
default: 20
The limit applied to request. This represents the number of items that are at
maximum returned by this request.
next_cursor
string | null
The cursor that represents the next page of results. Use the cursor query
parameter to fetch this page of items.
previous_cursor
string | null
The cursor that represents the next page of results. Use the cursor query
parameter to fetch this page of items.