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.
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Defines the maximum number of items to return for this request.
Required range: 1 < x < 100
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.
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,
googlepay_pan_only,
gopay,
grabpay,
id,
ideal,
kakaopay,
kcp,
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,
spei,
stripedd,
thaiqr,
touchngo,
truemoney,
trustly,
trustlyeurope,
vipps,
waave,
wechat,
zippay
Filters the results to only show items which have been deleted.
By default, deleted items will not be returned.
A list of active, configured payment services.
The type of this resource.
Available options:
payment-service
The ID of this payment service.
Required string length: 1 - 200
A list of countries for which this service is enabled, in ISO two-letter
code format.
items. accepted_currencies
A list of currencies for which this service is enabled, in ISO 4217
three-letter code format.
Defines if this service is currently active or not.
The date and time when this service was created.
The custom name set for this service.
Required string length: 1 - 200
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.
Required string length: 1 - 50
Required string length: 1 - 5000
A list of fields, each containing a key-value pair for each field
configured for reporting for this payment service. Fields marked as
secret (see Payment Service Definition) are not returned.
items.reporting_fields. key
Required string length: 1 - 50
items.reporting_fields. value
Required string length: 1 - 5000
items. merchant_account_id
The unique ID for a merchant account.
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
Merchant profile for Amex.
items.merchant_profile.amex. merchant_acquirer_bin
Acquirer bin to use when calling 3DS through this scheme.
Maximum length: 11
items.merchant_profile.amex. merchant_url
URL to send when calling 3DS through this scheme.
items.merchant_profile.amex. merchant_acquirer_id
Merchant ID to use when calling 3DS through this scheme.
Maximum length: 35
items.merchant_profile.amex. merchant_name
Merchant name to use when calling 3DS through this scheme.
Maximum length: 40
items.merchant_profile.amex. merchant_country_code
Merchant country code to use when calling 3DS through this scheme.
Required string length: 3
items.merchant_profile.amex. merchant_category_code
Merchant category code to use when calling 3DS through this scheme.
Maximum length: 4
items.merchant_profile.amex. created_at
The date and time when this profile was created.
items.merchant_profile. dankort
Merchant profile for Dankort.
items.merchant_profile.dankort. merchant_acquirer_bin
Acquirer bin to use when calling 3DS through this scheme.
Maximum length: 11
items.merchant_profile.dankort. merchant_url
URL to send when calling 3DS through this scheme.
items.merchant_profile.dankort. merchant_acquirer_id
Merchant ID to use when calling 3DS through this scheme.
Maximum length: 35
items.merchant_profile.dankort. merchant_name
Merchant name to use when calling 3DS through this scheme.
Maximum length: 40
items.merchant_profile.dankort. merchant_country_code
Merchant country code to use when calling 3DS through this scheme.
Required string length: 3
items.merchant_profile.dankort. merchant_category_code
Merchant category code to use when calling 3DS through this scheme.
Maximum length: 4
items.merchant_profile.dankort. created_at
The date and time when this profile was created.
items.merchant_profile. discover
Merchant profile for Discover.
items.merchant_profile.discover. merchant_acquirer_bin
Acquirer bin to use when calling 3DS through this scheme.
Maximum length: 11
items.merchant_profile.discover. merchant_url
URL to send when calling 3DS through this scheme.
items.merchant_profile.discover. merchant_acquirer_id
Merchant ID to use when calling 3DS through this scheme.
Maximum length: 35
items.merchant_profile.discover. merchant_name
Merchant name to use when calling 3DS through this scheme.
Maximum length: 40
items.merchant_profile.discover. merchant_country_code
Merchant country code to use when calling 3DS through this scheme.
Required string length: 3
items.merchant_profile.discover. merchant_category_code
Merchant category code to use when calling 3DS through this scheme.
Maximum length: 4
items.merchant_profile.discover. created_at
The date and time when this profile was created.
items.merchant_profile. jcb
Merchant profile for JCB.
items.merchant_profile.jcb. merchant_acquirer_bin
Acquirer bin to use when calling 3DS through this scheme.
Maximum length: 11
items.merchant_profile.jcb. merchant_url
URL to send when calling 3DS through this scheme.
items.merchant_profile.jcb. merchant_acquirer_id
Merchant ID to use when calling 3DS through this scheme.
Maximum length: 35
items.merchant_profile.jcb. merchant_name
Merchant name to use when calling 3DS through this scheme.
Maximum length: 40
items.merchant_profile.jcb. merchant_country_code
Merchant country code to use when calling 3DS through this scheme.
Required string length: 3
items.merchant_profile.jcb. merchant_category_code
Merchant category code to use when calling 3DS through this scheme.
Maximum length: 4
items.merchant_profile.jcb. created_at
The date and time when this profile was created.
items.merchant_profile. mastercard
Merchant profile for Mastercard.
items.merchant_profile.mastercard. merchant_acquirer_bin
Acquirer bin to use when calling 3DS through this scheme.
Maximum length: 11
items.merchant_profile.mastercard. merchant_url
URL to send when calling 3DS through this scheme.
items.merchant_profile.mastercard. merchant_acquirer_id
Merchant ID to use when calling 3DS through this scheme.
Maximum length: 35
items.merchant_profile.mastercard. merchant_name
Merchant name to use when calling 3DS through this scheme.
Maximum length: 40
items.merchant_profile.mastercard. merchant_country_code
Merchant country code to use when calling 3DS through this scheme.
Required string length: 3
items.merchant_profile.mastercard. merchant_category_code
Merchant category code to use when calling 3DS through this scheme.
Maximum length: 4
items.merchant_profile.mastercard. created_at
The date and time when this profile was created.
items.merchant_profile. unionpay
Merchant profile for UnionPay.
items.merchant_profile.unionpay. merchant_acquirer_bin
Acquirer bin to use when calling 3DS through this scheme.
Maximum length: 11
items.merchant_profile.unionpay. merchant_url
URL to send when calling 3DS through this scheme.
items.merchant_profile.unionpay. merchant_acquirer_id
Merchant ID to use when calling 3DS through this scheme.
Maximum length: 35
items.merchant_profile.unionpay. merchant_name
Merchant name to use when calling 3DS through this scheme.
Maximum length: 40
items.merchant_profile.unionpay. merchant_country_code
Merchant country code to use when calling 3DS through this scheme.
Required string length: 3
items.merchant_profile.unionpay. merchant_category_code
Merchant category code to use when calling 3DS through this scheme.
Maximum length: 4
items.merchant_profile.unionpay. created_at
The date and time when this profile was created.
items.merchant_profile. visa
Merchant profile for Visa.
items.merchant_profile.visa. merchant_acquirer_bin
Acquirer bin to use when calling 3DS through this scheme.
Maximum length: 11
items.merchant_profile.visa. merchant_url
URL to send when calling 3DS through this scheme.
items.merchant_profile.visa. merchant_acquirer_id
Merchant ID to use when calling 3DS through this scheme.
Maximum length: 35
items.merchant_profile.visa. merchant_name
Merchant name to use when calling 3DS through this scheme.
Maximum length: 40
items.merchant_profile.visa. merchant_country_code
Merchant country code to use when calling 3DS through this scheme.
Required string length: 3
items.merchant_profile.visa. merchant_category_code
Merchant category code to use when calling 3DS through this scheme.
Maximum length: 4
items.merchant_profile.visa. created_at
The date and time when this profile was created.
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,
googlepay_pan_only,
gopay,
grabpay,
id,
ideal,
kakaopay,
kcp,
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,
spei,
stripedd,
thaiqr,
touchngo,
truemoney,
trustly,
trustlyeurope,
vipps,
waave,
wechat,
zippay
items. network_tokens_enabled
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.
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
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
The ID of the payment service definition used to create this service.
Required string length: 1 - 50
items. settlement_reporting_enabled
Defines if settlement reporting is enabled for the service.
This feature can only be enabled if the payment service
definition supports the settlement_reporting feature.
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
Defines if 3-D Secure is enabled for the service. This feature
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.
The date and time when this service was last updated.
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.
The limit applied to request. This represents the number of items that are at
maximum returned by this request.
Required range: 1 < x < 100
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
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
