# Retrieve payment gateway metadata

Retrieves payment gateway metadata.

Endpoint: GET /payment-gateways-metadata
Version: latest
Security: , 

## Response 200 fields (application/json):

  - `apiName` (string, required)
    Name of the payment gateway returned in the API response.

  - `otherNames` (array)
    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.

  - `otherNames.name` (string, required)
    Alternative or former name of the payment gateway.

  - `otherNames.description` (string)
    Short description about this name.

  - `otherNames.logo` (string)
    URL for the logo used with this name.

  - `logo` (string, required)
    URL for the logo of the gateway.

  - `summary` (string,null)
    Short description of the payment gateway.
This field supports Markdown.

  - `homepage` (string,null)
    URL of the payment gateway home page.

  - `externalDocs` (array)
    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.

  - `externalDocs.url` (string, required)
    URL of the target documentation.
This value must be in URL format.

  - `externalDocs.description` (string)
    Short description of the target documentation.

  - `publishedPricing` (string,null)
    Pricing description for the payment gateway, if pricing is published.

  - `setupInstructions` (string,null)
    Special gateway account set up instructions for merchants.
For example: After adding this gateway account,
set the IPN to  by contacting your account rep.

  - `paymentMethods` (array, required)
    Array of supported payment methods. For example,  and .

  - `cardBrands` (array)
    Array of supported card-brands.
If the payment gateway supports payment cards.
    Enum: "Visa", "MasterCard", "American Express", "Discover", "Maestro", "Solo", "Electron", "JCB", "Voyager", "Diners Club", "Switch", "Laser", "China UnionPay", "AstroPay Card"

  - `merchantCountries` (object, required)
    Countries metadata.

  - `currencies` (object, required)
    Currencies metadata.

  - `operations` (array)
    Array of operations that are supported by the payment gateway.
    Enum: "verify", "auth", "capture", "sale", "refund", "query", "credit", "3DS1", "3DS2", "checkCredentials"

  - `supported3dsServers` (array)
    Array of supported 3DS-servers.

  - `supportedPaymentInstrumentSetupInstructions` (array)
    Array of set up instructions that are supported by the payment gateway.
    Enum: "do-nothing", "authorize", "authorize-and-void", "sca"

  - `reconciliationSupport` (boolean)
    Specifies whether transactions can be reconciled.

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

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

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

  - `ipn.type` (string, required)
    Type of supported Instant Payment Notification (IPN).
If this value is null, IPN is not supported.
    Enum: "static", "dynamic"

  - `ipn.verificationMethod` (string)
    Method used to verify that the data in the IPN call can be trusted.
    Enum: "query", "signature"

  - `recommendedWaitingApprovalTtl` (integer)
    Recommended Time To Live (TTL) before abandoning the transaction.

  - `credentials` (object)
    List of credentials that are required to use the payment gateway.

  - `credentials.required` (array)
    List of required credentials.

  - `_links` (array)
    Related links.

  - `_links.href` (string)
    Link URL.

  - `_links.rel` (string)
    Type of link.
    Enum: "self"