Confirmação de Recebimento Pix

Esta página contém o endpoint para processar confirmações de recebimento de Pix.

Confirmação de Recebimento Pix

Endpoint para confirmação do recebimento de recursos por parte do recebedor final via PSP Indireto.

Momento da Confirmação: A confirmação deve ser enviada pelo PSP Indireto após o processamento interno do Pix recebido, confirmando se o valor foi aceito (ACSP) ou rejeitado (RJCT) pelo recebedor final.

Fluxo:

• 1. O PSP Indireto recebe um Pix através do sistema
• 2. Processa internamente a transação
• 3. Confirma o recebimento através deste endpoint
• 4. O sistema envia uma resposta pacs.002 para o BACEN em resposta à pacs.008 recebida.

POST /v1/pix/confirm

Requer autorização para o escopo: pix.ind.read

Requisição

Confirmação de Pix aceito

{
  "pix": [
    {
      "endToEndId": "E123456782025040213339f21230922d",
      "status": "ACSP"
    }
  ]
}

Confirmação de Pix rejeitado

{
  "pix": [
    {
      "endToEndId": "E123456782025040213339f21230922d",
      "status": "RJCT",
      "error": {
        "code": "AC03",
        "reason": "Unable to process payment"
      }
    }
  ]
}

Confirmação de múltiplos Pix

{
  "pix": [
    {
      "endToEndId": "E123456782025040213339f21230922d",
      "status": "ACSP"
    },
    {
      "endToEndId": "E987654322025040213339f21230922a",
      "status": "RJCT",
      "error": {
        "code": "AC03",
        "reason": "Unable to process payment"
      }
    }
  ]
}

Respostas

As respostas abaixo representam Sucesso(200) e Falhas/erros do consumo.

🟢 200

// Confirmação em processamento
{
  "responseTime": 45,
  "correlationId": "01234567-abcd-ef01-2345-6789abcdef01",
  "status": "WAITING"
}

Ou

 // Confirmação processada
{
  "responseTime": 120,
  "correlationId": "01234567-abcd-ef01-2345-6789abcdef01",
  "status": "PROCESSED"
}

🔴 400

// Erro de validação
{
  "responseTime": 13716,
  "correlationId": "0068042d-fb06-4d0c-8639-ebfd774297b3",
  "error": {
    "title": "Validation Error",
    "status": 400,
    "detail": "Given input does not meet the requirements.",
    "extras": [
      {
        "keywork": "maxLength",
        "dataPath": ".pix[1].error.errorDescription",
        "schemaPath": "#/properties/pix/items/properties/error/properties/errorDescription/maxLength",
        "params": {
          "limit": 105
        },
        "message": "should NOT be longer than 105 characters"
      }
    ]
  }
}

Ou

// Status RJCT sem campo error
{
  "responseTime": 89,
  "correlationId": "0068042d-fb06-4d0c-8639-ebfd774297b3",
  "error": {
    "title": "Validation Error",
    "status": 400,
    "detail": "When status is RJCT, error field is required.",
    "extras": [
      {
        "keywork": "required",
        "dataPath": ".pix[0]",
        "schemaPath": "#/properties/pix/items/then/required",
        "params": {
          "missingProperty": "error"
        },
        "message": "should have required property 'error'"
      }
    ]
  }
}

🔴 401

{
  "responseTime": 0,
  "correlationId": "abcdef01-2345-6789-0123-456789012345",
  "error": {
    "detail": "invalid or inactive credentials",
    "status": 401,
    "title": "invalid_client"
  }
}

🔴 403

{
  "responseTime": 0,
  "correlationId": "abcdef01-2345-6789-0123-456789012345",
  "error": {
    "detail": "Participant is not allowed to access this resource",
    "status": 403,
    "title": "Forbidden"
  }
}

🔴 500

{
  "responseTime": 0,
  "correlationId": "abcdef01-2345-6789-0123-456789012345",
  "error": {
    "detail": "Our service is currently experiencing an issue. We apologize for the inconvenience and are working to resolve it as soon as possible.",
    "status": 500,
    "title": "Internal Server Error"
  }
}

🔴 503

{
  "responseTime": 0,
  "correlationId": "abcdef01-2345-6789-0123-456789012345",
  "error": {
    "detail": "Service is under scheduled maintenance",
    "status": 503,
    "title": "Service Unavailable",
    "type": "https://dict.pi.rsfn.net.br/api/v2/error/ServiceUnavailable"
  }
}