Verifica o Status de uma transação Pix

Importante:

Para usar esta API, é necessário estar autenticado e incluir seu token de autenticação no cabeçalho da requisição. Consulte a documentação de Autenticação na plataforma para mais informações.

Autenticação.

A consulta de status de pagamento é uma funcionalidade essencial para os clientes da GlobalSCM que desejam acompanhar o andamento das transações financeiras realizadas em suas contas. Os clientes podem consultar detalhes específicos sobre uma transação financeira, incluindo informações como o status atual, data e hora da transação, valores envolvidos e qualquer mensagem relevante associada à transação.

Como utilizar?

Para utilizar essa funcionalidade, siga estes passos simples. Abaixo, você encontrará exemplos de como realizar o processo de verificar o Status de uma transacao.

JSON de exemplo

Consultar Por TaxId, ClientRequestId ou EndToEndId

get

Endpoint para consulta de status de pagamento utilizando diferentes identificadores.

Authorizations

Query parameters

clientRequestIdstringOptional

Identificador de requisição do cliente.

Example: JEerndILjd2SZPXI2J322IswJJ

endToEndIdstringOptional

Identificador de ponta a ponta.

Example: E0037723920240733183109353521122

taxIdstringOptional

Identificador fiscal do pagamento.

Example: e77e1913-4df4-24Xb-9366-c81a6ebAe7a0

Responses

get

HTTPcURLJavaScriptPython

GET /internal/api/v1/payments/status HTTP/1.1
Host: sandbox.globalscm.app.br
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": 132846,
  "uuid": "0438ef19-4239-4706-bc75-76b0498af486",
  "type": "C",
  "subType": "PIX",
  "codBankCredit": "11165756",
  "agencyCredit": "0001",
  "accountNumberCredit": "0000002",
  "digitCredit": "1",
  "accountTypeCredit": "0",
  "keyCredit": "",
  "nameCredit": "41014420000104",
  "codBankDebit": "1852137",
  "agencyDebit": "1",
  "accountNumberDebit": "158",
  "digitDebit": "",
  "accountTypeDebit": "0",
  "nameDebit": "teste",
  "endToEnd": "E0185213720240207173432227247024",
  "idRequest": "c825f091-abb5-45e0-a0e5-7ec848cfa9fe",
  "message": "",
  "description": "",
  "name": "REVIVE CARE DESCARTAVEIS HOPITALARES DO BRASIL LTDA",
  "document": null,
  "active": true,
  "createdAt": "2024-02-07T17:34:33.000Z",
  "updatedAt": "2024-08-02T14:37:05.000Z",
  "isbp_credit": "11165756",
  "isbp_debit": "1852137",
  "amount": "0.06",
  "status": "SUCCESS",
  "idConciliacaoRecebedor": "",
  "documentPayer": "",
  "documentReceiver": ""
}