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.

Na GlobalSCM, os clientes têm a capacidade de verificar facilmente o status de qualquer transação Pix realizada em suas contas BaaS (Banking as a Service). Essa funcionalidade oferece uma visão detalhada e em tempo real do progresso de suas transações, proporcionando maior controle e transparência sobre suas operações financeiras.

Um cliente da GlobalSCM realiza uma transação Pix em sua conta BaaS e deseja verificar o status dessa transação. Eles acessam a funcionalidade de verificação de status na plataforma GlobalSCM, inserem o idRequest da transação e recebem imediatamente informações detalhadas sobre o progresso da transação, incluindo se foi aprovada, rejeitada ou está pendente.

A funcionalidade de verificação de status de Pix na GlobalSCM oferece aos clientes uma maneira simples e eficaz de acompanhar o status de suas transações, proporcionando maior controle e tranquilidade em suas atividades financeiras.

Como utilizar?

Para utilizar essa funcionalidade, siga estes passos simples. Abaixo, você encontrará exemplos de como realizar o processo de abertura de conta.

Requisição de exemplo

Consultar Por TaxId

get

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

taxIdstringRequired

Identificador fiscal do pagamento.

Example: tax00311

Responses

200

successful

application/json

idintegerOptionalExample: 1

uuidstringOptionalExample: 13a66442-fc29-4142-b6f9-d181aee07436

typestring · enumOptionalExample: CPossible values:

subTypestring · enumOptionalExample: PIXPossible values:

codBankCreditstringOptionalExample: 001

agencyCreditstringOptionalExample: 1

accountNumberCreditstringOptionalExample: 1

digitCreditstringOptionalExample: 1

accountTypeCreditstringOptionalExample: CORRENTE

keyCreditstringOptionalExample: 1

nameCreditstringOptionalExample: 1

codBankDebitstringOptionalExample: 001

agencyDebitstringOptionalExample: 1

accountNumberDebitstringOptionalExample: 1

digitDebitstringOptionalExample: 1

accountTypeDebitstringOptionalExample: CORRENTE

nameDebitstringOptionalExample: 1

endToEndstringOptionalExample: 1

idRequeststringOptionalExample: 1

messagestringOptionalExample: 1

descriptionstringOptionalExample: 1

namestringOptionalExample: 1

documentstringOptionalExample: 1

activebooleanOptionalExample: true

createdAtstringOptionalExample: 2020-01-01T00:00:00.000Z

updatedAtstringOptionalExample: 2020-01-01T00:00:00.000Z

ispbCreditstringOptionalExample: 540392

ispbDebitstringOptionalExample: 312412

amountnumberOptionalExample: 100

statusstringOptionalExample: SUCCESS

idConciliationReceiverstringOptionalExample: 1

documentPayerstringOptionalExample: 4123921344

documentReceiverstringOptionalExample: 00132402423

personTypeCreditstringOptionalExample: 1

personTypeDebitstringOptionalExample: 1

initializationTypestringOptionalExample: 1

endToEndOriginstringOptionalExample: 1

401

authorization failed

422

validation failed

500

unknown server error

application/json

get

https://sandbox.globalscm.app.br/internal/api/v1/payments/status?taxId=tax00311

HTTPcURLJavaScriptPython

GET https://sandbox.globalscm.app.br/internal/api/v1/payments/status?taxId=tax00311?taxId=tax00311 HTTP/1.1
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"
}

Consultar

get

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

endToEndIdstringOptional

ID da transação

Example: E18236120202402110210s087ce99eab

Responses

200

successful

No content

401

authorization failed

422

validation failed

500

unknown server error

get

https://sandbox.globalscm.app.br/internal/api/v1/payments/status?endToEndId=E18236120202402110210s087ce99eab

HTTPcURLJavaScriptPython

GET https://sandbox.globalscm.app.br/internal/api/v1/payments/status?endToEndId=E18236120202402110210s087ce99eab HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Consultar Por TaxId, ClientRequestId ou EndToEndId

get

Endpoint para consulta de status de pagamento utilizando diferentes identificadores.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

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

200

Requisição bem-sucedida.

application/json

idintegerOptionalExample: 1

uuidstringOptionalExample: 13a66442-fc29-4142-b6f9-d181aee07436

typestring · enumOptionalExample: CPossible values:

subTypestring · enumOptionalExample: PIXPossible values:

codBankCreditstringOptionalExample: 001

agencyCreditstringOptionalExample: 1

accountNumberCreditstringOptionalExample: 1

digitCreditstringOptionalExample: 1

accountTypeCreditstringOptionalExample: CORRENTE

keyCreditstringOptionalExample: 1

nameCreditstringOptionalExample: 1

codBankDebitstringOptionalExample: 001

agencyDebitstringOptionalExample: 1

accountNumberDebitstringOptionalExample: 1

digitDebitstringOptionalExample: 1

accountTypeDebitstringOptionalExample: CORRENTE

nameDebitstringOptionalExample: 1

endToEndstringOptionalExample: 1

idRequeststringOptionalExample: 1

messagestringOptionalExample: 1

descriptionstringOptionalExample: 1

namestringOptionalExample: 1

documentstringOptionalExample: 1

activebooleanOptionalExample: true

createdAtstringOptionalExample: 2020-01-01T00:00:00.000Z

updatedAtstringOptionalExample: 2020-01-01T00:00:00.000Z

ispbCreditstringOptionalExample: 540392

ispbDebitstringOptionalExample: 312412

amountnumberOptionalExample: 100

statusstringOptionalExample: SUCCESS

idConciliationReceiverstringOptionalExample: 1

documentPayerstringOptionalExample: 4123921344

documentReceiverstringOptionalExample: 00132402423

personTypeCreditstringOptionalExample: 1

personTypeDebitstringOptionalExample: 1

initializationTypestringOptionalExample: 1

endToEndOriginstringOptionalExample: 1

401

Falha de autorização.

422

Falha de validação.

500

Erro desconhecido no servidor.

application/json

get

https://sandbox.globalscm.app.br/internal/api/v1/payments/status

HTTPcURLJavaScriptPython

GET https://sandbox.globalscm.app.br/internal/api/v1/payments/status HTTP/1.1
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"
}

Consultar Por TaxId

get

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

taxIdstringOptional

TaxId do cliente

Example: tax0011

Responses

200

successful

No content

401

authorization failed

422

validation failed

500

unknown server error

get

https://sandbox.globalscm.app.br/internal/api/v1/payments/status?taxId=tax0011

HTTPcURLJavaScriptPython

GET https://sandbox.globalscm.app.br/internal/api/v1/payments/status?taxId=tax0011 HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content