Moedas e métodos

GEThttps://api.zwaybr.com/api/v1/payments/methods

Lista as moedas e os métodos liberados para a sua conta, com valor mínimo/máximo e os campos exigidos de cada método.

Query

currencystring
Filtra por uma moeda (ISO 4217). Sem ela, todas as moedas da conta.

Para que serve

Mostrar ao comprador só os métodos liberados para a sua conta.
requiredFields diz o que coletar antes de criar o pagamento (ex.: SPEI exige document.number e birthDate).
Moeda ou método desativado some desta lista na hora.

Linguagem

Shell

curl --request GET \
  --url https://api.zwaybr.com/api/v1/payments/methods \
  --header "Authorization: Bearer $ZWAY_API_KEY"

Resposta 200

{
  "currencies": [
    {
      "currency": "BRL",
      "name": "Real brasileiro",
      "symbol": "R$",
      "decimals": 2,
      "country": "BR",
      "methods": [
        {
          "paymentMethod": "PIX",
          "name": "PIX",
          "minAmount": 500,
          "maxAmount": null,
          "requiredFields": [
            "name",
            "email",
            "document",
            "phone",
            "items"
          ],
          "optionalFields": [
            "externalId",
            "postbackUrl"
          ]
        },
        {
          "paymentMethod": "BOLETO",
          "name": "Boleto",
          "minAmount": 100,
          "maxAmount": null,
          "requiredFields": [
            "name",
            "email",
            "document",
            "items"
          ],
          "optionalFields": [
            "externalId",
            "postbackUrl"
          ]
        },
        {
          "paymentMethod": "CREDIT_CARD",
          "name": "Cartão de crédito",
          "minAmount": 100,
          "maxAmount": null,
          "requiredFields": [
            "name",
            "email",
            "document",
            "items",
            "cardToken",
            "tokenOrigin"
          ],
          "optionalFields": [
            "externalId",
            "postbackUrl"
          ]
        }
      ]
    },
    {
      "currency": "MXN",
      "name": "Peso mexicano",
      "symbol": "MX$",
      "decimals": 2,
      "country": "MX",
      "methods": [
        {
          "paymentMethod": "SPEI",
          "name": "SPEI",
          "minAmount": 1,
          "maxAmount": 2000000000,
          "requiredFields": [
            "name",
            "document.type",
            "document.number",
            "birthDate",
            "birthCountry"
          ],
          "optionalFields": [
            "externalId"
          ]
        },
        {
          "paymentMethod": "OXXO",
          "name": "OXXO",
          "minAmount": 1000,
          "maxAmount": 1000000,
          "requiredFields": [],
          "optionalFields": [
            "externalId"
          ]
        }
      ]
    }
  ]
}

Resposta 400

{
  "error": true,
  "code": "VALIDATION_ERROR",
  "message": "currency inválida (ex.: BRL, MXN)"
}