Retrieve payment gateway metadata

Retrieves payment gateway metadata.

Responses
200

Payment gateway metadata received.

Response Schema: application/json
Array
apiName
required
string (PaymentGatewayName) ^[\w\. -]+$

Name of the payment gateway returned in the API response.

logo
required
string <uri>

URL for the logo of the gateway.

paymentMethods
required
Array of strings (PaymentMethodApiName) non-empty

Array of supported payment methods. For example, payment-card and bitcoin.

required
Unrestricted (object) or Subset (object) (CountriesMetadata)

Countries metadata.

One of:

Countries metadata.

mode
required
string

Specifies how the countries are compared.

Enum: "unknown" "all" "subset"
required
Unrestricted (object) or Subset (object) (CurrenciesMetadata)

Currencies metadata.

One of:

Currencies metadata.

mode
required
string

Specifies how the currencies are compared.

Enum: "unknown" "all" "subset"
Array of objects

List of former names associated with the payment gateway. Gateways may change their names or may also be known by other names. Tracking this list may help customer support and developers.

Array
name
required
string

Alternative or former name of the payment gateway.

description
string

Short description about this name.

logo
string <uri>

URL for the logo used with this name.

summary
string

Short description of the payment gateway. This field supports Markdown.

homepage
string <uri>

URL of the payment gateway home page.

Array of objects

List of links to the documentation of the payment gateway. For example, online API guides provided by gateways or a link to the documents in Google Drive.

Array
url
required
string <uri>

URL of the target documentation. This value must be in URL format.

description
string

Short description of the target documentation.

publishedPricing
string

Pricing description for the payment gateway, if pricing is published.

setupInstructions
string

Special gateway account set up instructions for merchants. For example: After adding this gateway account, set the IPN to //example.com/ipns/{gateway-name}/{organization-id} by contacting your account rep.

cardBrands
Array of strings (PaymentCardBrand)

Array of supported card-brands. If the payment gateway supports payment cards.

Items Enum: "Visa" "MasterCard" "American Express" "Discover" "Maestro" "Solo" "Electron" "JCB" "Voyager" "Diners Club" … 4 more
operations
Array of strings

Array of operations that are supported by the payment gateway.

Items Enum: "verify" "auth" "capture" "sale" "refund" "query" "credit" "3DS1" "3DS2" "checkCredentials"
supported3dsServers
Array of strings

Array of supported 3DS-servers.

supportedPaymentInstrumentSetupInstructions
Array of strings

Array of set up instructions that are supported by the payment gateway.

Items Enum: Description
authorize

Creates an authorize transaction in the amount or currency of the request. This is used when a gateway account is configured for Strong Customer Authentication (SCA).

authorize-and-void

Creates an authorize transaction in the amount and currency of the request, followed by a void, if the authorize is approved. This is used when a gateway account is configured for Strong Customer Authentication (SCA).

sca

Uses Strong Customer Authentication (SCA) without an authorize transaction. SCA includes 3DS, and specific wallet behavior, such as setting up a billing agreement with PayPal.

do-nothing

Does nothing except return an approved setup transaction. This is the default behavior.

reconciliationSupport
boolean
Default: false

Specifies whether transactions can be reconciled.

disputeSupport
boolean
Default: false

Specifies whether dispute data entry can be automated with an API or SFTP access. For example, chargeback, retrieval, or TC-40 disputes.

offsite
boolean
Default: false

Specifies whether offsite interaction is required. For example, 3DS, PayPal login, or completing something in a store.

object

Describes the Instant Payment Notification (IPN) that a payment gateway supports. If this value is null, IPN is not supported.

type
required
string

Type of supported Instant Payment Notification (IPN). If this value is null, IPN is not supported.

Enum: "static" "dynamic"
verificationMethod
string
Default: "query"

Method used to verify that the data in the IPN call can be trusted.

Enum: "query" "signature"
recommendedWaitingApprovalTtl
integer [ 299 .. 16777216 ]
Default: 3600

Recommended Time To Live (TTL) before abandoning the transaction.

Array of objects (SelfLink)

Related links.

Array
href
string

Link URL.

rel
string

Type of link.

Value: "self"
get/payment-gateways-metadata
Request samples
Response samples
application/json
[
  • {
    }
]