Get Payment Methods

GET

https://third/v1/provider/paymentmethods

GET

/v1/provider/paymentmethods

curl -G https://third/v1/provider/paymentmethods \
     -H "x-api-key: {{X_API_KEY}}" \
     -H "Authorization: Bearer <token>" \
     -d currency=COP

200Get Payment Methods_example

{
  "methods": [
    {
      "id": 1,
      "name": "MobileWallet",
      "settlement": 600,
      "minSendAmount": {
        "currency": "USD",
        "amount": 2.5
      },
      "maxSendAmount": {
        "currency": "USD",
        "amount": 1000
      },
      "requirements": [
        {
          "id": "name",
          "path": "recipient.name",
          "type": "text",
          "validation": "^[a-zA-Z ]{1,50}$"
        },
        {
          "id": "documentType",
          "path": "recipient.documentType",
          "type": "option",
          "validation": "string",
          "options": [
            {
              "code": "CC",
              "name": "Cédula de Ciudadanía"
            },
            {
              "code": "NIT",
              "name": "Número de Identificación Tributaria"
            }
          ],
          "valueField": "code"
        },
        {
          "id": "documentNumber",
          "path": "recipient.documentNumber",
          "type": "text",
          "validation": "^[0-9]{5,10}$"
        },
        {
          "id": "phoneNumber",
          "path": "recipient.phoneNumber",
          "type": "text",
          "validation": "[0-9]{7,20}"
        },
        {
          "id": "quoteCurrency",
          "path": "quoteCurrency",
          "type": "option",
          "validation": "string",
          "options": [
            {
              "code": "COP",
              "name": "Peso colombiano"
            }
          ],
          "valueField": "code"
        },
        {
          "id": "mobileWalletName",
          "path": "recipient.mobileWallet.name",
          "type": "option",
          "validation": "string",
          "options": [
            {
              "code": "179",
              "name": "Daviplata"
            },
            {
              "code": "197",
              "name": "Nequi"
            }
          ],
          "valueField": "name"
        },
        {
          "id": "mobileWalletNumber",
          "path": "recipient.mobileWallet.number",
          "type": "text",
          "validation": "string"
        }
      ]
    },
    {
      "id": 2,
      "name": "BankAccount",
      "settlement": 600,
      "minSendAmount": {
        "currency": "USD",
        "amount": 2.5
      },
      "maxSendAmount": {
        "currency": "USD",
        "amount": 10
      },
      "requirements": [
        {
          "id": "name",
          "path": "recipient.name",
          "type": "text",
          "validation": "^[a-zA-Z ]{1,50}$"
        },
        {
          "id": "documentType",
          "path": "recipient.documentType",
          "type": "option",
          "validation": "string",
          "options": [
            {
              "code": "CC",
              "name": "Cédula de Ciudadanía"
            },
            {
              "code": "NIT",
              "name": "Número de Identificación Tributaria"
            }
          ],
          "valueField": "code"
        },
        {
          "id": "documentNumber",
          "path": "recipient.documentNumber",
          "type": "text",
          "validation": "^[0-9]{5,10}$"
        },
        {
          "id": "phoneNumber",
          "path": "recipient.phoneNumber",
          "type": "text",
          "validation": "string"
        },
        {
          "id": "quoteCurrency",
          "path": "quoteCurrency",
          "type": "option",
          "validation": "string",
          "options": [
            {
              "code": "COP",
              "name": "Peso colombiano"
            }
          ],
          "valueField": "code"
        },
        {
          "id": "bankCode",
          "path": "recipient.bank.code",
          "type": "option",
          "validation": "string",
          "options": [
            {
              "code": "177",
              "name": "Bancolombia"
            },
            {
              "code": "178",
              "name": "Banco de Bogota"
            },
            {
              "code": "180",
              "name": "Davivienda"
            },
            {
              "code": "181",
              "name": "BBVA"
            },
            {
              "code": "182",
              "name": "Banco de Occidente"
            },
            {
              "code": "183",
              "name": "Colpatria"
            },
            {
              "code": "184",
              "name": "Banco popular"
            },
            {
              "code": "185",
              "name": "Helm Bank"
            },
            {
              "code": "186",
              "name": "Banco Agrario"
            },
            {
              "code": "187",
              "name": "BCSC"
            },
            {
              "code": "188",
              "name": "Corpbanca"
            },
            {
              "code": "189",
              "name": "Citibank"
            },
            {
              "code": "190",
              "name": "Banco AV Villas"
            },
            {
              "code": "191",
              "name": "Banco Procredit Colombia"
            },
            {
              "code": "192",
              "name": "Banco Pichincha"
            },
            {
              "code": "193",
              "name": "Bancoomeva"
            },
            {
              "code": "194",
              "name": "Banco Santander de Negocios Colombia S.A."
            },
            {
              "code": "195",
              "name": "Banco Falabella"
            },
            {
              "code": "196",
              "name": "Banco Finandina"
            },
            {
              "code": "198",
              "name": "Banco Itaú"
            },
            {
              "code": "199",
              "name": "Banco Itaú Corpbanca"
            },
            {
              "code": "200",
              "name": "Lulo Bank"
            },
            {
              "code": "201",
              "name": "Banco Coltefinanciera"
            },
            {
              "code": "202",
              "name": "Banco Uala"
            },
            {
              "code": "203",
              "name": "Banco Cooperativo Coopcentral"
            },
            {
              "code": "204",
              "name": "Rappipay Daviplata"
            },
            {
              "code": "206",
              "name": "Cooperativa Financiera de Antioquia"
            },
            {
              "code": "207",
              "name": "Financiera Juriscoop S.A"
            },
            {
              "code": "208",
              "name": "Confiar"
            },
            {
              "code": "209",
              "name": "Cootrafa Cooperativa Financiera"
            },
            {
              "code": "210",
              "name": "Banco GNB Sudameris"
            },
            {
              "code": "211",
              "name": "Banco Caja Social"
            },
            {
              "code": "226",
              "name": "SCOTIABANK COLPATRIA"
            },
            {
              "code": "395",
              "name": "Banco GNB Colom"
            },
            {
              "code": "396",
              "name": "Coomeva"
            },
            {
              "code": "397",
              "name": "Coopcentral"
            },
            {
              "code": "398",
              "name": "Coofinantioquia"
            },
            {
              "code": "399",
              "name": "Confiar Coopera"
            },
            {
              "code": "400",
              "name": "Finan Juriscoop"
            },
            {
              "code": "401",
              "name": "Fiduc Skandia"
            },
            {
              "code": "402",
              "name": "Direccion Tesor"
            },
            {
              "code": "403",
              "name": "Bancoldex"
            },
            {
              "code": "404",
              "name": "Jpmorgan Corpor"
            },
            {
              "code": "405",
              "name": "BNP Paribas"
            },
            {
              "code": "406",
              "name": "Banco W S.A"
            },
            {
              "code": "407",
              "name": "Compensar"
            },
            {
              "code": "409",
              "name": "nequi"
            }
          ],
          "valueField": "code"
        },
        {
          "id": "bankName",
          "path": "recipient.bank.name",
          "type": "text",
          "validation": "string",
          "description": "Use the name from the selected bankCode option."
        },
        {
          "id": "accountNumber",
          "path": "recipient.bank.accountNumber",
          "type": "text",
          "validation": "[0-9]{7,20}"
        },
        {
          "id": "accountType",
          "path": "recipient.bank.accountType",
          "type": "option",
          "validation": "string",
          "options": [
            {
              "code": "SAVINGS",
              "name": "Cuenta de Ahorros"
            },
            {
              "code": "CHECKING",
              "name": "Cuenta Corriente"
            }
          ],
          "valueField": "code"
        }
      ]
    },
    {
      "id": 3,
      "name": "Breb",
      "settlement": 200,
      "minSendAmount": {
        "currency": "USD",
        "amount": 2.5
      },
      "maxSendAmount": {
        "currency": "USD",
        "amount": 1000
      },
      "requirements": [
        {
          "id": "name",
          "path": "recipient.name",
          "type": "text",
          "validation": "string"
        },
        {
          "id": "documentType",
          "path": "recipient.documentType",
          "type": "text",
          "validation": "string"
        },
        {
          "id": "documentNumber",
          "path": "recipient.documentNumber",
          "type": "text",
          "validation": "string"
        },
        {
          "id": "phoneNumber",
          "path": "recipient.phoneNumber",
          "type": "text",
          "validation": "string"
        },
        {
          "id": "quoteCurrency",
          "path": "quoteCurrency",
          "type": "option",
          "validation": "string",
          "options": [
            {
              "code": "COP",
              "name": "Peso colombiano"
            }
          ],
          "valueField": "code"
        },
        {
          "id": "keyValue",
          "path": "recipient.key.value",
          "type": "text",
          "validation": "string"
        }
      ]
    }
  ]
}

Returns the list of available payout methods supported by the provider.

Use this endpoint to retrieve all payment methods that can be used as payout destinations for off-ramp transactions (e.g. bank accounts, mobile wallets, Bre-B). The response can be used to dynamically populate payout options in your integration.

Authentication: Bearer token ({{JWT_LOGIN}}) + x-api-key header.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

currencystringOptional

Response headers

x-amzn-RequestIdstringOptional

Access-Control-Allow-OriginstringOptional

x-amz-apigw-idstringOptional

X-Amzn-Trace-IdstringOptional

Response

methodslist of objects

Authentication

Headers

Query parameters

Response headers

Response