Retornar informações do QR Code e da chave Pix a partir de um EMV

Essa API possibilita a consulta do EMV (Pix Copia e Cola), de QR Codes estáticos e dinâmicos. A resposta trará, também, todos os dados da cobrança e da chave do recebedor

post/pix/v1/emv/read

Request

  • Base URL
    https://sandbox.openfinance.celcoin.dev
  • URL
    https://sandbox.openfinance.celcoin.dev/pix/v1/emv/read
  • Auth
    OAuth 2

Request body

emvstring required

Código EMV do QR Code

Response

200

typestring
typeDescriptionstring
collectionstring
collectionDescriptionstring

Example response

{
  "type": "STATIC",
  "typeDescription": "string",
  "collection": "NO_VALUE",
  "collectionDescription": "string",
  "emv": {
    "type": "2",
    "collection": "2",
    "payloadFormatIndicator": "01",
    "merchantAccountInformation": {
      "url": "https://api.dev.developer.btgpactual.com/v1/q/d/07071e551d224008baabfc54b7a4a5ab",
      "gui": "https://api.dev.developer.btgpactual.com",
      "key": "a20413ac-b053-45a1-9ba3-2d6d8a56bfc0",
      "additionalInformation": "string",
      "withdrawalServiceProvider": "string"
    },
    "transactionCurrency": 986,
    "transactionAmount": 15.26,
    "countryCode": "BR",
    "merchantName": "Celcoin",
    "merchantCity": "Barueri",
    "postalCode": "11122333",
    "initiationMethod": "12",
    "transactionIdentification": "***"
  },
  "payloadImmediate": {
    "status": "string",
    "infoAdicionais": [
      {
        "value": "Assinatura de serviço",
        "key": "Produto 1"
      }
    ],
    "txid": "string",
    "chave": "string",
    "solicitacaoPagador": "string",
    "valor": {
      "original": "string",
      "abatimento": "string",
      "desconto": "string",
      "multa": "string",
      "juros": "string",
      "final": "string",
      "retirada": {
        "troco": {
          "modalidadeAgente": "AGTEC",
          "prestadorDoServicoDeSaque": "13935893",
          "valor": 10
        },
        "saque": {
          "modalidadeAgente": "AGTEC",
          "prestadorDoServicoDeSaque": "13935893",
          "valor": 10
        }
      }
    },
    "calendario": {
      "criacao": "2022-11-18T13:25:59.549Z",
      "apresentacao": "2022-11-18T13:25:59.549Z"
    }
  },
  "payloadDuedate": {
    "calendar": {
      "createdAt": "2022-11-18T13:25:59.549Z",
      "presentation": "2022-11-18T13:25:59.549Z",
      "dueDate": "2022-11-18T13:25:59.549Z"
    },
    "debtor": {
      "cpf": "string",
      "cnpj": "string",
      "name": "string"
    },
    "receiver": {
      "cnpj": "string",
      "cpf": "string",
      "fantasyName": "string",
      "publicArea": "string",
      "city": "string",
      "state": "string",
      "postalCode": "string"
    },
    "transactionIdentification": "string",
    "revision": "string",
    "status": "string",
    "key": "string",
    "amount": {
      "original": "string",
      "abatement": "string",
      "discount": "string",
      "interest": "string",
      "fine": "string",
      "final": "string"
    },
    "additionalInformation": [
      {
        "value": "Assinatura de serviço",
        "key": "Produto 1"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.