GuidesCommunity
Guides

Consultando um pagamento

Suggest Edits

A solução de iniciação de pagamento da Bit Capital possui uma busca de pagamento que pode ser realizada das seguintes formas.

  • Consulta por pagamento 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 pagamento.

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 pagamento específico

ENDPOINT: open-finance/tpp/payments/v2/pix/payments/{paymentId}
Esta chamada utiliza o método GET.

Ao realizar uma consulta será listado as informações do pagamento informado no parâmetro paymentId.

{
  "consentId": "urn:bancoex:C1DD33123",
  "creationDateTime": "string",
  "creditorAccount": {
    "ispb": "12345678",
    "issuer": "1774",
    "number": "1234567890",
    "accountType": "CACC"
  },
  "creditor": {
    "personType": "PESSOA_NATURAL",
    "cpfCnpj": "string",
    "name": "string"
  },
  "endToEndId": "string",
  "localInstrument": "string",
  "payment": {
    "amount": "100000.12",
    "currency": "BRL"
  },
  "paymentId": "string",
  "proxy": "string",
  "rejectionReason": "string",
  "remittanceInformation": "string",
  "status": "enum",
  "statusUpdateDateTime": "string",
  "authorisationServer": {},
  "cnpjInitiator": "string",
  "transactionIdentification": "string"
}

{
  "consentId": "string",
  "creationDateTime": "string",
  "creditorAccount": {
    "ispb": "string",
    "issuer": "string",
    "number": "string",
    "accountType": "enum"
  },
  "endToEndId": "string",
  "localInstrument": "string",
  "payment": {
    "amount": "string",
    "currency": "string"
  },
  "paymentId": "string",
  "proxy": "string",
  "rejectionReason": "enum",
  "remittanceInformation": "string",
  "status": "enum",
  "statusUpdateDateTime": "string",
  "cnpjInitiator": "string",
  "transactionIdentification": "string"
}

Consulta de pagamento por período

ENDPOINT: open-finance/tpp/payments/v2/pix/payments?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, as iniciações de pagamentos criadas dentro do período informado de forma paginada.

{
  "consentId": "string",
  "creationDateTime": "string",
  "creditorAccount": {
    "ispb": "string",
    "issuer": "string",
    "number": "string",
    "accountType": "enum"
  },
  "endToEndId": "string",
  "localInstrument": "string",
  "payment": {
    "amount": "string",
    "currency": "string"
  },
  "paymentId": "string",
  "proxy": "string",
  "rejectionReason": "enum",
  "remittanceInformation": "string",
  "status": "enum",
  "statusUpdateDateTime": "string",
  "cnpjInitiator": "string",
  "transactionIdentification": "string"
 } 
 ],
  "meta": {
    "totalRecords": number,
    "count": number,
    "totalPages": number,
    "requestDateTime": "string"
  },
  "links": {
    "self": "string",
    "first": "string",
    "prev": "string",
    "next": "string",
    "last": "string"
  }
}

Consulta de pagamento por data específica

ENDPOINT: open-finance/tpp/payments/v2/pix/payments?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, as iniciações de pagamentos criadas dentro da data especificada informada.

{
  "consentId": "string",
  "creationDateTime": "string",
  "creditorAccount": {
    "ispb": "string",
    "issuer": "string",
    "number": "string",
    "accountType": "enum"
  },
  "endToEndId": "string",
  "localInstrument": "string",
  "payment": {
    "amount": "string",
    "currency": "string"
  },
  "paymentId": "string",
  "proxy": "string",
  "rejectionReason": "enum",
  "remittanceInformation": "string",
  "status": "enum",
  "statusUpdateDateTime": "string",
  "cnpjInitiator": "string",
  "transactionIdentification": "string"
 } 
 ],
  "meta": {
    "totalRecords": number,
    "count": number,
    "totalPages": number,
    "requestDateTime": "string"
  },
  "links": {
    "self": "string",
    "first": "string",
    "prev": "string",
    "next": "string",
    "last": "string"
  }
}

Consulta de pagamento por identificação

ENDPOINT: open-finance/tpp/payments/v2/pix/payments?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 pagador.

Ao realizar uma consulta será listado, de forma paginada, as iniciações de pagamentos criadas para o número do documento informado.

{
  "consentId": "string",
  "creationDateTime": "string",
  "creditorAccount": {
    "ispb": "string",
    "issuer": "string",
    "number": "string",
    "accountType": "enum"
  },
  "endToEndId": "string",
  "localInstrument": "string",
  "payment": {
    "amount": "string",
    "currency": "string"
  },
  "paymentId": "string",
  "proxy": "string",
  "rejectionReason": "enum",
  "remittanceInformation": "string",
  "status": "enum",
  "statusUpdateDateTime": "string",
  "cnpjInitiator": "string",
  "transactionIdentification": "string"
 } 
 ],
  "meta": {
    "totalRecords": number,
    "count": number,
    "totalPages": number,
    "requestDateTime": "string"
  },
  "links": {
    "self": "string",
    "first": "string",
    "prev": "string",
    "next": "string",
    "last": "string"
  }
}

Updated over 1 year ago