Obter um pagamento

curl -X GET "https://api.chargefy.io/v1/payment-intents/pi_8BMU2HhdEEp4q2Ah?expand[]=payment_method" \
  -H "Authorization: Bearer {{ API_KEY }}"

{
  "id": "pi_8BMU2HhdEEp4q2Ah",
  "object": "payment_intent",
  "amount": 10528,
  "amount_capturable": 0,
  "amount_details": {
    "amount": 10528,
    "installment_interest_amount": 528,
    "principal_amount": 10000,
    "surcharge_amount": 0
  },
  "amount_received": 10528,
  "canceled_at": null,
  "cancellation_reason": null,
  "capture_method": "automatic",
  "client_secret": "pi_8BMU2HhdEEp4q2Ah_secret_a255f702219ae8270e486ebf6b055afc7e22bf9957e45337",
  "confirmation_method": "automatic",
  "created_at": "2026-05-16T18:34:58Z",
  "currency": "brl",
  "customer": "cus_q49b8khTMtC4vST7",
  "installment_interest_amount": 528,
  "installments": 3,
  "invoice": "inv_FBXWDoXymHoCwT7k",
  "last_payment_error": null,
  "latest_charge": "ch_esH7BvdaAdA5iPV9",
  "livemode": true,
  "metadata": {},
  "next_action": null,
  "payment_method": "pm_QDyXhc8tyxS3MPZm",
  "payment_method_options": {
    "credit_card": {
      "installments": {
        "amount": 10528,
        "count": 3,
        "has_interest": true,
        "installment_interest_amount": 528,
        "principal_amount": 10000,
        "surcharge_amount": 0
      }
    }
  },
  "payment_method_types": [
    "credit_card"
  ],
  "principal_amount": 10000,
  "status": "succeeded",
  "surcharge_amount": 0,
  "updated_at": "2026-05-16T18:35:00Z"
}

{
  "error": {
    "code": "authentication_failed",
    "message": "Invalid API key provided.",
    "type": "authentication_error"
  }
}

{
  "error": {
    "code": "resource_missing",
    "message": "Payment intent not found.",
    "type": "invalid_request_error"
  }
}

Retorna o objeto payment_intent pelo ID Chargefy. O campo payment_method retorna o ID do método salvo por padrão. O campo latest_charge retorna o ID da última tentativa de cobrança criada pela confirmação do intent. Use expand[]=payment_method ou expand[]=latest_charge para receber objetos aninhados.

Payment Intent é o documento financeiro de compras avulsas diretas na Chargefy. Use payment.intent.succeeded no webhook para confirmar uma compra avulsa direta — invoices não são criadas para esse fluxo. Cobranças de assinatura têm um Payment Intent vinculado à invoice (invoice.payment_intent).

Autenticação

A API key da própria organização atua diretamente. A API key de plataforma exige o header Organization: <id> apontando para uma organização conectada ativa a essa plataforma.

Parâmetros de caminho

string

required

ID do payment intent (pi_*).

Parâmetros de query

string

Expande referências no objeto retornado.

Valor	Descrição
`payment_method`	Expande o método de pagamento salvo.
`latest_charge`	Expande a última tentativa de cobrança.

curl -X GET "https://api.chargefy.io/v1/payment-intents/pi_8BMU2HhdEEp4q2Ah?expand[]=payment_method" \
  -H "Authorization: Bearer {{ API_KEY }}"

Resposta

{
  "id": "pi_8BMU2HhdEEp4q2Ah",
  "object": "payment_intent",
  "amount": 10528,
  "amount_capturable": 0,
  "amount_details": {
    "amount": 10528,
    "installment_interest_amount": 528,
    "principal_amount": 10000,
    "surcharge_amount": 0
  },
  "amount_received": 10528,
  "canceled_at": null,
  "cancellation_reason": null,
  "capture_method": "automatic",
  "client_secret": "pi_8BMU2HhdEEp4q2Ah_secret_a255f702219ae8270e486ebf6b055afc7e22bf9957e45337",
  "confirmation_method": "automatic",
  "created_at": "2026-05-16T18:34:58Z",
  "currency": "brl",
  "customer": "cus_q49b8khTMtC4vST7",
  "installment_interest_amount": 528,
  "installments": 3,
  "invoice": "inv_FBXWDoXymHoCwT7k",
  "last_payment_error": null,
  "latest_charge": "ch_esH7BvdaAdA5iPV9",
  "livemode": true,
  "metadata": {},
  "next_action": null,
  "payment_method": "pm_QDyXhc8tyxS3MPZm",
  "payment_method_options": {
    "credit_card": {
      "installments": {
        "amount": 10528,
        "count": 3,
        "has_interest": true,
        "installment_interest_amount": 528,
        "principal_amount": 10000,
        "surcharge_amount": 0
      }
    }
  },
  "payment_method_types": [
    "credit_card"
  ],
  "principal_amount": 10000,
  "status": "succeeded",
  "surcharge_amount": 0,
  "updated_at": "2026-05-16T18:35:00Z"
}

{
  "error": {
    "code": "authentication_failed",
    "message": "Invalid API key provided.",
    "type": "authentication_error"
  }
}

{
  "error": {
    "code": "resource_missing",
    "message": "Payment intent not found.",
    "type": "invalid_request_error"
  }
}

Status

Valor	Significado
`requires_payment_method`	Falta método de pagamento.
`requires_confirmation`	Pronto para confirmação/processamento.
`requires_capture`	Autorizado com captura manual; pronto para captura.
`pending`	Aguardando ação do comprador ou confirmação assíncrona.
`processing`	Pagamento em processamento.
`succeeded`	Pagamento concluído.
`failed`	Pagamento falhou.
`canceled`	Pagamento cancelado.

Charges

Uma charge representa uma tentativa de cobrar o payment_intent. Ela é criada pela confirmação do intent e não por uma chamada direta de criação. Um intent pode ter mais de uma charge quando há novas confirmações ou tentativas de pagamento; latest_charge aponta para a tentativa mais recente.

Quando consultar

ao reabrir uma tela de PIX ou cartão;
depois de um timeout na criação, confirmação, captura ou cancelamento;
ao reconciliar um webhook recebido fora de ordem;
quando seu sistema precisa reconstruir o estado após ficar indisponível.

Objeto Payment Intent

Contrato completo dos campos, estados, enums e timestamps.

Integração completa

Como combinar consulta, webhook e estado local sem polling contínuo.

curl -X GET "https://api.chargefy.io/v1/payment-intents/pi_8BMU2HhdEEp4q2Ah?expand[]=payment_method" \
  -H "Authorization: Bearer {{ API_KEY }}"

{
  "id": "pi_8BMU2HhdEEp4q2Ah",
  "object": "payment_intent",
  "amount": 10528,
  "amount_capturable": 0,
  "amount_details": {
    "amount": 10528,
    "installment_interest_amount": 528,
    "principal_amount": 10000,
    "surcharge_amount": 0
  },
  "amount_received": 10528,
  "canceled_at": null,
  "cancellation_reason": null,
  "capture_method": "automatic",
  "client_secret": "pi_8BMU2HhdEEp4q2Ah_secret_a255f702219ae8270e486ebf6b055afc7e22bf9957e45337",
  "confirmation_method": "automatic",
  "created_at": "2026-05-16T18:34:58Z",
  "currency": "brl",
  "customer": "cus_q49b8khTMtC4vST7",
  "installment_interest_amount": 528,
  "installments": 3,
  "invoice": "inv_FBXWDoXymHoCwT7k",
  "last_payment_error": null,
  "latest_charge": "ch_esH7BvdaAdA5iPV9",
  "livemode": true,
  "metadata": {},
  "next_action": null,
  "payment_method": "pm_QDyXhc8tyxS3MPZm",
  "payment_method_options": {
    "credit_card": {
      "installments": {
        "amount": 10528,
        "count": 3,
        "has_interest": true,
        "installment_interest_amount": 528,
        "principal_amount": 10000,
        "surcharge_amount": 0
      }
    }
  },
  "payment_method_types": [
    "credit_card"
  ],
  "principal_amount": 10000,
  "status": "succeeded",
  "surcharge_amount": 0,
  "updated_at": "2026-05-16T18:35:00Z"
}

{
  "error": {
    "code": "authentication_failed",
    "message": "Invalid API key provided.",
    "type": "authentication_error"
  }
}

{
  "error": {
    "code": "resource_missing",
    "message": "Payment intent not found.",
    "type": "invalid_request_error"
  }
}

Fundamentos da API

Objetos de sistema

Webhooks e eventos

SDKs

MCP

Obter um pagamento

Autenticação

Parâmetros de caminho

Parâmetros de query

Resposta

Status

Charges

Quando consultar

Objeto Payment Intent

Integração completa

​Autenticação

​Parâmetros de caminho

​Parâmetros de query

​Resposta

​Status

​Charges

​Quando consultar

Objeto Payment Intent

Integração completa

Autenticação

Parâmetros de caminho

Parâmetros de query

Resposta

Status

Charges

Quando consultar