Pix in

Base URL: https://api.codespar.dev

Every operation below requires a Bearer token. See Authentication.

GET /v1/consumers/{consumerId}/pix/charges/{reference}

A minted Pix charge's state

Our books for the charge, plus the provider's live state for a PENDING dynamic cob. READ ONLY: this never credits. Crediting stays with the webhook and the reconciler.

reference resolves against three columns: the charge id, the provider transaction id recorded at mint, and the client request id. A value that matches two different charges is 409 rather than an answer for whichever came first.

provider is null in two honest cases, and the difference matters. A charge already settled or expired on our books is terminal here, and a provider consult would add nothing. A static cob carries no identifier the homologated consult accepts, so whether it is still payable cannot be verified at all, and settlement for it can only arrive by webhook.

provider.result: "not_found" is an answer about the COB, not proof the payment never happened. Confirm the payment itself with the receivement query, using the end-to-end id from the payer's receipt, before minting a replacement charge. Minting one on a not-found can bill the payer twice.

Path parameters

Responses

Response 200

curl -X GET https://api.codespar.dev/v1/consumers/{consumerId}/pix/charges/{reference} \
  -H "Authorization: Bearer $CODESPAR_API_KEY"

GET /v1/consumers/{consumerId}/pix/charges/{reference} HTTP/1.1
Host: api.codespar.dev
Authorization: Bearer $CODESPAR_API_KEY

import os
import requests

res = requests.get(
    "https://api.codespar.dev/v1/consumers/{consumerId}/pix/charges/{reference}",
    headers={"Authorization": f"Bearer {os.environ['CODESPAR_API_KEY']}"},
)
res.raise_for_status()
data = res.json()

const res = await fetch("https://api.codespar.dev/v1/consumers/{consumerId}/pix/charges/{reference}", {
  method: "GET",
  headers: {
    Authorization: `Bearer ${process.env.CODESPAR_API_KEY}`,
  },
});

const data = await res.json();

const result = await cs.api.get("/v1/consumers/{consumerId}/pix/charges/{reference}", {
  path: {
    consumerId: "csm_0000000000000000",
    reference: "string"
  }
});

{
  "charge_id": "charge_0000000000000000",
  "status": "string",
  "amount_minor": 1000,
  "currency": "BRL",
  "transaction_id": "transaction_0000000000000000",
  "client_request_id": "clientrequest_0000000000000000",
  "wallet_id": "wlt_0000000000000000",
  "created_at": "2026-01-15T12:00:00.000Z",
  "settled_at": "2026-01-15T12:00:00.000Z",
  "provider": {
    "result": "ok",
    "status": "string",
    "transaction_id": "transaction_0000000000000000",
    "identity_verified": true,
    "last_update": "string",
    "create_at": "string",
    "expiration_seconds": 0,
    "revision": "string"
  },
  "status_message": "string"
}

GET /v1/consumers/{consumerId}/pix/receivements/{endToEndId}

Did this specific Pix land on this consumer's account

Asks the provider about one inbound payment by its end-to-end id and, when it is a receivement on this consumer's OWN account, correlates it to a charge on our books. READ ONLY: this never credits.

The tenant binding is provider truth, not our own record: the answer's credit-party account must equal the account we resolved for this consumer. A mismatch answers exactly the same 404 a genuine miss does, so a bearer end-to-end id cannot become a probe for another tenant's receivements. An answer this backend cannot bind at all, or cannot classify, is 502 rather than a guess in either direction.

A 404 is not proof the payment never arrived. The provider indexes a receivement up to about two minutes after settlement, usually under a minute, so a just-paid Pix can genuinely answer not-found. Retry shortly before concluding anything.

received: false with a provider_transaction_type named is a real answer, not a failure: a movement exists under this id on this account but is not an inbound receivement. A reversal of a Pix the consumer SENT credits the same account and looks like this.

Path parameters

Responses

Response 200

curl -X GET https://api.codespar.dev/v1/consumers/{consumerId}/pix/receivements/{endToEndId} \
  -H "Authorization: Bearer $CODESPAR_API_KEY"

GET /v1/consumers/{consumerId}/pix/receivements/{endToEndId} HTTP/1.1
Host: api.codespar.dev
Authorization: Bearer $CODESPAR_API_KEY

import os
import requests

res = requests.get(
    "https://api.codespar.dev/v1/consumers/{consumerId}/pix/receivements/{endToEndId}",
    headers={"Authorization": f"Bearer {os.environ['CODESPAR_API_KEY']}"},
)
res.raise_for_status()
data = res.json()

const res = await fetch("https://api.codespar.dev/v1/consumers/{consumerId}/pix/receivements/{endToEndId}", {
  method: "GET",
  headers: {
    Authorization: `Bearer ${process.env.CODESPAR_API_KEY}`,
  },
});

const data = await res.json();

const result = await cs.api.get("/v1/consumers/{consumerId}/pix/receivements/{endToEndId}", {
  path: {
    consumerId: "csm_0000000000000000",
    endToEndId: "endtoend_0000000000000000"
  }
});

{
  "end_to_end_id": "endtoend_0000000000000000",
  "received": true,
  "provider_transaction_type": "string",
  "initiation_type": "string",
  "provider_transaction_id": "providertransaction_0000000000000000",
  "transaction_id_brcode": "string",
  "transaction_identification": "string",
  "correlation": "charge_matched",
  "charge_id": "charge_0000000000000000",
  "charge_status": "string",
  "wallet_id": "wlt_0000000000000000",
  "amount_minor": 1000,
  "wallet_credited": true,
  "devolutions": [
    {
      "devolution_id": "devolution_0000000000000000",
      "status": "string",
      "amount_minor": 1000
    }
  ],
  "status_message": "string"
}