Consultando um consentimento
A solução de iniciação de pagamento da Bit Capital possui uma busca de consentimento que pode ser realizada das seguintes formas.
- Consulta por consentimento específico.
- Consulta por período
- Consulta por uma data específica.
- Consulta por número de documento (CPF)
Para consultar essas informações é necessário que seja realizada uma consulta no nosso endpoint de consentimento.
Nesta documentação vamos seguir como utilizar consulta utilizando cada forma mencionada acima.
Consulta com mais de um parâmetro
É possível realizar consulta utilizando dois parâmetros como por exemplo:
_Período e número de documento
_Data específica e número de documento.
Consulta por consentimento específico
ENDPOINT: open-finance/tpp/payments/v2/consents/{consentId}
Esta chamada utiliza o método GET.
Ao realizar uma consulta será listado as informações do consentimento informado no parâmetro consentId.
{
"data": [
{
"consentId": "string",
"creationDateTime": "string",
"expirationDateTime": "string",
"statusUpdateDateTime": "string",
"status": "enum",
"loggedUser": {
"document": {
"identification": "string",
"rel": "string"
}
},
"businessEntity": {
"document": {
"identification": "string",
"rel": "string"
}
},
"creditor": {
"personType": "enum",
"cpfCnpj": "string",
"name": "string"
},
"payment": {
"type": "enum",
"date": "string",
"currency": "string",
"amount": "string",
"ibgeTownCode": "string",
"details": {
"localInstrument": "enum",
"proxy": "string",
"qrCode": "string",
"creditorAccount": {
"ispb": "string",
"issuer": "string",
"number": "string",
"accountType": "enum"
}
}
},
"debtorAccount": {
"ispb": "string",
"issuer": "string",
"number": "string",
"accountType": "enum"
}
}
],
"meta": {
"totalRecords": number,
"count": number,
"totalPages": number,
"requestDateTime": "string"
},
"links": {
"self": "string",
"first": "string",
"prev": "string",
"next": "string",
"last": "string"
}
}
Consulta de consentimento por período
ENDPOINT: open-finance/tpp/payments/v2/consents?startDate=DDMMYYYY&endDate=DDMMYYYY
Esta chamada utiliza o método GET.
Para realizar uma busca por período é necessário definir a data inicial desse período (startDate) e a data final do período desejado (endDate).
Ao realizar uma consulta será listado, de forma paginada, os consentimentos criados dentro do período informado de forma paginada.
{
"data": [
{
"consentId": "string",
"creationDateTime": "string",
"expirationDateTime": "string",
"statusUpdateDateTime": "string",
"status": "enum",
"loggedUser": {
"document": {
"identification": "string",
"rel": "string"
}
},
"businessEntity": {
"document": {
"identification": "string",
"rel": "string"
}
},
"creditor": {
"personType": "enum",
"cpfCnpj": "string",
"name": "string"
},
"payment": {
"type": "enum",
"date": "string",
"currency": "string",
"amount": "string",
"ibgeTownCode": "string",
"details": {
"localInstrument": "enum",
"proxy": "string",
"qrCode": "string",
"creditorAccount": {
"ispb": "string",
"issuer": "string",
"number": "string",
"accountType": "enum"
}
}
},
"debtorAccount": {
"ispb": "string",
"issuer": "string",
"number": "string",
"accountType": "enum"
}
}
],
"meta": {
"totalRecords": number,
"count": number,
"totalPages": number,
"requestDateTime": "string"
},
"links": {
"self": "string",
"first": "string",
"prev": "string",
"next": "string",
"last": "string"
}
}
Consulta de consentimento por data específica
ENDPOINT: open-finance/tpp/payments/v2/consents?startDate=DDMMYYYY&endDate=DDMMYYYY
Esta chamada utiliza o método GET.
Para realizar uma busca por período é necessário definir a data inicial desse período (startDate) e a data final do período desejado (endDate) utilizando a mesma data.
*P.ex.: startDate=0101000; endDate=01010000
Ao realizar uma consulta será listado, de forma paginada, os consentimentos criados dentro da data especificada informada.
{
"data": [
{
"consentId": "string",
"creationDateTime": "string",
"expirationDateTime": "string",
"statusUpdateDateTime": "string",
"status": "enum",
"loggedUser": {
"document": {
"identification": "string",
"rel": "string"
}
},
"businessEntity": {
"document": {
"identification": "string",
"rel": "string"
}
},
"creditor": {
"personType": "enum",
"cpfCnpj": "string",
"name": "string"
},
"payment": {
"type": "enum",
"date": "string",
"currency": "string",
"amount": "string",
"ibgeTownCode": "string",
"details": {
"localInstrument": "enum",
"proxy": "string",
"qrCode": "string",
"creditorAccount": {
"ispb": "string",
"issuer": "string",
"number": "string",
"accountType": "enum"
}
}
},
"debtorAccount": {
"ispb": "string",
"issuer": "string",
"number": "string",
"accountType": "enum"
}
}
],
"meta": {
"totalRecords": number,
"count": number,
"totalPages": number,
"requestDateTime": "string"
},
"links": {
"self": "string",
"first": "string",
"prev": "string",
"next": "string",
"last": "string"
}
}
Consulta de consentimento por identificação
ENDPOINT: open-finance/tpp/payments/v2/consents?identification=documentNumber
Esta chamada utiliza o método GET.
Para realizar uma busca por número de documento é necessário informar o documento de identificação (identification) do usuário que detém o consentimento.
Ao realizar uma consulta será listado, de forma paginada, os consentimentos criados para o número do documento informado.
{
"data": [
{
"consentId": "string",
"creationDateTime": "string",
"expirationDateTime": "string",
"statusUpdateDateTime": "string",
"status": "enum",
"loggedUser": {
"document": {
"identification": "string",
"rel": "string"
}
},
"businessEntity": {
"document": {
"identification": "string",
"rel": "string"
}
},
"creditor": {
"personType": "enum",
"cpfCnpj": "string",
"name": "string"
},
"payment": {
"type": "enum",
"date": "string",
"currency": "string",
"amount": "string",
"ibgeTownCode": "string",
"details": {
"localInstrument": "enum",
"proxy": "string",
"qrCode": "string",
"creditorAccount": {
"ispb": "string",
"issuer": "string",
"number": "string",
"accountType": "enum"
}
}
},
"debtorAccount": {
"ispb": "string",
"issuer": "string",
"number": "string",
"accountType": "enum"
}
}
],
"meta": {
"totalRecords": number,
"count": number,
"totalPages": number,
"requestDateTime": "string"
},
"links": {
"self": "string",
"first": "string",
"prev": "string",
"next": "string",
"last": "string"
}
}
Descrição dos campos
| Campo | Descrição |
|---|---|
| consentId | Identificação do consentimento. |
| creationDateTime | Data de criação do consentimento. |
| expirationDateTime | Data de expiração do consentimento. |
| statusUpdateDateTime | Data de atualização do estado do consentimento. |
| status | Campo do tipo ENUM. Estado do consentimento. (AWAITING_AUTHORIZATION; AUTHORISED; REJECTED; CONSUMED) |
| loggedUser.identification | Número de identificação do usuário (Pessoa natural) pagador / logado. |
| loggedUser.rel | Tipo de documento de identificação do usuário (Pessoa natural) pagador / logado. |
| businessEntity.identification | Número do CNPJ do titular pessoa jurídica relacionada ao usuário (Pessoa natural) informado no objeto loggedUser. |
| businessEntity.rel | Tipo de documento de identificação da pessoa jurídica relacionada ao usuário (Pessoa natural) informado no objeto loggedUser. |
| creditor.personType | Campo do tipo ENUM. Titular, pessoa natural ou jurídica a quem se referem os dados do recebedor. (PESSOA_NATURAL; PESSOA_JURIDICA). |
| creditor.cpfCnpj | Número do documento de identificação da que se refere a pessoa recebedora**. |
| creditor.name | Nome da que se refere a pessoa recebedora. Em caso de pessoa natural nome completo do titular da conta do recebedor. Em caso da pessoa jurídica deve ser informada a razão social ou o nome fantasia. |
| payment.type | Campo do tipo ENUM. Tipo de pagamento do consentimento (PIX) |
| payment.date | Data do pagamento. |
| payment.currency | Moeda do valor da transação |
| payment.amount | Valor da transação. |
| payment.ibgeTownCode | Código da cidade segundo IBGE. |
| details.localInstrument | Campo tipo ENUM. Especifica a forma da iniciação de pagamento (MANU; DICT; QRDN; QRES; INIC) |
| details.proxy | Chave PIX relacionada a pessoa recebedora informada no objeto creditor |
| details.qrCode | Sequência de caracteres que corresponde ao QR Code disponibilizado para o pagador. |
| creditorAccount.ispb | ISPB do banco referente a conta relacionada a pessoa recebedora informada no objeto creditor. |
| creditorAccount.issuer | Agência do banco referente a conta relacionada a pessoa recebedora informada no objeto creditor. |
| creditorAccount.number | Número da conta do banco referente a conta relacionada a pessoa recebedora informada no objeto creditor. |
| creditorAccount.accountType | Campo do tipo ENUM. Tipo de conta do banco referente a conta relacionada a pessoa recebedora informada no objeto creditor. (CACC; SVGS; TRAN; SLRY). |
| debtorAccount.ispb | ISPB do banco referente a conta relacionada a pessoa pagadora informada no objeto loggedUser. |
| debtorAccount.issuer | Agência do banco referente a conta relacionada a pessoa pagadora informada no objeto loggedUser. |
| debtorAccount.number | Número da conta do banco referente a conta relacionada a pessoa pagadora informada no objeto loggedUser. |
| debtorAccount.accountType | Campo do tipo ENUM. Tipo de conta do banco referente a conta relacionada a pessoa pagadora informada no objeto loggedUser. (CACC; SVGS; TRAN; SLRY). |
Updated 9 months ago