Get payment service definition
Gets the definition for a payment service.
This endpoint requires the payment-service-definitions.read scope.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The unique ID of the payment service definition.
Response
An available payment service that can be configured.
The ID of the payment service. This is the underlying provider followed by a dash followed by the payment method ID.
payment-service-definition.
payment-service-definition The display name of this service.
The ID of the payment method that this services handles.
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 A list of fields that need to be submitted when activating the payment. service.
A list of fields that need to be submitted when enabling the payment service settlement reporting.
A list of three-letter ISO currency codes that this service supports.
A list of two-letter ISO country codes that this service supports.
The mode of this payment service.
card, redirect, applepay, googlepay, click-to-pay, checkout-session Features supported by the payment definition.
An icon to display for the payment service.
Configuration items for the payment service.
Was this page helpful?