List Payment Provider Manifest

Exposes provider manifest, a range of metadata settings, like payment methods, split configuration and custom fields.

Response body


Name Type Mandatory Description
paymentMethods object Yes Describes each payment method supported by payment provider and exposed its respective metadata.
name string Yes Payment method name.
allowsSplit string Yes Describes which transaction flow stage the connector should receive payment split data . Accepted values: onAuthorize, onCapture, disabled. Check more details on the Split Payouts on the Payment Provider Protocol article.
customFields object Yes Describes the customized fields supported by the connector.
name string Yes Custom field name.
type string Yes Custom field type. Accepted values: text, select.
options string In case of select type, the possible params are text and value.
          ↳text object Custom field description.
          ↳value string Custom field value.
autoSettleDelay number Describes the allowed delay value for the auto settle capture. Accepted values: minimum and maximum in whole hours (decimals are not allowed). Check more details on the Custom Auto Capture Feature article.
minimum string Yes Minimum amount of time to auto settle in hours.
maximum string Yes Maximum amount of time to auto settle in hours.

Available payment methods


Payment Method Type Country
Visa Credit Card Global
Mastercard Credit Card Global
American Express Credit Card Global
Discover Credit Card Global
JCB Credit Card Global
Diners Credit Card Global
Elo Credit Card Brazil
Hipercard Credit Card Brazil
Aura Credit Card Brazil
Banricompras Credit Card Brazil
Credz Credit Card Brazil
VirtualDebitElo Debit Card Brazil
Cabal Credit Card Argentina, Brazil, Uruguay, Paraguay
Visa Electron Debit Card Global
Maestro Debit Card Global
Mastercard Debit Debit Card Global
Cobranded Card Global
Privatelabels Card Global
Promissories Generic Global
Cash Generic Global
BankInvoice Offline/Voucher Brazil (Boleto Bancário)
Pix Online Transfer Brazil
SPEI Online Transfer Mexico
Safetypay Online Transfer Americas and Europe
Bitcoin Cryptocurrency Global

Request examples and their responses

curl --request GET \
  --url https://{{providerapiendpoint}}/manifest \
  --header 'accept: application/json'
{
    "paymentMethods": [
        {
            "name": "Visa",
            "allowsSplit": "onCapture"
        },
        { 
            "name": "Pix",
            "allowsSplit": "disabled"
        },
        {
            "name": "Mastercard",
            "allowsSplit": "onCapture"
        },
        {
            "name": "American Express",
            "allowsSplit": "onCapture"
        },
        {
            "name": "BankInvoice",
            "allowsSplit": "onAuthorize"
        },
        {
            "name": "Privatelabels",
            "allowsSplit": "disabled"
        },
        {
            "name": "Promissories",
            "allowsSplit": "disabled"
        }
    ],
    "customFields": [
        {
            "name": "Merchant's custom field",
            "type": "text"
        },
        {
            "name": "Merchant's custom select field",
            "type": "select",
            "options": [
                {
                    "text": "Field option 1",
                    "value": "1",
                },
                {
                    "text": "Field option 2",
                    "value": "2",
                },
                {
                    "text": "Field option 3",
                    "value": "3",
                }
            ]
        }
    ]
    "autoSettleDelay": {
            "minimum": "0",
            "maximum": "720"
  }
}
Language
Authentication
URL
Click Try It! to start a request and see the response here!