Retrieve a specified payment gateway metadata

Retrieve a specified payment gateway metadata.

Request
path Parameters
apiName
required
string (PaymentGatewayName) ^[\w\. -]+$

Payment gateway metadata API name.

Responses
200

Payment gateway metadata received.

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

Name of the payment gateway returned in our API response.

logo
required
string <uri>

URL for the logo of the gateway.

paymentMethods
required
Array of strings (PaymentMethodApiName) non-empty

Array of the payment methods supported (for example, payment-card, bitcoin).

required
Unrestricted (object) or Subset (object) (CountriesMetadata)
One of:
mode
required
string

Specifies how the countries are compared.

Enum: "unknown" "all" "subset"
required
Unrestricted (object) or Subset (object) (CurrenciesMetadata)
One of:
mode
required
string

Specifies how the currencies are compared.

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

List of former names. From time to time gateways change their names or they also known by other names. Tracking this list may help customer support and developers.

Array
name
required
string

Alternative or former name of the 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 gateway. (Markdown is supported).

homepage
string <uri>

URL of their home page.

Array of objects

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

Array
url
required
string <uri>

URL for the target documentation. Value MUST be in the format of a URL.

description
string

Short description of the target documentation.

publishedPricing
string

If they have published pricing, a description of it here.

setupInstructions
string

Some special instructions for merchant to setup account for this gateway. 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 the card-brands supported, if payment-card is a value of paymentMethods.

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

Array of the operations supported by gateway.

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

Array of the 3DS-servers supported.

supportedPaymentInstrumentSetupInstructions
Array of strings

Array of the setup instructions supported by the gateway.

Items Enum: Description
authorize

Creates an authorize transaction in the amount/currency of the request. If the gateway account is configured for strong customer authentication, it is used.

authorize-and-void

Creates an authorize transaction in the amount/currency of the request, followed by a void (if the authorize was approved). If the gateway account is configured for strong customer authentication, it is used.

sca

Uses strong customer authentication (SCA) without any authorize transaction. SCA includes 3dsv2, 3ds, and some specific wallets behavior like setting up a billing agreement with PayPal.

do-nothing

Does nothing, and returns an approved setup transaction. This is the default behavior.

reconciliationSupport
boolean
Default: false

Specifies if we can reconcile transactions.

disputeSupport
boolean
Default: false

Specifies if we can automate dispute data (chargeback, retrieval or TC-40 disputes) entry with an API or SFTP access.

offsite
boolean
Default: false

Specifies if it may require offsite interaction (such as 3DS, PayPal login, or completing something in a store).

object

Describes the IPN that a gateway supports. No value means IPN is not supported.

type
required
string

Type of supported IPN. No value means IPN is not supported.

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

Method that is used to verify that we can trust the data in the IPN call.

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

Recommended TTL before abandoning the transaction.

Array of objects (Self) non-empty

Related resource links.

Array (non-empty)
href
required
string

Link URL.

rel
required
string

Type of link.

Value: "self"
get/payment-gateways-metadata/{apiName}
Request samples
Response samples
application/json
{
  • "apiName": "string",
  • "otherNames": [],
  • "summary": "string",
  • "homepage": "http://example.com",
  • "externalDocs": [],
  • "publishedPricing": "string",
  • "setupInstructions": "string",
  • "paymentMethods": [
    ],
  • "cardBrands": [
    ],
  • "merchantCountries": {
    },
  • "currencies": {
    },
  • "operations": [
    ],
  • "supported3dsServers": [
    ],
  • "supportedPaymentInstrumentSetupInstructions": [
    ],
  • "reconciliationSupport": false,
  • "disputeSupport": false,
  • "offsite": false,
  • "ipn": {
    },
  • "recommendedWaitingApprovalTtl": 3600,
  • "_links": [
    ]
}