/
Retrieve payment gateway...

Retrieve payment gateway metadata

Request

Retrieves metadata for a gateway with a specified ID.

Path
apiNamestring^[\w\. -]+$required

Payment gateway metadata API name.

curl -i -X GET \
  'https://www.rebilly.com/_mock/catalog/all/payment-gateways-metadata/{apiName}'

Responses

Payment gateway metadata received.

Bodyapplication/json
apiNamestring^[\w\. -]+$required

Name of the payment gateway returned in the API response.

otherNamesArray 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.

summarystring or null

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

homepagestring or null, (uri)

URL of the payment gateway home page.

externalDocsArray 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.

publishedPricingstring or null

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

setupInstructionsstring or null

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.

paymentMethodsArray of strings, non-emptyrequired

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

cardBrandsArray of strings

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

merchantCountriesobject(CountriesMetadata)required
currenciesobjectrequired
operationsArray of strings

Array of operations that are supported by the payment gateway.

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

Array of supported 3DS-servers.

supportedPaymentInstrumentSetupInstructionsArray of strings

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

Items Enum ValueDescription
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.

reconciliationSupportboolean

Specifies whether transactions can be reconciled.

Default:false
disputeSupportboolean

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

Default:false
offsiteboolean

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

Default:false
ipnobject or null

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

recommendedWaitingApprovalTtlinteger, [ 299 .. 16777216 ]

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

Default:3600
credentialsobject

List of credentials that are required to use the payment gateway.

Response
{
  "apiName": "string",
  "otherNames": [
    { … }
  ],
  "logo": "http://example.com",
  "summary": "string",
  "homepage": "http://example.com",
  "externalDocs": [
    { … }
  ],
  "publishedPricing": "string",
  "setupInstructions": "string",
  "paymentMethods": [
    "string"
  ],
  "cardBrands": [
    "Visa"
  ],
  "merchantCountries": {
    "mode": "unknown",
    "values": [ … ]
  },
  "currencies": {
    "mode": "unknown",
    "values": [ … ]
  },
  "operations": [
    "verify"
  ],
  "supported3dsServers": [
    "string"
  ],
  "supportedPaymentInstrumentSetupInstructions": [
    "do-nothing"
  ],
  "reconciliationSupport": false,
  "disputeSupport": false,
  "offsite": false,
  "ipn": {
    "type": "static",
    "verificationMethod": "query"
  },
  "recommendedWaitingApprovalTtl": 3600,
  "credentials": {
    "required": [ … ]
  },
  "_links": [
    { … }
  ]
}