Envio de webhook das transações

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.

Este é o Webhook de notificação de transações que aconteceram. Com os formatos que será enviado para os parceiros.

É importante que os parceiros respondam com HTTP código 200.

Como utilizar?

Para utilizar essa funcionalidade, siga estes passos simples. necessario apenas cadastrar na nossa API o webhook de cada tipo que irá receber as notificações

Requisição de exemplo

Webhook de transacoes

post

Webhook de PIXs

Authorizations

Body

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

Responses

200

successful

No content

401

authorization failed

422

validation failed

500

unknown server error

post

HTTPcURLJavaScriptPython

POST /internal/api/v1/payments/status HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 795

{
  "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"
}

No content

JSON Retorno Sucesso