v1

latestOpenAPI 3.0.12026-07-245303882.5 MB

Retornar informações de um QRCode pelo EMV

Essa API possibilita a consulta do EMV (Pix Copia e Cola), de QR Codes estáticos e dinâmicos. Sem a necessidade de utilizar o endpoint de payload.

post/pix/v1/emv/full

Request body

emvstring required

Código EMV do QRCode

codMunstring

Código do município do pagador

dppstring

Data de pagamento pretendida

Response

200

versionstring

statusinteger

Example response

{
  "version": "1.0.0",
  "status": 200,
  "body": {
    "type": "DUEDATE",
    "merchantAccountInformation": {
      "url": "ex.com.br/U0VHUkVET1RPVEFMTUVOVEVBTEVBVE9SSU8",
      "gui": "br.gov.bcb.pix",
      "merchantCategoryCode": "0000",
      "additionaldata": "Obrigado por comprar",
      "withdrawalServiceProvider": "13935893",
      "merchantName": "Empresa S.A.",
      "merchantCity": "Barueri",
      "postalCode": "20770000"
    },
    "key": "fulano.tal@provedor.com.br",
    "amount": {
      "original": 10,
      "abatement": 0.05,
      "discount": 1.1,
      "interest": 1.1,
      "fine": 1.1,
      "withdrawal": {
        "canModifyWithdrawal": true,
        "agentMode": "false",
        "withdrawalServiceProvider": "13935893"
      },
      "change": {
        "canModifyChange": true,
        "agentMode": "false",
        "withdrawalServiceProvider": "13935893"
      }
    },
    "transactionIdentification": "2020010300000000000000000000001",
    "payload": {
      "status": "ACTIVE",
      "calendar": {
        "createdAt": "2020-09-15T19:39:54.013Z",
        "presentation": "2020-04-01T18:00:00Z",
        "dueDate": "2020-09-16T19:39:54.013Z",
        "validateAfterDuedate": 1,
        "expiration": 86400,
        "expirationDate": "2020-09-16T19:39:54.013Z"
      },
      "debtor": {
        "cpf": "98631057088",
        "cnpj": "99353695000152",
        "name": "Fulano de tal"
      },
      "receiver": {
        "cnpj": "99353695000152",
        "cpf": "98631057088",
        "fantasyName": "string",
        "publicArea": "Alameda Xingu, 350 - CJ 1604",
        "city": "Barueri",
        "state": "SP",
        "postalCode": "SP"
      },
      "payerQuestion": "Informar cartao fidelidade",
      "additionalInformation": [
        {
          "value": "5.00",
          "key": "Multa por valor fixo"
        }
      ]
    }
  }
}