Sandbox
Simulação de pagamentos, só com chaves sk_test_.
- POST/v1/test-helpers/charges/{charge_id}/pay · Simular o pagamento de uma cobrança
- POST/v1/test-helpers/in-person-sales · Simular uma venda na maquininha ou no Tap
- POST/v1/test-helpers/charges/{charge_id}/nullify · Simular o estorno de uma venda presencial no aparelho
- POST/v1/test-helpers/payment-links/{payment_link_id}/pay · Simular um pagador concluindo o link de pagamento
Simular o pagamento de uma cobrança
POST/v1/test-helpers/charges/{charge_id}/pay
O resultado chega pelo mesmo caminho de produção (webhook do provedor, confirmação e evento charge.paid).
Parâmetros
- McpfPay-Accountstring · cabeçalho
Obrigatório para chaves de parceiro. Id da conta conectada em nome da qual a operação é feita.
- charge_idobrigatóriostring · caminho
- —
Corpo da requisição (JSON)
- viapix | barcode
Para boleto: pago pelo QR (pix) ou pelo código de barras (barcode).
Códigos de resposta
- 202 Pagamento simulado.
- 403 Sem conexão ativa com a conta, escopo insuficiente ou conta sem a capacidade exigida.
- 404 Recurso não encontrado para esta chave.
Simular uma venda na maquininha ou no Tap
POST/v1/test-helpers/in-person-sales
Cria uma venda aprovada no aparelho da conta e a entrega ao gateway como em produção: aviso do provedor, consulta de confirmação e eventos charge.created e charge.paid com channel. Valor ímpar simula recusa (charge.failed), como no modo de testes do SDK Tap on Phone.
Parâmetros
- McpfPay-Accountstring · cabeçalho
Obrigatório para chaves de parceiro. Id da conta conectada em nome da qual a operação é feita.
Corpo da requisição (JSON)
- channelpos | tap
- —
- typecredit | debit
- —
- amountobrigatóriointeger
Centavos.
- installmentsinteger
Ignorado no débito.
Resposta
- okboolean
- —
- provider_refstring
- —
Códigos de resposta
- 202 Venda simulada.
- 400 Parâmetro ausente ou inválido.
- 403 Sem conexão ativa com a conta, escopo insuficiente ou conta sem a capacidade exigida.
Simular o estorno de uma venda presencial no aparelho
POST/v1/test-helpers/charges/{charge_id}/nullify
O estorno chega como em produção e gera charge.refunded e o lançamento reverso no repasse.
Parâmetros
- McpfPay-Accountstring · cabeçalho
Obrigatório para chaves de parceiro. Id da conta conectada em nome da qual a operação é feita.
- charge_idobrigatóriostring · caminho
- —
Códigos de resposta
- 202 Estorno simulado.
- 403 Sem conexão ativa com a conta, escopo insuficiente ou conta sem a capacidade exigida.
- 404 Recurso não encontrado para esta chave.
- 422 Regra de negócio recusou a operação (limite da conta, valor mínimo de parcela, dados do pagador incompletos).
Simular um pagador concluindo o link de pagamento
POST/v1/test-helpers/payment-links/{payment_link_id}/pay
Parâmetros
- McpfPay-Accountstring · cabeçalho
Obrigatório para chaves de parceiro. Id da conta conectada em nome da qual a operação é feita.
- payment_link_idobrigatóriostring · caminho
- —
Corpo da requisição (JSON)
- methodcard | pix | boleto
- —
- installmentsinteger
- —
Códigos de resposta
- 202 Pagamento simulado; cria a cobrança ligada ao link.
- 403 Sem conexão ativa com a conta, escopo insuficiente ou conta sem a capacidade exigida.
- 404 Recurso não encontrado para esta chave.
- 409 Estado não permite a operação, ou `Idempotency-Key` reutilizada com outro corpo.