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 abertura de conta.

JSON de exemplo

Consultar

get

Authorizations

Query parameters

clientRequestIdstringRequired

Identificador do cliente

Example: 9b0152c5-5ee3-419e-a8a2-ca22025cfe66

Responses

200

successful

application/json

401

authorization failed

422

validation failed

500

unknown server error

application/json

get

HTTPcURLJavaScriptPython

GET /internal/api/v1/payments/status?clientRequestId=9b0152c5-5ee3-419e-a8a2-ca22025cfe66 HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": 1,
  "uuid": "13a66442-fc29-4142-b6f9-d181aee07436",
  "type": "C",
  "subType": "PIX",
  "codBankCredit": "001",
  "agencyCredit": "1",
  "accountNumberCredit": "1",
  "digitCredit": "1",
  "accountTypeCredit": "CORRENTE",
  "keyCredit": "1",
  "nameCredit": "1",
  "codBankDebit": "001",
  "agencyDebit": "1",
  "accountNumberDebit": "1",
  "digitDebit": "1",
  "accountTypeDebit": "CORRENTE",
  "nameDebit": "1",
  "endToEnd": "1",
  "idRequest": "1",
  "message": "1",
  "description": "1",
  "name": "1",
  "document": "1",
  "active": true,
  "createdAt": "2020-01-01T00:00:00.000Z",
  "updatedAt": "2020-01-01T00:00:00.000Z",
  "ispbCredit": "540392",
  "ispbDebit": "312412",
  "amount": 100,
  "status": "SUCCESS",
  "idConciliationReceiver": "1",
  "documentPayer": "4123921344",
  "documentReceiver": "00132402423",
  "personTypeCredit": "1",
  "personTypeDebit": "1",
  "initializationType": "1",
  "endToEndOrigin": "1"
}