Pix Receipt Confirmation

This page contains the endpoint for processing Pix receipt confirmations.

Pix Receipt Confirmation

Endpoint to confirm the receipt of funds by the final receiver via an Indirect PSP.

Timing of Confirmation: The confirmation must be sent by the Indirect PSP after internal processing of the received Pix, indicating whether the amount was accepted (ACSP) or rejected (RJCT) by the final receiver.

Flow:

• 1. The Indirect PSP receives a Pix transaction through the system
• 2. Processes the transaction internally
• 3. Confirms the receipt via this endpoint
• 4. The system sends a pacs.002 response to BACEN in reply to the received pacs.008

POST /v1/pix/confirm

Requires authorization for the scope: pix.ind.read

Request

Pix Accepted Confirmation

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

Pix Rejected Confirmation

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

Multiple Pix Confirmation

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

Responses

The responses below represent Success(201) from the consumption.

🟢 200

// Confirmation in process
{
  "responseTime": 45,
  "correlationId": "01234567-abcd-ef01-2345-6789abcdef01",
  "status": "WAITING"
}

Ou

 // Confirmation processed
{
  "responseTime": 120,
  "correlationId": "01234567-abcd-ef01-2345-6789abcdef01",
  "status": "PROCESSED"
}

🔴 400

// Validation error
{
  "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

// RJCT status without error field
{
  "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"
  }
}