Introdução
O WebPag é uma solução financeira para empresas de todos os tamanhos. Com ele, você pode gerenciar pagamentos, links de pagamento, recorrências e muito mais. Este é o ponto de partida para você começar a integrar com a nossa API. Se tiver alguma dúvida, entre em contato com o nosso suporte.
O acesso ao API é feito através de uma chave de autenticação. Para obter a sua chave, contate o nosso suporte para mais informações.
Autenticando requisições
Para autenticar as requisições, inclua um cabeçalho auth-token com o valor "{CHAVE_API}".
Todos os endpoints autenticados estão marcados com um rótulo requere autenticação na documentação abaixo.
Contate o nosso suporte para conseguir uma chave API.
Recorrência
Criar recorrência (cartão)
requires authentication
É importante armazenar o "recurrence_code" para utilizar em cancelamentos e atualizações de recorrência.
Para Pix Automático, consulte o grupo PIX Automático — mesmo endpoint com type: "pix_automatic".
Exemplo de Requisição:
$client = new \GuzzleHttp\Client();
$url = 'https://api.webpag.com.br/api/payments/recurrency/register';
$response = $client->post(
$url,
[
'headers' => [
'auth-token' => '{CHAVE_API}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'payer_id' => 881,
'type' => 'card',
'name' => '"Recorrência da Maria"',
'amount' => 9988,
'frequency' => 'monthly',
'start_date' => '"2024-01-01 00:00"',
'installments' => 2,
'card_payer_id' => 1903,
'notify_payer' => true,
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));curl --request POST \
"https://api.webpag.com.br/api/payments/recurrency/register" \
--header "auth-token: {CHAVE_API}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"payer_id\": 881,
\"type\": \"card\",
\"name\": \"\\\"Recorrência da Maria\\\"\",
\"amount\": 9988,
\"frequency\": \"monthly\",
\"start_date\": \"\\\"2024-01-01 00:00\\\"\",
\"installments\": 2,
\"card_payer_id\": 1903,
\"notify_payer\": true
}"
Exemplo de Resposta (200, Recorrência criada):
{
"recurrence_code": "198249294",
"uuid": "a1b2c3d4e5f6g7h8i9j0k1l2m",
"status": "Ativo",
"type": "card",
"payment_id": 12345,
"payment_status": "Pago",
"qrcode_data": null
}
Exemplo de Resposta (422, Regra de negócio):
{
"error": "Pagador não pertence a esta empresa."
}
Resposta recebida:
Requisição falhou com erro:
Dica: Verifique se você está devidamente conectado à rede.
Se você é o mantenedor desta API, verifique se a sua API está em execução e se você habilitou o CORS.
Você pode verificar o console das Ferramentas de Desenvolvedor para informações de depuração.Listar recorrência
requires authentication
Você poderá fornecer os filtros necessários para encontrar a recorrência desejada.
Exemplo de Requisição:
$client = new \GuzzleHttp\Client();
$url = 'https://api.webpag.com.br/api/payments/recurrency/list';
$response = $client->get(
$url,
[
'headers' => [
'auth-token' => '{CHAVE_API}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'payer_id' => '881',
'recurrence_code' => '198249294',
'page' => '1',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));curl --request GET \
--get "https://api.webpag.com.br/api/payments/recurrency/list?payer_id=881&recurrence_code=198249294&page=1" \
--header "auth-token: {CHAVE_API}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"Exemplo de Resposta (200):
{
"data": [
{
"id": 682041,
"payer_id": 249807,
"card_id": null,
"name": "Dr. Boris Altenwerth PhD",
"amount": 671,
"amount_refunded": 0,
"fee_value": "21.97",
"refunded_fee": 0,
"installments": 6,
"is_recurrent": false,
"recurrence_code": 85460990,
"frequency": null,
"method": 10,
"method_label": "Cartão de Crédito",
"method_slug": "credit_card",
"boleto": null,
"notification_url": null,
"installments_paid": 0,
"spplited": false,
"split_without_fee": false,
"soft_descriptor": null,
"order_id": null,
"active": true,
"status": 10,
"status_label": "Aguardando",
"start_date": "2026-03-24 23:55",
"next_date": "2026-09-05 15:41",
"next_recurrence_date": null,
"created_at": "2026-05-11 06:14",
"paid_at": "2026-01-29 07:09",
"updated_at": "2025-11-01 17:54",
"receipt_pdf_path": "https://api.webpag.com.br/payments/01M4V52S296B7RJH9YM5P5JDRS/pdf",
"card_flag": 10,
"card_flag_label": "Amex"
},
{
"id": 682042,
"payer_id": 249808,
"card_id": null,
"name": "Miss Olga Hodkiewicz",
"amount": 811,
"amount_refunded": 0,
"fee_value": "60.28",
"refunded_fee": 0,
"installments": 4,
"is_recurrent": false,
"recurrence_code": 43156930,
"frequency": null,
"method": 10,
"method_label": "Cartão de Crédito",
"method_slug": "credit_card",
"boleto": null,
"notification_url": null,
"installments_paid": 0,
"spplited": false,
"split_without_fee": false,
"soft_descriptor": null,
"order_id": null,
"active": true,
"status": 10,
"status_label": "Aguardando",
"start_date": "2026-04-18 19:45",
"next_date": "2026-03-05 16:57",
"next_recurrence_date": null,
"created_at": "2026-02-11 03:17",
"paid_at": "2026-02-14 09:16",
"updated_at": "2026-02-07 12:52",
"receipt_pdf_path": "https://api.webpag.com.br/payments/01M4V52S2Z4AMT2KW4EWV7KSCM/pdf",
"card_flag": 10,
"card_flag_label": "Amex"
}
]
}
Resposta recebida:
Requisição falhou com erro:
Dica: Verifique se você está devidamente conectado à rede.
Se você é o mantenedor desta API, verifique se a sua API está em execução e se você habilitou o CORS.
Você pode verificar o console das Ferramentas de Desenvolvedor para informações de depuração.Atualizar recorrência
requires authentication
Exemplo de Requisição:
$client = new \GuzzleHttp\Client();
$url = 'https://api.webpag.com.br/api/payments/recurrency/198249294/update';
$response = $client->put(
$url,
[
'headers' => [
'auth-token' => '{CHAVE_API}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'name' => 'Plano Mensal',
'amount' => 5000,
'installments' => 3,
'frequency' => 'monthly',
'card_payer_id' => 1234,
'next_date' => '2024-01-01 00:00',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));curl --request PUT \
"https://api.webpag.com.br/api/payments/recurrency/198249294/update" \
--header "auth-token: {CHAVE_API}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"Plano Mensal\",
\"amount\": 5000,
\"installments\": 3,
\"frequency\": \"monthly\",
\"card_payer_id\": 1234,
\"next_date\": \"2024-01-01 00:00\"
}"
Exemplo de Resposta (200):
{
"data": {
"id": 682043,
"payer_id": 249809,
"card_id": null,
"name": "Sonny Torphy",
"amount": 550,
"amount_refunded": 0,
"fee_value": "45.74",
"refunded_fee": 0,
"installments": 2,
"is_recurrent": false,
"recurrence_code": 85878241,
"frequency": null,
"method": 10,
"method_label": "Cartão de Crédito",
"method_slug": "credit_card",
"boleto": null,
"notification_url": null,
"installments_paid": 0,
"spplited": false,
"split_without_fee": false,
"soft_descriptor": null,
"order_id": null,
"active": true,
"status": 10,
"status_label": "Aguardando",
"start_date": "2026-01-20 21:51",
"next_date": "2026-05-15 13:46",
"next_recurrence_date": null,
"created_at": "2026-06-21 02:20",
"paid_at": "2026-07-05 09:43",
"updated_at": "2025-11-17 02:31",
"receipt_pdf_path": "https://api.webpag.com.br/payments/01M4V52S40KBXH04EFP0GASNBW/pdf",
"card_flag": 10,
"card_flag_label": "Amex"
}
}
Resposta recebida:
Requisição falhou com erro:
Dica: Verifique se você está devidamente conectado à rede.
Se você é o mantenedor desta API, verifique se a sua API está em execução e se você habilitou o CORS.
Você pode verificar o console das Ferramentas de Desenvolvedor para informações de depuração.Cancelar recorrência (cartão)
requires authentication
Para cancelamento de Pix Automático, consulte o grupo PIX Automático — mesmo endpoint.
Exemplo de Requisição:
$client = new \GuzzleHttp\Client();
$url = 'https://api.webpag.com.br/api/payments/recurrency/198249294/cancel';
$response = $client->put(
$url,
[
'headers' => [
'auth-token' => '{CHAVE_API}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));curl --request PUT \
"https://api.webpag.com.br/api/payments/recurrency/198249294/cancel" \
--header "auth-token: {CHAVE_API}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"Exemplo de Resposta (200, Recorrência cancelada):
{
"recurrence_code": "198249294",
"uuid": "a1b2c3d4e5f6g7h8i9j0k1l2m",
"status": "Cancelado",
"type": "card"
}
Exemplo de Resposta (422, Regra de negócio):
{
"error": "Recorrência já está encerrada!"
}
Resposta recebida:
Requisição falhou com erro:
Dica: Verifique se você está devidamente conectado à rede.
Se você é o mantenedor desta API, verifique se a sua API está em execução e se você habilitou o CORS.
Você pode verificar o console das Ferramentas de Desenvolvedor para informações de depuração.PIX Automático
Recorrências via Pix Automático (Banco do Brasil). Utiliza os mesmos endpoints do grupo Recorrência com type: "pix_automatic".
O consentimento permanece Pendente até aprovação do pagador no banco. Ciclos seguintes são cobrados via CobR pelo agendador diário.
Eventos outbound (pix_automatic.approved, pix_automatic.charged, etc.) são enviados para os webhooks cadastrados no painel — não para notification_url.
Criar recorrência Pix Automático
requires authentication
Registra consentimento Pix Automático no Banco do Brasil.
Jornada 3 (charge_first: true, padrão): cob imediata + Pix copia e cola em qrcode_data.
Jornada 2 (charge_first: false): apenas consentimento; primeira cobrança pelo agendador na start_date.
qrcode_data é a string EMV copia e cola — não é imagem base64. Renderize o QR no cliente ou deixe o pagador colar no app do banco.
payment_status reflete o status da primeira cobrança (Jornada 3); use-o para saber se a cob imediata foi paga ou recusada.
Exemplo de Requisição:
$client = new \GuzzleHttp\Client();
$url = 'https://api.webpag.com.br/api/payments/recurrency/register';
$response = $client->post(
$url,
[
'headers' => [
'auth-token' => '{CHAVE_API}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'type' => 'pix_automatic',
'payer_id' => 881,
'name' => 'Assinatura Premium',
'amount' => 9988,
'frequency' => 'monthly',
'start_date' => '2026-07-01 09:00',
'installments' => 12,
'charge_first' => true,
'notification_url' => 'https://example.com/webhooks/pix-automatic',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));curl --request POST \
"https://api.webpag.com.br/api/payments/recurrency/register" \
--header "auth-token: {CHAVE_API}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"type\": \"pix_automatic\",
\"payer_id\": 881,
\"name\": \"Assinatura Premium\",
\"amount\": 9988,
\"frequency\": \"monthly\",
\"start_date\": \"2026-07-01 09:00\",
\"installments\": 12,
\"charge_first\": true,
\"notification_url\": \"https:\\/\\/example.com\\/webhooks\\/pix-automatic\"
}"
Exemplo de Resposta (200, Jornada 3 — consentimento pendente com cob imediata e QR copia e cola.):
{
"recurrence_code": "198249295",
"uuid": "b2c3d4e5f6g7h8i9j0k1l2m3n",
"status": "Pendente",
"type": "pix_automatic",
"payment_id": 12346,
"payment_status": "Aguardando",
"qrcode_data": "00020101021226760014br.gov.bcb.pix2554pix.example.com/qr/v2/cob..."
}
Exemplo de Resposta (200, Jornada 2 — consentimento pendente, sem cob imediata.):
{
"recurrence_code": "198249296",
"uuid": "c3d4e5f6g7h8i9j0k1l2m3n4o",
"status": "Pendente",
"type": "pix_automatic",
"payment_id": null,
"qrcode_data": null
}
Exemplo de Resposta (422, Regra de negócio violada.):
{
"error": "Pagador não pertence a esta empresa."
}
Resposta recebida:
Requisição falhou com erro:
Dica: Verifique se você está devidamente conectado à rede.
Se você é o mantenedor desta API, verifique se a sua API está em execução e se você habilitou o CORS.
Você pode verificar o console das Ferramentas de Desenvolvedor para informações de depuração.Cancelar recorrência Pix Automático
requires authentication
Cancela o consentimento no Banco do Brasil e encerra a recorrência localmente. Mesmo endpoint do grupo Recorrência.
Exemplo de Requisição:
$client = new \GuzzleHttp\Client();
$url = 'https://api.webpag.com.br/api/payments/recurrency/198249295/cancel';
$response = $client->put(
$url,
[
'headers' => [
'auth-token' => '{CHAVE_API}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));curl --request PUT \
"https://api.webpag.com.br/api/payments/recurrency/198249295/cancel" \
--header "auth-token: {CHAVE_API}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"Exemplo de Resposta (200, Recorrência Pix Automático cancelada.):
{
"recurrence_code": "198249295",
"uuid": "b2c3d4e5f6g7h8i9j0k1l2m3n",
"status": "Cancelado",
"type": "pix_automatic"
}
Exemplo de Resposta (422, Regra de negócio violada.):
{
"error": "Recorrência já está encerrada!"
}
Resposta recebida:
Requisição falhou com erro:
Dica: Verifique se você está devidamente conectado à rede.
Se você é o mantenedor desta API, verifique se a sua API está em execução e se você habilitou o CORS.
Você pode verificar o console das Ferramentas de Desenvolvedor para informações de depuração.Crediário
Listar crediários da empresa
requires authentication
Exemplo de Requisição:
$client = new \GuzzleHttp\Client();
$url = 'https://api.webpag.com.br/api/installments';
$response = $client->get(
$url,
[
'headers' => [
'auth-token' => '{CHAVE_API}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'payer_id' => '1',
'page' => '1',
'per_page' => '15',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));curl --request GET \
--get "https://api.webpag.com.br/api/installments?payer_id=1&page=1&per_page=15" \
--header "auth-token: {CHAVE_API}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"Exemplo de Resposta (200):
{
"data": [
{
"id": 1,
"name": "Crediário do(a) Jefferson Souza",
"business_id": 10,
"payer_id": 209,
"number_installments": 10,
"amount_original": "1000.00",
"first_date": "2023-08-29 00:00:00",
"type": 10,
"type_label": "Boleto",
"status": 10,
"status_label": "Ativo",
"accept_after_due_date": null,
"created_at": "2023-07-29 21:56:58",
"updated_at": "2023-07-29 21:56:58",
"payer": {
"id": 209,
"cpf_cnpj": "05920092700",
"is_business": false,
"email": "jefferson@ectechnologies.com.br",
"first_name": "Jefferson",
"last_name": "Souza",
"gender": "M",
"phone_number": "+55 (27) 99578-6767",
"birth_date": "1988-05-11",
"address": null,
"use_boleto": true,
"status": 10,
"status_label": "Ativo",
"created_at": "2023-07-10 21:24:48",
"updated_at": "2023-10-20 15:23:02"
},
"installments": [
{
"id": 1,
"installment_plan_id": 1,
"payment_id": 452,
"code": "64c5b55a31417",
"due_date": "2023-08-29 00:00:00",
"liquidation_date": null,
"payment_info": null,
"number": 1,
"amount": "100.00",
"status": 40,
"status_label": "Cancelado",
"payment": {
"id": 452,
"business": {
"id": 10,
"name": "Empresa deletada"
},
"payer_id": 209,
"card_id": null,
"payer": {
"id": 209,
"cpf_cnpj": "05920092700",
"is_business": false,
"email": "jefferson@ectechnologies.com.br",
"first_name": "Jefferson",
"last_name": "Souza",
"gender": "M",
"phone_number": "+55 (27) 99578-6767",
"birth_date": "1988-05-11",
"address": null,
"use_boleto": true,
"status": 10,
"status_label": "Ativo",
"created_at": "2023-07-10 21:24:48",
"updated_at": "2023-10-20 15:23:02"
},
"name": "1/10 - Crediário #1",
"amount": 10000,
"amount_refunded": 0,
"fee_value": null,
"refunded_fee": 0,
"installments": 1,
"is_recurrent": false,
"recurrence_code": null,
"frequency": null,
"method": 50,
"method_label": "Crediário Boleto",
"method_slug": null,
"boleto": {
"id": 4,
"linha_digitavel": "00190000090341722699499999996178194570000010000",
"sequencial_code": 9999999996,
"nosso_numero": "00034172269999999996",
"codigo_barras": "00191945700000100000000003417226999999999617",
"due_date": "2023-08-29T03:00:00.000000Z",
"issue_date": "2023-07-29T03:00:00.000000Z",
"amount": 100,
"interest": null,
"fine": null,
"accept_after_due_date": null,
"boleto_url": "https://api.webpag.com.br/r/dedf6e7b-950b"
},
"notification_url": null,
"pix": null,
"installments_paid": 0,
"spplited": false,
"split_without_fee": false,
"soft_descriptor": null,
"order_id": null,
"active": true,
"status": 60,
"status_label": "Cancelado",
"start_date": null,
"next_date": null,
"next_recurrence_date": null,
"refunds": [],
"created_at": "2023-07-29 21:56",
"paid_at": null,
"updated_at": "2025-10-13 06:43",
"receipt_pdf_path": "https://api.webpag.com.br/payments/69fdba13f6f8a577c8ebe21d6/pdf",
"card_flag": null,
"card_flag_label": null
}
},
{
"id": 2,
"installment_plan_id": 1,
"payment_id": 453,
"code": "64c5b55a32915",
"due_date": "2023-09-29 00:00:00",
"liquidation_date": null,
"payment_info": null,
"number": 2,
"amount": "100.00",
"status": 40,
"status_label": "Cancelado",
"payment": {
"id": 453,
"business": {
"id": 10,
"name": "Empresa deletada"
},
"payer_id": 209,
"card_id": null,
"payer": {
"id": 209,
"cpf_cnpj": "05920092700",
"is_business": false,
"email": "jefferson@ectechnologies.com.br",
"first_name": "Jefferson",
"last_name": "Souza",
"gender": "M",
"phone_number": "+55 (27) 99578-6767",
"birth_date": "1988-05-11",
"address": null,
"use_boleto": true,
"status": 10,
"status_label": "Ativo",
"created_at": "2023-07-10 21:24:48",
"updated_at": "2023-10-20 15:23:02"
},
"name": "2/10 - Crediário #1",
"amount": 10000,
"amount_refunded": 0,
"fee_value": null,
"refunded_fee": 0,
"installments": 1,
"is_recurrent": false,
"recurrence_code": null,
"frequency": null,
"method": 50,
"method_label": "Crediário Boleto",
"method_slug": null,
"boleto": {
"id": 5,
"linha_digitavel": "00190000090341722699499999995170294880000010000",
"sequencial_code": 9999999995,
"nosso_numero": "00034172269999999995",
"codigo_barras": "00192948800000100000000003417226999999999517",
"due_date": "2023-09-29T03:00:00.000000Z",
"issue_date": "2023-07-29T03:00:00.000000Z",
"amount": 100,
"interest": null,
"fine": null,
"accept_after_due_date": null,
"boleto_url": "https://api.webpag.com.br/r/97489a4a-73b9"
},
"notification_url": null,
"pix": null,
"installments_paid": 0,
"spplited": false,
"split_without_fee": false,
"soft_descriptor": null,
"order_id": null,
"active": true,
"status": 60,
"status_label": "Cancelado",
"start_date": null,
"next_date": null,
"next_recurrence_date": null,
"refunds": [],
"created_at": "2023-07-29 21:57",
"paid_at": null,
"updated_at": "2025-10-13 06:43",
"receipt_pdf_path": "https://api.webpag.com.br/payments/a53782e2d80f8b5c982716d1f/pdf",
"card_flag": null,
"card_flag_label": null
}
},
{
"id": 3,
"installment_plan_id": 1,
"payment_id": 454,
"code": "64c5b55a33b18",
"due_date": "2023-10-29 00:00:00",
"liquidation_date": null,
"payment_info": null,
"number": 3,
"amount": "100.00",
"status": 40,
"status_label": "Cancelado",
"payment": {
"id": 454,
"business": {
"id": 10,
"name": "Empresa deletada"
},
"payer_id": 209,
"card_id": null,
"payer": {
"id": 209,
"cpf_cnpj": "05920092700",
"is_business": false,
"email": "jefferson@ectechnologies.com.br",
"first_name": "Jefferson",
"last_name": "Souza",
"gender": "M",
"phone_number": "+55 (27) 99578-6767",
"birth_date": "1988-05-11",
"address": null,
"use_boleto": true,
"status": 10,
"status_label": "Ativo",
"created_at": "2023-07-10 21:24:48",
"updated_at": "2023-10-20 15:23:02"
},
"name": "3/10 - Crediário #1",
"amount": 10000,
"amount_refunded": 0,
"fee_value": null,
"refunded_fee": 0,
"installments": 1,
"is_recurrent": false,
"recurrence_code": null,
"frequency": null,
"method": 50,
"method_label": "Crediário Boleto",
"method_slug": null,
"boleto": {
"id": 6,
"linha_digitavel": "00190000090341722699499999994173895180000010000",
"sequencial_code": 9999999994,
"nosso_numero": "00034172269999999994",
"codigo_barras": "00198951800000100000000003417226999999999417",
"due_date": "2023-10-29T03:00:00.000000Z",
"issue_date": "2023-07-29T03:00:00.000000Z",
"amount": 100,
"interest": null,
"fine": null,
"accept_after_due_date": null,
"boleto_url": "https://api.webpag.com.br/r/704f4ca5-f096"
},
"notification_url": null,
"pix": null,
"installments_paid": 0,
"spplited": false,
"split_without_fee": false,
"soft_descriptor": null,
"order_id": null,
"active": true,
"status": 60,
"status_label": "Cancelado",
"start_date": null,
"next_date": null,
"next_recurrence_date": null,
"refunds": [],
"created_at": "2023-07-29 21:57",
"paid_at": null,
"updated_at": "2025-10-13 06:43",
"receipt_pdf_path": "https://api.webpag.com.br/payments/39887ec8745459963897afa7f/pdf",
"card_flag": null,
"card_flag_label": null
}
},
{
"id": 4,
"installment_plan_id": 1,
"payment_id": 455,
"code": "64c5b55a353e4",
"due_date": "2023-11-29 00:00:00",
"liquidation_date": null,
"payment_info": null,
"number": 4,
"amount": "100.00",
"status": 40,
"status_label": "Cancelado",
"payment": {
"id": 455,
"business": {
"id": 10,
"name": "Empresa deletada"
},
"payer_id": 209,
"card_id": null,
"payer": {
"id": 209,
"cpf_cnpj": "05920092700",
"is_business": false,
"email": "jefferson@ectechnologies.com.br",
"first_name": "Jefferson",
"last_name": "Souza",
"gender": "M",
"phone_number": "+55 (27) 99578-6767",
"birth_date": "1988-05-11",
"address": null,
"use_boleto": true,
"status": 10,
"status_label": "Ativo",
"created_at": "2023-07-10 21:24:48",
"updated_at": "2023-10-20 15:23:02"
},
"name": "4/10 - Crediário #1",
"amount": 10000,
"amount_refunded": 0,
"fee_value": null,
"refunded_fee": 0,
"installments": 1,
"is_recurrent": false,
"recurrence_code": null,
"frequency": null,
"method": 50,
"method_label": "Crediário Boleto",
"method_slug": null,
"boleto": {
"id": 7,
"linha_digitavel": "00190000090341722699499999993175195490000010000",
"sequencial_code": 9999999993,
"nosso_numero": "00034172269999999993",
"codigo_barras": "00191954900000100000000003417226999999999317",
"due_date": "2023-11-29T03:00:00.000000Z",
"issue_date": "2023-07-29T03:00:00.000000Z",
"amount": 100,
"interest": null,
"fine": null,
"accept_after_due_date": null,
"boleto_url": "https://api.webpag.com.br/r/bf3bea52-9d28"
},
"notification_url": null,
"pix": null,
"installments_paid": 0,
"spplited": false,
"split_without_fee": false,
"soft_descriptor": null,
"order_id": null,
"active": true,
"status": 60,
"status_label": "Cancelado",
"start_date": null,
"next_date": null,
"next_recurrence_date": null,
"refunds": [],
"created_at": "2023-07-29 21:57",
"paid_at": null,
"updated_at": "2025-10-13 06:43",
"receipt_pdf_path": "https://api.webpag.com.br/payments/6eeb21929f81c90f23da423b9/pdf",
"card_flag": null,
"card_flag_label": null
}
},
{
"id": 5,
"installment_plan_id": 1,
"payment_id": 456,
"code": "64c5b55a36320",
"due_date": "2023-12-29 00:00:00",
"liquidation_date": null,
"payment_info": null,
"number": 5,
"amount": "100.00",
"status": 40,
"status_label": "Cancelado",
"payment": {
"id": 456,
"business": {
"id": 10,
"name": "Empresa deletada"
},
"payer_id": 209,
"card_id": null,
"payer": {
"id": 209,
"cpf_cnpj": "05920092700",
"is_business": false,
"email": "jefferson@ectechnologies.com.br",
"first_name": "Jefferson",
"last_name": "Souza",
"gender": "M",
"phone_number": "+55 (27) 99578-6767",
"birth_date": "1988-05-11",
"address": null,
"use_boleto": true,
"status": 10,
"status_label": "Ativo",
"created_at": "2023-07-10 21:24:48",
"updated_at": "2023-10-20 15:23:02"
},
"name": "5/10 - Crediário #1",
"amount": 10000,
"amount_refunded": 0,
"fee_value": null,
"refunded_fee": 0,
"installments": 1,
"is_recurrent": false,
"recurrence_code": null,
"frequency": null,
"method": 50,
"method_label": "Crediário Boleto",
"method_slug": null,
"boleto": {
"id": 8,
"linha_digitavel": "00190000090341722699499999992177895790000010000",
"sequencial_code": 9999999992,
"nosso_numero": "00034172269999999992",
"codigo_barras": "00198957900000100000000003417226999999999217",
"due_date": "2023-12-29T03:00:00.000000Z",
"issue_date": "2023-07-29T03:00:00.000000Z",
"amount": 100,
"interest": null,
"fine": null,
"accept_after_due_date": null,
"boleto_url": "https://api.webpag.com.br/r/69e845ec-39f4"
},
"notification_url": null,
"pix": null,
"installments_paid": 0,
"spplited": false,
"split_without_fee": false,
"soft_descriptor": null,
"order_id": null,
"active": true,
"status": 60,
"status_label": "Cancelado",
"start_date": null,
"next_date": null,
"next_recurrence_date": null,
"refunds": [],
"created_at": "2023-07-29 21:57",
"paid_at": null,
"updated_at": "2025-10-13 06:43",
"receipt_pdf_path": "https://api.webpag.com.br/payments/6633ac8ea9615b48e5336f0c9/pdf",
"card_flag": null,
"card_flag_label": null
}
},
{
"id": 6,
"installment_plan_id": 1,
"payment_id": 457,
"code": "64c5b55a3733f",
"due_date": "2024-01-29 00:00:00",
"liquidation_date": null,
"payment_info": null,
"number": 6,
"amount": "100.00",
"status": 40,
"status_label": "Cancelado",
"payment": {
"id": 457,
"business": {
"id": 10,
"name": "Empresa deletada"
},
"payer_id": 209,
"card_id": null,
"payer": {
"id": 209,
"cpf_cnpj": "05920092700",
"is_business": false,
"email": "jefferson@ectechnologies.com.br",
"first_name": "Jefferson",
"last_name": "Souza",
"gender": "M",
"phone_number": "+55 (27) 99578-6767",
"birth_date": "1988-05-11",
"address": null,
"use_boleto": true,
"status": 10,
"status_label": "Ativo",
"created_at": "2023-07-10 21:24:48",
"updated_at": "2023-10-20 15:23:02"
},
"name": "6/10 - Crediário #1",
"amount": 10000,
"amount_refunded": 0,
"fee_value": null,
"refunded_fee": 0,
"installments": 1,
"is_recurrent": false,
"recurrence_code": null,
"frequency": null,
"method": 50,
"method_label": "Crediário Boleto",
"method_slug": null,
"boleto": {
"id": 9,
"linha_digitavel": "00190000090341722699499999991179996100000010000",
"sequencial_code": 9999999991,
"nosso_numero": "00034172269999999991",
"codigo_barras": "00199961000000100000000003417226999999999117",
"due_date": "2024-01-29T03:00:00.000000Z",
"issue_date": "2023-07-29T03:00:00.000000Z",
"amount": 100,
"interest": null,
"fine": null,
"accept_after_due_date": null,
"boleto_url": "https://api.webpag.com.br/r/9501ed28-17df"
},
"notification_url": null,
"pix": null,
"installments_paid": 0,
"spplited": false,
"split_without_fee": false,
"soft_descriptor": null,
"order_id": null,
"active": true,
"status": 60,
"status_label": "Cancelado",
"start_date": null,
"next_date": null,
"next_recurrence_date": null,
"refunds": [],
"created_at": "2023-07-29 21:57",
"paid_at": null,
"updated_at": "2025-10-13 06:43",
"receipt_pdf_path": "https://api.webpag.com.br/payments/b058cab9327727c397921a743/pdf",
"card_flag": null,
"card_flag_label": null
}
},
{
"id": 7,
"installment_plan_id": 1,
"payment_id": 458,
"code": "64c5b55a3a029",
"due_date": "2024-02-29 00:00:00",
"liquidation_date": null,
"payment_info": null,
"number": 7,
"amount": "100.00",
"status": 40,
"status_label": "Cancelado",
"payment": {
"id": 458,
"business": {
"id": 10,
"name": "Empresa deletada"
},
"payer_id": 209,
"card_id": null,
"payer": {
"id": 209,
"cpf_cnpj": "05920092700",
"is_business": false,
"email": "jefferson@ectechnologies.com.br",
"first_name": "Jefferson",
"last_name": "Souza",
"gender": "M",
"phone_number": "+55 (27) 99578-6767",
"birth_date": "1988-05-11",
"address": null,
"use_boleto": true,
"status": 10,
"status_label": "Ativo",
"created_at": "2023-07-10 21:24:48",
"updated_at": "2023-10-20 15:23:02"
},
"name": "7/10 - Crediário #1",
"amount": 10000,
"amount_refunded": 0,
"fee_value": null,
"refunded_fee": 0,
"installments": 1,
"is_recurrent": false,
"recurrence_code": null,
"frequency": null,
"method": 50,
"method_label": "Crediário Boleto",
"method_slug": null,
"boleto": {
"id": 10,
"linha_digitavel": "00190000090341722699499999990171196410000010000",
"sequencial_code": 9999999990,
"nosso_numero": "00034172269999999990",
"codigo_barras": "00191964100000100000000003417226999999999017",
"due_date": "2024-02-29T03:00:00.000000Z",
"issue_date": "2023-07-29T03:00:00.000000Z",
"amount": 100,
"interest": null,
"fine": null,
"accept_after_due_date": null,
"boleto_url": "https://api.webpag.com.br/r/97915983-5822"
},
"notification_url": null,
"pix": null,
"installments_paid": 0,
"spplited": false,
"split_without_fee": false,
"soft_descriptor": null,
"order_id": null,
"active": true,
"status": 60,
"status_label": "Cancelado",
"start_date": null,
"next_date": null,
"next_recurrence_date": null,
"refunds": [],
"created_at": "2023-07-29 21:57",
"paid_at": null,
"updated_at": "2025-10-13 06:43",
"receipt_pdf_path": "https://api.webpag.com.br/payments/7fa920445ed2a3846c06af665/pdf",
"card_flag": null,
"card_flag_label": null
}
},
{
"id": 8,
"installment_plan_id": 1,
"payment_id": 459,
"code": "64c5b55a3b2b9",
"due_date": "2024-03-29 00:00:00",
"liquidation_date": null,
"payment_info": null,
"number": 8,
"amount": "100.00",
"status": 40,
"status_label": "Cancelado",
"payment": {
"id": 459,
"business": {
"id": 10,
"name": "Empresa deletada"
},
"payer_id": 209,
"card_id": null,
"payer": {
"id": 209,
"cpf_cnpj": "05920092700",
"is_business": false,
"email": "jefferson@ectechnologies.com.br",
"first_name": "Jefferson",
"last_name": "Souza",
"gender": "M",
"phone_number": "+55 (27) 99578-6767",
"birth_date": "1988-05-11",
"address": null,
"use_boleto": true,
"status": 10,
"status_label": "Ativo",
"created_at": "2023-07-10 21:24:48",
"updated_at": "2023-10-20 15:23:02"
},
"name": "8/10 - Crediário #1",
"amount": 10000,
"amount_refunded": 0,
"fee_value": null,
"refunded_fee": 0,
"installments": 1,
"is_recurrent": false,
"recurrence_code": null,
"frequency": null,
"method": 50,
"method_label": "Crediário Boleto",
"method_slug": null,
"boleto": {
"id": 11,
"linha_digitavel": "00190000090341722699499999989173196700000010000",
"sequencial_code": 9999999989,
"nosso_numero": "00034172269999999989",
"codigo_barras": "00191967000000100000000003417226999999998917",
"due_date": "2024-03-29T03:00:00.000000Z",
"issue_date": "2023-07-29T03:00:00.000000Z",
"amount": 100,
"interest": null,
"fine": null,
"accept_after_due_date": null,
"boleto_url": "https://api.webpag.com.br/r/42b79469-f29a"
},
"notification_url": null,
"pix": null,
"installments_paid": 0,
"spplited": false,
"split_without_fee": false,
"soft_descriptor": null,
"order_id": null,
"active": true,
"status": 60,
"status_label": "Cancelado",
"start_date": null,
"next_date": null,
"next_recurrence_date": null,
"refunds": [],
"created_at": "2023-07-29 21:57",
"paid_at": null,
"updated_at": "2025-10-13 06:43",
"receipt_pdf_path": "https://api.webpag.com.br/payments/56fca9d74f377a6f148db3dcf/pdf",
"card_flag": null,
"card_flag_label": null
}
},
{
"id": 9,
"installment_plan_id": 1,
"payment_id": 460,
"code": "64c5b55a3c463",
"due_date": "2024-04-29 00:00:00",
"liquidation_date": null,
"payment_info": null,
"number": 9,
"amount": "100.00",
"status": 40,
"status_label": "Cancelado",
"payment": {
"id": 460,
"business": {
"id": 10,
"name": "Empresa deletada"
},
"payer_id": 209,
"card_id": null,
"payer": {
"id": 209,
"cpf_cnpj": "05920092700",
"is_business": false,
"email": "jefferson@ectechnologies.com.br",
"first_name": "Jefferson",
"last_name": "Souza",
"gender": "M",
"phone_number": "+55 (27) 99578-6767",
"birth_date": "1988-05-11",
"address": null,
"use_boleto": true,
"status": 10,
"status_label": "Ativo",
"created_at": "2023-07-10 21:24:48",
"updated_at": "2023-10-20 15:23:02"
},
"name": "9/10 - Crediário #1",
"amount": 10000,
"amount_refunded": 0,
"fee_value": null,
"refunded_fee": 0,
"installments": 1,
"is_recurrent": false,
"recurrence_code": null,
"frequency": null,
"method": 50,
"method_label": "Crediário Boleto",
"method_slug": null,
"boleto": {
"id": 12,
"linha_digitavel": "00190000090341722699499999988175297010000010000",
"sequencial_code": 9999999988,
"nosso_numero": "00034172269999999988",
"codigo_barras": "00192970100000100000000003417226999999998817",
"due_date": "2024-04-29T03:00:00.000000Z",
"issue_date": "2023-07-29T03:00:00.000000Z",
"amount": 100,
"interest": null,
"fine": null,
"accept_after_due_date": null,
"boleto_url": "https://api.webpag.com.br/r/2046481d-165f"
},
"notification_url": null,
"pix": null,
"installments_paid": 0,
"spplited": false,
"split_without_fee": false,
"soft_descriptor": null,
"order_id": null,
"active": true,
"status": 60,
"status_label": "Cancelado",
"start_date": null,
"next_date": null,
"next_recurrence_date": null,
"refunds": [],
"created_at": "2023-07-29 21:57",
"paid_at": null,
"updated_at": "2025-10-13 06:43",
"receipt_pdf_path": "https://api.webpag.com.br/payments/0577bbc9ae8d32f9280e3f4d3/pdf",
"card_flag": null,
"card_flag_label": null
}
},
{
"id": 10,
"installment_plan_id": 1,
"payment_id": 461,
"code": "64c5b55a3d787",
"due_date": "2024-05-29 00:00:00",
"liquidation_date": null,
"payment_info": null,
"number": 10,
"amount": "100.00",
"status": 40,
"status_label": "Cancelado",
"payment": {
"id": 461,
"business": {
"id": 10,
"name": "Empresa deletada"
},
"payer_id": 209,
"card_id": null,
"payer": {
"id": 209,
"cpf_cnpj": "05920092700",
"is_business": false,
"email": "jefferson@ectechnologies.com.br",
"first_name": "Jefferson",
"last_name": "Souza",
"gender": "M",
"phone_number": "+55 (27) 99578-6767",
"birth_date": "1988-05-11",
"address": null,
"use_boleto": true,
"status": 10,
"status_label": "Ativo",
"created_at": "2023-07-10 21:24:48",
"updated_at": "2023-10-20 15:23:02"
},
"name": "10/10 - Crediário #1",
"amount": 10000,
"amount_refunded": 0,
"fee_value": null,
"refunded_fee": 0,
"installments": 1,
"is_recurrent": false,
"recurrence_code": null,
"frequency": null,
"method": 50,
"method_label": "Crediário Boleto",
"method_slug": null,
"boleto": {
"id": 13,
"linha_digitavel": "00190000090341722699499999987177197310000010000",
"sequencial_code": 9999999987,
"nosso_numero": "00034172269999999987",
"codigo_barras": "00191973100000100000000003417226999999998717",
"due_date": "2024-05-29T03:00:00.000000Z",
"issue_date": "2023-07-29T03:00:00.000000Z",
"amount": 100,
"interest": null,
"fine": null,
"accept_after_due_date": null,
"boleto_url": "https://api.webpag.com.br/r/c2f602fe-4a15"
},
"notification_url": null,
"pix": null,
"installments_paid": 0,
"spplited": false,
"split_without_fee": false,
"soft_descriptor": null,
"order_id": null,
"active": true,
"status": 60,
"status_label": "Cancelado",
"start_date": null,
"next_date": null,
"next_recurrence_date": null,
"refunds": [],
"created_at": "2023-07-29 21:57",
"paid_at": null,
"updated_at": "2025-10-13 06:43",
"receipt_pdf_path": "https://api.webpag.com.br/payments/4dd4462d29799375f740c06e5/pdf",
"card_flag": null,
"card_flag_label": null
}
}
]
},
{
"id": 1,
"name": "Crediário do(a) Jefferson Souza",
"business_id": 10,
"payer_id": 209,
"number_installments": 10,
"amount_original": "1000.00",
"first_date": "2023-08-29 00:00:00",
"type": 10,
"type_label": "Boleto",
"status": 10,
"status_label": "Ativo",
"accept_after_due_date": null,
"created_at": "2023-07-29 21:56:58",
"updated_at": "2023-07-29 21:56:58",
"payer": {
"id": 209,
"cpf_cnpj": "05920092700",
"is_business": false,
"email": "jefferson@ectechnologies.com.br",
"first_name": "Jefferson",
"last_name": "Souza",
"gender": "M",
"phone_number": "+55 (27) 99578-6767",
"birth_date": "1988-05-11",
"address": null,
"use_boleto": true,
"status": 10,
"status_label": "Ativo",
"created_at": "2023-07-10 21:24:48",
"updated_at": "2023-10-20 15:23:02"
},
"installments": [
{
"id": 1,
"installment_plan_id": 1,
"payment_id": 452,
"code": "64c5b55a31417",
"due_date": "2023-08-29 00:00:00",
"liquidation_date": null,
"payment_info": null,
"number": 1,
"amount": "100.00",
"status": 40,
"status_label": "Cancelado",
"payment": {
"id": 452,
"business": {
"id": 10,
"name": "Empresa deletada"
},
"payer_id": 209,
"card_id": null,
"payer": {
"id": 209,
"cpf_cnpj": "05920092700",
"is_business": false,
"email": "jefferson@ectechnologies.com.br",
"first_name": "Jefferson",
"last_name": "Souza",
"gender": "M",
"phone_number": "+55 (27) 99578-6767",
"birth_date": "1988-05-11",
"address": null,
"use_boleto": true,
"status": 10,
"status_label": "Ativo",
"created_at": "2023-07-10 21:24:48",
"updated_at": "2023-10-20 15:23:02"
},
"name": "1/10 - Crediário #1",
"amount": 10000,
"amount_refunded": 0,
"fee_value": null,
"refunded_fee": 0,
"installments": 1,
"is_recurrent": false,
"recurrence_code": null,
"frequency": null,
"method": 50,
"method_label": "Crediário Boleto",
"method_slug": null,
"boleto": {
"id": 4,
"linha_digitavel": "00190000090341722699499999996178194570000010000",
"sequencial_code": 9999999996,
"nosso_numero": "00034172269999999996",
"codigo_barras": "00191945700000100000000003417226999999999617",
"due_date": "2023-08-29T03:00:00.000000Z",
"issue_date": "2023-07-29T03:00:00.000000Z",
"amount": 100,
"interest": null,
"fine": null,
"accept_after_due_date": null,
"boleto_url": "https://api.webpag.com.br/r/dedf6e7b-950b"
},
"notification_url": null,
"pix": null,
"installments_paid": 0,
"spplited": false,
"split_without_fee": false,
"soft_descriptor": null,
"order_id": null,
"active": true,
"status": 60,
"status_label": "Cancelado",
"start_date": null,
"next_date": null,
"next_recurrence_date": null,
"refunds": [],
"created_at": "2023-07-29 21:56",
"paid_at": null,
"updated_at": "2025-10-13 06:43",
"receipt_pdf_path": "https://api.webpag.com.br/payments/69fdba13f6f8a577c8ebe21d6/pdf",
"card_flag": null,
"card_flag_label": null
}
},
{
"id": 2,
"installment_plan_id": 1,
"payment_id": 453,
"code": "64c5b55a32915",
"due_date": "2023-09-29 00:00:00",
"liquidation_date": null,
"payment_info": null,
"number": 2,
"amount": "100.00",
"status": 40,
"status_label": "Cancelado",
"payment": {
"id": 453,
"business": {
"id": 10,
"name": "Empresa deletada"
},
"payer_id": 209,
"card_id": null,
"payer": {
"id": 209,
"cpf_cnpj": "05920092700",
"is_business": false,
"email": "jefferson@ectechnologies.com.br",
"first_name": "Jefferson",
"last_name": "Souza",
"gender": "M",
"phone_number": "+55 (27) 99578-6767",
"birth_date": "1988-05-11",
"address": null,
"use_boleto": true,
"status": 10,
"status_label": "Ativo",
"created_at": "2023-07-10 21:24:48",
"updated_at": "2023-10-20 15:23:02"
},
"name": "2/10 - Crediário #1",
"amount": 10000,
"amount_refunded": 0,
"fee_value": null,
"refunded_fee": 0,
"installments": 1,
"is_recurrent": false,
"recurrence_code": null,
"frequency": null,
"method": 50,
"method_label": "Crediário Boleto",
"method_slug": null,
"boleto": {
"id": 5,
"linha_digitavel": "00190000090341722699499999995170294880000010000",
"sequencial_code": 9999999995,
"nosso_numero": "00034172269999999995",
"codigo_barras": "00192948800000100000000003417226999999999517",
"due_date": "2023-09-29T03:00:00.000000Z",
"issue_date": "2023-07-29T03:00:00.000000Z",
"amount": 100,
"interest": null,
"fine": null,
"accept_after_due_date": null,
"boleto_url": "https://api.webpag.com.br/r/97489a4a-73b9"
},
"notification_url": null,
"pix": null,
"installments_paid": 0,
"spplited": false,
"split_without_fee": false,
"soft_descriptor": null,
"order_id": null,
"active": true,
"status": 60,
"status_label": "Cancelado",
"start_date": null,
"next_date": null,
"next_recurrence_date": null,
"refunds": [],
"created_at": "2023-07-29 21:57",
"paid_at": null,
"updated_at": "2025-10-13 06:43",
"receipt_pdf_path": "https://api.webpag.com.br/payments/a53782e2d80f8b5c982716d1f/pdf",
"card_flag": null,
"card_flag_label": null
}
},
{
"id": 3,
"installment_plan_id": 1,
"payment_id": 454,
"code": "64c5b55a33b18",
"due_date": "2023-10-29 00:00:00",
"liquidation_date": null,
"payment_info": null,
"number": 3,
"amount": "100.00",
"status": 40,
"status_label": "Cancelado",
"payment": {
"id": 454,
"business": {
"id": 10,
"name": "Empresa deletada"
},
"payer_id": 209,
"card_id": null,
"payer": {
"id": 209,
"cpf_cnpj": "05920092700",
"is_business": false,
"email": "jefferson@ectechnologies.com.br",
"first_name": "Jefferson",
"last_name": "Souza",
"gender": "M",
"phone_number": "+55 (27) 99578-6767",
"birth_date": "1988-05-11",
"address": null,
"use_boleto": true,
"status": 10,
"status_label": "Ativo",
"created_at": "2023-07-10 21:24:48",
"updated_at": "2023-10-20 15:23:02"
},
"name": "3/10 - Crediário #1",
"amount": 10000,
"amount_refunded": 0,
"fee_value": null,
"refunded_fee": 0,
"installments": 1,
"is_recurrent": false,
"recurrence_code": null,
"frequency": null,
"method": 50,
"method_label": "Crediário Boleto",
"method_slug": null,
"boleto": {
"id": 6,
"linha_digitavel": "00190000090341722699499999994173895180000010000",
"sequencial_code": 9999999994,
"nosso_numero": "00034172269999999994",
"codigo_barras": "00198951800000100000000003417226999999999417",
"due_date": "2023-10-29T03:00:00.000000Z",
"issue_date": "2023-07-29T03:00:00.000000Z",
"amount": 100,
"interest": null,
"fine": null,
"accept_after_due_date": null,
"boleto_url": "https://api.webpag.com.br/r/704f4ca5-f096"
},
"notification_url": null,
"pix": null,
"installments_paid": 0,
"spplited": false,
"split_without_fee": false,
"soft_descriptor": null,
"order_id": null,
"active": true,
"status": 60,
"status_label": "Cancelado",
"start_date": null,
"next_date": null,
"next_recurrence_date": null,
"refunds": [],
"created_at": "2023-07-29 21:57",
"paid_at": null,
"updated_at": "2025-10-13 06:43",
"receipt_pdf_path": "https://api.webpag.com.br/payments/39887ec8745459963897afa7f/pdf",
"card_flag": null,
"card_flag_label": null
}
},
{
"id": 4,
"installment_plan_id": 1,
"payment_id": 455,
"code": "64c5b55a353e4",
"due_date": "2023-11-29 00:00:00",
"liquidation_date": null,
"payment_info": null,
"number": 4,
"amount": "100.00",
"status": 40,
"status_label": "Cancelado",
"payment": {
"id": 455,
"business": {
"id": 10,
"name": "Empresa deletada"
},
"payer_id": 209,
"card_id": null,
"payer": {
"id": 209,
"cpf_cnpj": "05920092700",
"is_business": false,
"email": "jefferson@ectechnologies.com.br",
"first_name": "Jefferson",
"last_name": "Souza",
"gender": "M",
"phone_number": "+55 (27) 99578-6767",
"birth_date": "1988-05-11",
"address": null,
"use_boleto": true,
"status": 10,
"status_label": "Ativo",
"created_at": "2023-07-10 21:24:48",
"updated_at": "2023-10-20 15:23:02"
},
"name": "4/10 - Crediário #1",
"amount": 10000,
"amount_refunded": 0,
"fee_value": null,
"refunded_fee": 0,
"installments": 1,
"is_recurrent": false,
"recurrence_code": null,
"frequency": null,
"method": 50,
"method_label": "Crediário Boleto",
"method_slug": null,
"boleto": {
"id": 7,
"linha_digitavel": "00190000090341722699499999993175195490000010000",
"sequencial_code": 9999999993,
"nosso_numero": "00034172269999999993",
"codigo_barras": "00191954900000100000000003417226999999999317",
"due_date": "2023-11-29T03:00:00.000000Z",
"issue_date": "2023-07-29T03:00:00.000000Z",
"amount": 100,
"interest": null,
"fine": null,
"accept_after_due_date": null,
"boleto_url": "https://api.webpag.com.br/r/bf3bea52-9d28"
},
"notification_url": null,
"pix": null,
"installments_paid": 0,
"spplited": false,
"split_without_fee": false,
"soft_descriptor": null,
"order_id": null,
"active": true,
"status": 60,
"status_label": "Cancelado",
"start_date": null,
"next_date": null,
"next_recurrence_date": null,
"refunds": [],
"created_at": "2023-07-29 21:57",
"paid_at": null,
"updated_at": "2025-10-13 06:43",
"receipt_pdf_path": "https://api.webpag.com.br/payments/6eeb21929f81c90f23da423b9/pdf",
"card_flag": null,
"card_flag_label": null
}
},
{
"id": 5,
"installment_plan_id": 1,
"payment_id": 456,
"code": "64c5b55a36320",
"due_date": "2023-12-29 00:00:00",
"liquidation_date": null,
"payment_info": null,
"number": 5,
"amount": "100.00",
"status": 40,
"status_label": "Cancelado",
"payment": {
"id": 456,
"business": {
"id": 10,
"name": "Empresa deletada"
},
"payer_id": 209,
"card_id": null,
"payer": {
"id": 209,
"cpf_cnpj": "05920092700",
"is_business": false,
"email": "jefferson@ectechnologies.com.br",
"first_name": "Jefferson",
"last_name": "Souza",
"gender": "M",
"phone_number": "+55 (27) 99578-6767",
"birth_date": "1988-05-11",
"address": null,
"use_boleto": true,
"status": 10,
"status_label": "Ativo",
"created_at": "2023-07-10 21:24:48",
"updated_at": "2023-10-20 15:23:02"
},
"name": "5/10 - Crediário #1",
"amount": 10000,
"amount_refunded": 0,
"fee_value": null,
"refunded_fee": 0,
"installments": 1,
"is_recurrent": false,
"recurrence_code": null,
"frequency": null,
"method": 50,
"method_label": "Crediário Boleto",
"method_slug": null,
"boleto": {
"id": 8,
"linha_digitavel": "00190000090341722699499999992177895790000010000",
"sequencial_code": 9999999992,
"nosso_numero": "00034172269999999992",
"codigo_barras": "00198957900000100000000003417226999999999217",
"due_date": "2023-12-29T03:00:00.000000Z",
"issue_date": "2023-07-29T03:00:00.000000Z",
"amount": 100,
"interest": null,
"fine": null,
"accept_after_due_date": null,
"boleto_url": "https://api.webpag.com.br/r/69e845ec-39f4"
},
"notification_url": null,
"pix": null,
"installments_paid": 0,
"spplited": false,
"split_without_fee": false,
"soft_descriptor": null,
"order_id": null,
"active": true,
"status": 60,
"status_label": "Cancelado",
"start_date": null,
"next_date": null,
"next_recurrence_date": null,
"refunds": [],
"created_at": "2023-07-29 21:57",
"paid_at": null,
"updated_at": "2025-10-13 06:43",
"receipt_pdf_path": "https://api.webpag.com.br/payments/6633ac8ea9615b48e5336f0c9/pdf",
"card_flag": null,
"card_flag_label": null
}
},
{
"id": 6,
"installment_plan_id": 1,
"payment_id": 457,
"code": "64c5b55a3733f",
"due_date": "2024-01-29 00:00:00",
"liquidation_date": null,
"payment_info": null,
"number": 6,
"amount": "100.00",
"status": 40,
"status_label": "Cancelado",
"payment": {
"id": 457,
"business": {
"id": 10,
"name": "Empresa deletada"
},
"payer_id": 209,
"card_id": null,
"payer": {
"id": 209,
"cpf_cnpj": "05920092700",
"is_business": false,
"email": "jefferson@ectechnologies.com.br",
"first_name": "Jefferson",
"last_name": "Souza",
"gender": "M",
"phone_number": "+55 (27) 99578-6767",
"birth_date": "1988-05-11",
"address": null,
"use_boleto": true,
"status": 10,
"status_label": "Ativo",
"created_at": "2023-07-10 21:24:48",
"updated_at": "2023-10-20 15:23:02"
},
"name": "6/10 - Crediário #1",
"amount": 10000,
"amount_refunded": 0,
"fee_value": null,
"refunded_fee": 0,
"installments": 1,
"is_recurrent": false,
"recurrence_code": null,
"frequency": null,
"method": 50,
"method_label": "Crediário Boleto",
"method_slug": null,
"boleto": {
"id": 9,
"linha_digitavel": "00190000090341722699499999991179996100000010000",
"sequencial_code": 9999999991,
"nosso_numero": "00034172269999999991",
"codigo_barras": "00199961000000100000000003417226999999999117",
"due_date": "2024-01-29T03:00:00.000000Z",
"issue_date": "2023-07-29T03:00:00.000000Z",
"amount": 100,
"interest": null,
"fine": null,
"accept_after_due_date": null,
"boleto_url": "https://api.webpag.com.br/r/9501ed28-17df"
},
"notification_url": null,
"pix": null,
"installments_paid": 0,
"spplited": false,
"split_without_fee": false,
"soft_descriptor": null,
"order_id": null,
"active": true,
"status": 60,
"status_label": "Cancelado",
"start_date": null,
"next_date": null,
"next_recurrence_date": null,
"refunds": [],
"created_at": "2023-07-29 21:57",
"paid_at": null,
"updated_at": "2025-10-13 06:43",
"receipt_pdf_path": "https://api.webpag.com.br/payments/b058cab9327727c397921a743/pdf",
"card_flag": null,
"card_flag_label": null
}
},
{
"id": 7,
"installment_plan_id": 1,
"payment_id": 458,
"code": "64c5b55a3a029",
"due_date": "2024-02-29 00:00:00",
"liquidation_date": null,
"payment_info": null,
"number": 7,
"amount": "100.00",
"status": 40,
"status_label": "Cancelado",
"payment": {
"id": 458,
"business": {
"id": 10,
"name": "Empresa deletada"
},
"payer_id": 209,
"card_id": null,
"payer": {
"id": 209,
"cpf_cnpj": "05920092700",
"is_business": false,
"email": "jefferson@ectechnologies.com.br",
"first_name": "Jefferson",
"last_name": "Souza",
"gender": "M",
"phone_number": "+55 (27) 99578-6767",
"birth_date": "1988-05-11",
"address": null,
"use_boleto": true,
"status": 10,
"status_label": "Ativo",
"created_at": "2023-07-10 21:24:48",
"updated_at": "2023-10-20 15:23:02"
},
"name": "7/10 - Crediário #1",
"amount": 10000,
"amount_refunded": 0,
"fee_value": null,
"refunded_fee": 0,
"installments": 1,
"is_recurrent": false,
"recurrence_code": null,
"frequency": null,
"method": 50,
"method_label": "Crediário Boleto",
"method_slug": null,
"boleto": {
"id": 10,
"linha_digitavel": "00190000090341722699499999990171196410000010000",
"sequencial_code": 9999999990,
"nosso_numero": "00034172269999999990",
"codigo_barras": "00191964100000100000000003417226999999999017",
"due_date": "2024-02-29T03:00:00.000000Z",
"issue_date": "2023-07-29T03:00:00.000000Z",
"amount": 100,
"interest": null,
"fine": null,
"accept_after_due_date": null,
"boleto_url": "https://api.webpag.com.br/r/97915983-5822"
},
"notification_url": null,
"pix": null,
"installments_paid": 0,
"spplited": false,
"split_without_fee": false,
"soft_descriptor": null,
"order_id": null,
"active": true,
"status": 60,
"status_label": "Cancelado",
"start_date": null,
"next_date": null,
"next_recurrence_date": null,
"refunds": [],
"created_at": "2023-07-29 21:57",
"paid_at": null,
"updated_at": "2025-10-13 06:43",
"receipt_pdf_path": "https://api.webpag.com.br/payments/7fa920445ed2a3846c06af665/pdf",
"card_flag": null,
"card_flag_label": null
}
},
{
"id": 8,
"installment_plan_id": 1,
"payment_id": 459,
"code": "64c5b55a3b2b9",
"due_date": "2024-03-29 00:00:00",
"liquidation_date": null,
"payment_info": null,
"number": 8,
"amount": "100.00",
"status": 40,
"status_label": "Cancelado",
"payment": {
"id": 459,
"business": {
"id": 10,
"name": "Empresa deletada"
},
"payer_id": 209,
"card_id": null,
"payer": {
"id": 209,
"cpf_cnpj": "05920092700",
"is_business": false,
"email": "jefferson@ectechnologies.com.br",
"first_name": "Jefferson",
"last_name": "Souza",
"gender": "M",
"phone_number": "+55 (27) 99578-6767",
"birth_date": "1988-05-11",
"address": null,
"use_boleto": true,
"status": 10,
"status_label": "Ativo",
"created_at": "2023-07-10 21:24:48",
"updated_at": "2023-10-20 15:23:02"
},
"name": "8/10 - Crediário #1",
"amount": 10000,
"amount_refunded": 0,
"fee_value": null,
"refunded_fee": 0,
"installments": 1,
"is_recurrent": false,
"recurrence_code": null,
"frequency": null,
"method": 50,
"method_label": "Crediário Boleto",
"method_slug": null,
"boleto": {
"id": 11,
"linha_digitavel": "00190000090341722699499999989173196700000010000",
"sequencial_code": 9999999989,
"nosso_numero": "00034172269999999989",
"codigo_barras": "00191967000000100000000003417226999999998917",
"due_date": "2024-03-29T03:00:00.000000Z",
"issue_date": "2023-07-29T03:00:00.000000Z",
"amount": 100,
"interest": null,
"fine": null,
"accept_after_due_date": null,
"boleto_url": "https://api.webpag.com.br/r/42b79469-f29a"
},
"notification_url": null,
"pix": null,
"installments_paid": 0,
"spplited": false,
"split_without_fee": false,
"soft_descriptor": null,
"order_id": null,
"active": true,
"status": 60,
"status_label": "Cancelado",
"start_date": null,
"next_date": null,
"next_recurrence_date": null,
"refunds": [],
"created_at": "2023-07-29 21:57",
"paid_at": null,
"updated_at": "2025-10-13 06:43",
"receipt_pdf_path": "https://api.webpag.com.br/payments/56fca9d74f377a6f148db3dcf/pdf",
"card_flag": null,
"card_flag_label": null
}
},
{
"id": 9,
"installment_plan_id": 1,
"payment_id": 460,
"code": "64c5b55a3c463",
"due_date": "2024-04-29 00:00:00",
"liquidation_date": null,
"payment_info": null,
"number": 9,
"amount": "100.00",
"status": 40,
"status_label": "Cancelado",
"payment": {
"id": 460,
"business": {
"id": 10,
"name": "Empresa deletada"
},
"payer_id": 209,
"card_id": null,
"payer": {
"id": 209,
"cpf_cnpj": "05920092700",
"is_business": false,
"email": "jefferson@ectechnologies.com.br",
"first_name": "Jefferson",
"last_name": "Souza",
"gender": "M",
"phone_number": "+55 (27) 99578-6767",
"birth_date": "1988-05-11",
"address": null,
"use_boleto": true,
"status": 10,
"status_label": "Ativo",
"created_at": "2023-07-10 21:24:48",
"updated_at": "2023-10-20 15:23:02"
},
"name": "9/10 - Crediário #1",
"amount": 10000,
"amount_refunded": 0,
"fee_value": null,
"refunded_fee": 0,
"installments": 1,
"is_recurrent": false,
"recurrence_code": null,
"frequency": null,
"method": 50,
"method_label": "Crediário Boleto",
"method_slug": null,
"boleto": {
"id": 12,
"linha_digitavel": "00190000090341722699499999988175297010000010000",
"sequencial_code": 9999999988,
"nosso_numero": "00034172269999999988",
"codigo_barras": "00192970100000100000000003417226999999998817",
"due_date": "2024-04-29T03:00:00.000000Z",
"issue_date": "2023-07-29T03:00:00.000000Z",
"amount": 100,
"interest": null,
"fine": null,
"accept_after_due_date": null,
"boleto_url": "https://api.webpag.com.br/r/2046481d-165f"
},
"notification_url": null,
"pix": null,
"installments_paid": 0,
"spplited": false,
"split_without_fee": false,
"soft_descriptor": null,
"order_id": null,
"active": true,
"status": 60,
"status_label": "Cancelado",
"start_date": null,
"next_date": null,
"next_recurrence_date": null,
"refunds": [],
"created_at": "2023-07-29 21:57",
"paid_at": null,
"updated_at": "2025-10-13 06:43",
"receipt_pdf_path": "https://api.webpag.com.br/payments/0577bbc9ae8d32f9280e3f4d3/pdf",
"card_flag": null,
"card_flag_label": null
}
},
{
"id": 10,
"installment_plan_id": 1,
"payment_id": 461,
"code": "64c5b55a3d787",
"due_date": "2024-05-29 00:00:00",
"liquidation_date": null,
"payment_info": null,
"number": 10,
"amount": "100.00",
"status": 40,
"status_label": "Cancelado",
"payment": {
"id": 461,
"business": {
"id": 10,
"name": "Empresa deletada"
},
"payer_id": 209,
"card_id": null,
"payer": {
"id": 209,
"cpf_cnpj": "05920092700",
"is_business": false,
"email": "jefferson@ectechnologies.com.br",
"first_name": "Jefferson",
"last_name": "Souza",
"gender": "M",
"phone_number": "+55 (27) 99578-6767",
"birth_date": "1988-05-11",
"address": null,
"use_boleto": true,
"status": 10,
"status_label": "Ativo",
"created_at": "2023-07-10 21:24:48",
"updated_at": "2023-10-20 15:23:02"
},
"name": "10/10 - Crediário #1",
"amount": 10000,
"amount_refunded": 0,
"fee_value": null,
"refunded_fee": 0,
"installments": 1,
"is_recurrent": false,
"recurrence_code": null,
"frequency": null,
"method": 50,
"method_label": "Crediário Boleto",
"method_slug": null,
"boleto": {
"id": 13,
"linha_digitavel": "00190000090341722699499999987177197310000010000",
"sequencial_code": 9999999987,
"nosso_numero": "00034172269999999987",
"codigo_barras": "00191973100000100000000003417226999999998717",
"due_date": "2024-05-29T03:00:00.000000Z",
"issue_date": "2023-07-29T03:00:00.000000Z",
"amount": 100,
"interest": null,
"fine": null,
"accept_after_due_date": null,
"boleto_url": "https://api.webpag.com.br/r/c2f602fe-4a15"
},
"notification_url": null,
"pix": null,
"installments_paid": 0,
"spplited": false,
"split_without_fee": false,
"soft_descriptor": null,
"order_id": null,
"active": true,
"status": 60,
"status_label": "Cancelado",
"start_date": null,
"next_date": null,
"next_recurrence_date": null,
"refunds": [],
"created_at": "2023-07-29 21:57",
"paid_at": null,
"updated_at": "2025-10-13 06:43",
"receipt_pdf_path": "https://api.webpag.com.br/payments/4dd4462d29799375f740c06e5/pdf",
"card_flag": null,
"card_flag_label": null
}
}
]
}
]
}
Resposta recebida:
Requisição falhou com erro:
Dica: Verifique se você está devidamente conectado à rede.
Se você é o mantenedor desta API, verifique se a sua API está em execução e se você habilitou o CORS.
Você pode verificar o console das Ferramentas de Desenvolvedor para informações de depuração.Criar um novo crediário
requires authentication
Exemplo de Requisição:
$client = new \GuzzleHttp\Client();
$url = 'https://api.webpag.com.br/api/installments/register';
$response = $client->post(
$url,
[
'headers' => [
'auth-token' => '{CHAVE_API}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'amount' => 2500,
'first_date' => '2024-01-01',
'number_installments' => 2,
'payer' => 881,
'accept_after_due_date' => true,
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));curl --request POST \
"https://api.webpag.com.br/api/installments/register" \
--header "auth-token: {CHAVE_API}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"amount\": 2500,
\"first_date\": \"2024-01-01\",
\"number_installments\": 2,
\"payer\": 881,
\"accept_after_due_date\": true
}"
Exemplo de Resposta (200):
{
"data": {
"id": 1,
"name": "Crediário do(a) Jefferson Souza",
"business_id": 10,
"payer_id": 209,
"number_installments": 10,
"amount_original": "1000.00",
"first_date": "2023-08-29 00:00:00",
"type": 10,
"type_label": "Boleto",
"status": 10,
"status_label": "Ativo",
"accept_after_due_date": null,
"created_at": "2023-07-29 21:56:58",
"updated_at": "2023-07-29 21:56:58",
"payer": {
"id": 209,
"cpf_cnpj": "05920092700",
"is_business": false,
"email": "jefferson@ectechnologies.com.br",
"first_name": "Jefferson",
"last_name": "Souza",
"gender": "M",
"phone_number": "+55 (27) 99578-6767",
"birth_date": "1988-05-11",
"address": null,
"use_boleto": true,
"status": 10,
"status_label": "Ativo",
"created_at": "2023-07-10 21:24:48",
"updated_at": "2023-10-20 15:23:02"
},
"installments": [
{
"id": 1,
"installment_plan_id": 1,
"payment_id": 452,
"code": "64c5b55a31417",
"due_date": "2023-08-29 00:00:00",
"liquidation_date": null,
"payment_info": null,
"number": 1,
"amount": "100.00",
"status": 40,
"status_label": "Cancelado",
"payment": {
"id": 452,
"business": {
"id": 10,
"name": "Empresa deletada"
},
"payer_id": 209,
"card_id": null,
"payer": {
"id": 209,
"cpf_cnpj": "05920092700",
"is_business": false,
"email": "jefferson@ectechnologies.com.br",
"first_name": "Jefferson",
"last_name": "Souza",
"gender": "M",
"phone_number": "+55 (27) 99578-6767",
"birth_date": "1988-05-11",
"address": null,
"use_boleto": true,
"status": 10,
"status_label": "Ativo",
"created_at": "2023-07-10 21:24:48",
"updated_at": "2023-10-20 15:23:02"
},
"name": "1/10 - Crediário #1",
"amount": 10000,
"amount_refunded": 0,
"fee_value": null,
"refunded_fee": 0,
"installments": 1,
"is_recurrent": false,
"recurrence_code": null,
"frequency": null,
"method": 50,
"method_label": "Crediário Boleto",
"method_slug": null,
"boleto": {
"id": 4,
"linha_digitavel": "00190000090341722699499999996178194570000010000",
"sequencial_code": 9999999996,
"nosso_numero": "00034172269999999996",
"codigo_barras": "00191945700000100000000003417226999999999617",
"due_date": "2023-08-29T03:00:00.000000Z",
"issue_date": "2023-07-29T03:00:00.000000Z",
"amount": 100,
"interest": null,
"fine": null,
"accept_after_due_date": null,
"boleto_url": "https://api.webpag.com.br/r/dedf6e7b-950b"
},
"notification_url": null,
"pix": null,
"installments_paid": 0,
"spplited": false,
"split_without_fee": false,
"soft_descriptor": null,
"order_id": null,
"active": true,
"status": 60,
"status_label": "Cancelado",
"start_date": null,
"next_date": null,
"next_recurrence_date": null,
"refunds": [],
"created_at": "2023-07-29 21:56",
"paid_at": null,
"updated_at": "2025-10-13 06:43",
"receipt_pdf_path": "https://api.webpag.com.br/payments/69fdba13f6f8a577c8ebe21d6/pdf",
"card_flag": null,
"card_flag_label": null
}
},
{
"id": 2,
"installment_plan_id": 1,
"payment_id": 453,
"code": "64c5b55a32915",
"due_date": "2023-09-29 00:00:00",
"liquidation_date": null,
"payment_info": null,
"number": 2,
"amount": "100.00",
"status": 40,
"status_label": "Cancelado",
"payment": {
"id": 453,
"business": {
"id": 10,
"name": "Empresa deletada"
},
"payer_id": 209,
"card_id": null,
"payer": {
"id": 209,
"cpf_cnpj": "05920092700",
"is_business": false,
"email": "jefferson@ectechnologies.com.br",
"first_name": "Jefferson",
"last_name": "Souza",
"gender": "M",
"phone_number": "+55 (27) 99578-6767",
"birth_date": "1988-05-11",
"address": null,
"use_boleto": true,
"status": 10,
"status_label": "Ativo",
"created_at": "2023-07-10 21:24:48",
"updated_at": "2023-10-20 15:23:02"
},
"name": "2/10 - Crediário #1",
"amount": 10000,
"amount_refunded": 0,
"fee_value": null,
"refunded_fee": 0,
"installments": 1,
"is_recurrent": false,
"recurrence_code": null,
"frequency": null,
"method": 50,
"method_label": "Crediário Boleto",
"method_slug": null,
"boleto": {
"id": 5,
"linha_digitavel": "00190000090341722699499999995170294880000010000",
"sequencial_code": 9999999995,
"nosso_numero": "00034172269999999995",
"codigo_barras": "00192948800000100000000003417226999999999517",
"due_date": "2023-09-29T03:00:00.000000Z",
"issue_date": "2023-07-29T03:00:00.000000Z",
"amount": 100,
"interest": null,
"fine": null,
"accept_after_due_date": null,
"boleto_url": "https://api.webpag.com.br/r/97489a4a-73b9"
},
"notification_url": null,
"pix": null,
"installments_paid": 0,
"spplited": false,
"split_without_fee": false,
"soft_descriptor": null,
"order_id": null,
"active": true,
"status": 60,
"status_label": "Cancelado",
"start_date": null,
"next_date": null,
"next_recurrence_date": null,
"refunds": [],
"created_at": "2023-07-29 21:57",
"paid_at": null,
"updated_at": "2025-10-13 06:43",
"receipt_pdf_path": "https://api.webpag.com.br/payments/a53782e2d80f8b5c982716d1f/pdf",
"card_flag": null,
"card_flag_label": null
}
},
{
"id": 3,
"installment_plan_id": 1,
"payment_id": 454,
"code": "64c5b55a33b18",
"due_date": "2023-10-29 00:00:00",
"liquidation_date": null,
"payment_info": null,
"number": 3,
"amount": "100.00",
"status": 40,
"status_label": "Cancelado",
"payment": {
"id": 454,
"business": {
"id": 10,
"name": "Empresa deletada"
},
"payer_id": 209,
"card_id": null,
"payer": {
"id": 209,
"cpf_cnpj": "05920092700",
"is_business": false,
"email": "jefferson@ectechnologies.com.br",
"first_name": "Jefferson",
"last_name": "Souza",
"gender": "M",
"phone_number": "+55 (27) 99578-6767",
"birth_date": "1988-05-11",
"address": null,
"use_boleto": true,
"status": 10,
"status_label": "Ativo",
"created_at": "2023-07-10 21:24:48",
"updated_at": "2023-10-20 15:23:02"
},
"name": "3/10 - Crediário #1",
"amount": 10000,
"amount_refunded": 0,
"fee_value": null,
"refunded_fee": 0,
"installments": 1,
"is_recurrent": false,
"recurrence_code": null,
"frequency": null,
"method": 50,
"method_label": "Crediário Boleto",
"method_slug": null,
"boleto": {
"id": 6,
"linha_digitavel": "00190000090341722699499999994173895180000010000",
"sequencial_code": 9999999994,
"nosso_numero": "00034172269999999994",
"codigo_barras": "00198951800000100000000003417226999999999417",
"due_date": "2023-10-29T03:00:00.000000Z",
"issue_date": "2023-07-29T03:00:00.000000Z",
"amount": 100,
"interest": null,
"fine": null,
"accept_after_due_date": null,
"boleto_url": "https://api.webpag.com.br/r/704f4ca5-f096"
},
"notification_url": null,
"pix": null,
"installments_paid": 0,
"spplited": false,
"split_without_fee": false,
"soft_descriptor": null,
"order_id": null,
"active": true,
"status": 60,
"status_label": "Cancelado",
"start_date": null,
"next_date": null,
"next_recurrence_date": null,
"refunds": [],
"created_at": "2023-07-29 21:57",
"paid_at": null,
"updated_at": "2025-10-13 06:43",
"receipt_pdf_path": "https://api.webpag.com.br/payments/39887ec8745459963897afa7f/pdf",
"card_flag": null,
"card_flag_label": null
}
},
{
"id": 4,
"installment_plan_id": 1,
"payment_id": 455,
"code": "64c5b55a353e4",
"due_date": "2023-11-29 00:00:00",
"liquidation_date": null,
"payment_info": null,
"number": 4,
"amount": "100.00",
"status": 40,
"status_label": "Cancelado",
"payment": {
"id": 455,
"business": {
"id": 10,
"name": "Empresa deletada"
},
"payer_id": 209,
"card_id": null,
"payer": {
"id": 209,
"cpf_cnpj": "05920092700",
"is_business": false,
"email": "jefferson@ectechnologies.com.br",
"first_name": "Jefferson",
"last_name": "Souza",
"gender": "M",
"phone_number": "+55 (27) 99578-6767",
"birth_date": "1988-05-11",
"address": null,
"use_boleto": true,
"status": 10,
"status_label": "Ativo",
"created_at": "2023-07-10 21:24:48",
"updated_at": "2023-10-20 15:23:02"
},
"name": "4/10 - Crediário #1",
"amount": 10000,
"amount_refunded": 0,
"fee_value": null,
"refunded_fee": 0,
"installments": 1,
"is_recurrent": false,
"recurrence_code": null,
"frequency": null,
"method": 50,
"method_label": "Crediário Boleto",
"method_slug": null,
"boleto": {
"id": 7,
"linha_digitavel": "00190000090341722699499999993175195490000010000",
"sequencial_code": 9999999993,
"nosso_numero": "00034172269999999993",
"codigo_barras": "00191954900000100000000003417226999999999317",
"due_date": "2023-11-29T03:00:00.000000Z",
"issue_date": "2023-07-29T03:00:00.000000Z",
"amount": 100,
"interest": null,
"fine": null,
"accept_after_due_date": null,
"boleto_url": "https://api.webpag.com.br/r/bf3bea52-9d28"
},
"notification_url": null,
"pix": null,
"installments_paid": 0,
"spplited": false,
"split_without_fee": false,
"soft_descriptor": null,
"order_id": null,
"active": true,
"status": 60,
"status_label": "Cancelado",
"start_date": null,
"next_date": null,
"next_recurrence_date": null,
"refunds": [],
"created_at": "2023-07-29 21:57",
"paid_at": null,
"updated_at": "2025-10-13 06:43",
"receipt_pdf_path": "https://api.webpag.com.br/payments/6eeb21929f81c90f23da423b9/pdf",
"card_flag": null,
"card_flag_label": null
}
},
{
"id": 5,
"installment_plan_id": 1,
"payment_id": 456,
"code": "64c5b55a36320",
"due_date": "2023-12-29 00:00:00",
"liquidation_date": null,
"payment_info": null,
"number": 5,
"amount": "100.00",
"status": 40,
"status_label": "Cancelado",
"payment": {
"id": 456,
"business": {
"id": 10,
"name": "Empresa deletada"
},
"payer_id": 209,
"card_id": null,
"payer": {
"id": 209,
"cpf_cnpj": "05920092700",
"is_business": false,
"email": "jefferson@ectechnologies.com.br",
"first_name": "Jefferson",
"last_name": "Souza",
"gender": "M",
"phone_number": "+55 (27) 99578-6767",
"birth_date": "1988-05-11",
"address": null,
"use_boleto": true,
"status": 10,
"status_label": "Ativo",
"created_at": "2023-07-10 21:24:48",
"updated_at": "2023-10-20 15:23:02"
},
"name": "5/10 - Crediário #1",
"amount": 10000,
"amount_refunded": 0,
"fee_value": null,
"refunded_fee": 0,
"installments": 1,
"is_recurrent": false,
"recurrence_code": null,
"frequency": null,
"method": 50,
"method_label": "Crediário Boleto",
"method_slug": null,
"boleto": {
"id": 8,
"linha_digitavel": "00190000090341722699499999992177895790000010000",
"sequencial_code": 9999999992,
"nosso_numero": "00034172269999999992",
"codigo_barras": "00198957900000100000000003417226999999999217",
"due_date": "2023-12-29T03:00:00.000000Z",
"issue_date": "2023-07-29T03:00:00.000000Z",
"amount": 100,
"interest": null,
"fine": null,
"accept_after_due_date": null,
"boleto_url": "https://api.webpag.com.br/r/69e845ec-39f4"
},
"notification_url": null,
"pix": null,
"installments_paid": 0,
"spplited": false,
"split_without_fee": false,
"soft_descriptor": null,
"order_id": null,
"active": true,
"status": 60,
"status_label": "Cancelado",
"start_date": null,
"next_date": null,
"next_recurrence_date": null,
"refunds": [],
"created_at": "2023-07-29 21:57",
"paid_at": null,
"updated_at": "2025-10-13 06:43",
"receipt_pdf_path": "https://api.webpag.com.br/payments/6633ac8ea9615b48e5336f0c9/pdf",
"card_flag": null,
"card_flag_label": null
}
},
{
"id": 6,
"installment_plan_id": 1,
"payment_id": 457,
"code": "64c5b55a3733f",
"due_date": "2024-01-29 00:00:00",
"liquidation_date": null,
"payment_info": null,
"number": 6,
"amount": "100.00",
"status": 40,
"status_label": "Cancelado",
"payment": {
"id": 457,
"business": {
"id": 10,
"name": "Empresa deletada"
},
"payer_id": 209,
"card_id": null,
"payer": {
"id": 209,
"cpf_cnpj": "05920092700",
"is_business": false,
"email": "jefferson@ectechnologies.com.br",
"first_name": "Jefferson",
"last_name": "Souza",
"gender": "M",
"phone_number": "+55 (27) 99578-6767",
"birth_date": "1988-05-11",
"address": null,
"use_boleto": true,
"status": 10,
"status_label": "Ativo",
"created_at": "2023-07-10 21:24:48",
"updated_at": "2023-10-20 15:23:02"
},
"name": "6/10 - Crediário #1",
"amount": 10000,
"amount_refunded": 0,
"fee_value": null,
"refunded_fee": 0,
"installments": 1,
"is_recurrent": false,
"recurrence_code": null,
"frequency": null,
"method": 50,
"method_label": "Crediário Boleto",
"method_slug": null,
"boleto": {
"id": 9,
"linha_digitavel": "00190000090341722699499999991179996100000010000",
"sequencial_code": 9999999991,
"nosso_numero": "00034172269999999991",
"codigo_barras": "00199961000000100000000003417226999999999117",
"due_date": "2024-01-29T03:00:00.000000Z",
"issue_date": "2023-07-29T03:00:00.000000Z",
"amount": 100,
"interest": null,
"fine": null,
"accept_after_due_date": null,
"boleto_url": "https://api.webpag.com.br/r/9501ed28-17df"
},
"notification_url": null,
"pix": null,
"installments_paid": 0,
"spplited": false,
"split_without_fee": false,
"soft_descriptor": null,
"order_id": null,
"active": true,
"status": 60,
"status_label": "Cancelado",
"start_date": null,
"next_date": null,
"next_recurrence_date": null,
"refunds": [],
"created_at": "2023-07-29 21:57",
"paid_at": null,
"updated_at": "2025-10-13 06:43",
"receipt_pdf_path": "https://api.webpag.com.br/payments/b058cab9327727c397921a743/pdf",
"card_flag": null,
"card_flag_label": null
}
},
{
"id": 7,
"installment_plan_id": 1,
"payment_id": 458,
"code": "64c5b55a3a029",
"due_date": "2024-02-29 00:00:00",
"liquidation_date": null,
"payment_info": null,
"number": 7,
"amount": "100.00",
"status": 40,
"status_label": "Cancelado",
"payment": {
"id": 458,
"business": {
"id": 10,
"name": "Empresa deletada"
},
"payer_id": 209,
"card_id": null,
"payer": {
"id": 209,
"cpf_cnpj": "05920092700",
"is_business": false,
"email": "jefferson@ectechnologies.com.br",
"first_name": "Jefferson",
"last_name": "Souza",
"gender": "M",
"phone_number": "+55 (27) 99578-6767",
"birth_date": "1988-05-11",
"address": null,
"use_boleto": true,
"status": 10,
"status_label": "Ativo",
"created_at": "2023-07-10 21:24:48",
"updated_at": "2023-10-20 15:23:02"
},
"name": "7/10 - Crediário #1",
"amount": 10000,
"amount_refunded": 0,
"fee_value": null,
"refunded_fee": 0,
"installments": 1,
"is_recurrent": false,
"recurrence_code": null,
"frequency": null,
"method": 50,
"method_label": "Crediário Boleto",
"method_slug": null,
"boleto": {
"id": 10,
"linha_digitavel": "00190000090341722699499999990171196410000010000",
"sequencial_code": 9999999990,
"nosso_numero": "00034172269999999990",
"codigo_barras": "00191964100000100000000003417226999999999017",
"due_date": "2024-02-29T03:00:00.000000Z",
"issue_date": "2023-07-29T03:00:00.000000Z",
"amount": 100,
"interest": null,
"fine": null,
"accept_after_due_date": null,
"boleto_url": "https://api.webpag.com.br/r/97915983-5822"
},
"notification_url": null,
"pix": null,
"installments_paid": 0,
"spplited": false,
"split_without_fee": false,
"soft_descriptor": null,
"order_id": null,
"active": true,
"status": 60,
"status_label": "Cancelado",
"start_date": null,
"next_date": null,
"next_recurrence_date": null,
"refunds": [],
"created_at": "2023-07-29 21:57",
"paid_at": null,
"updated_at": "2025-10-13 06:43",
"receipt_pdf_path": "https://api.webpag.com.br/payments/7fa920445ed2a3846c06af665/pdf",
"card_flag": null,
"card_flag_label": null
}
},
{
"id": 8,
"installment_plan_id": 1,
"payment_id": 459,
"code": "64c5b55a3b2b9",
"due_date": "2024-03-29 00:00:00",
"liquidation_date": null,
"payment_info": null,
"number": 8,
"amount": "100.00",
"status": 40,
"status_label": "Cancelado",
"payment": {
"id": 459,
"business": {
"id": 10,
"name": "Empresa deletada"
},
"payer_id": 209,
"card_id": null,
"payer": {
"id": 209,
"cpf_cnpj": "05920092700",
"is_business": false,
"email": "jefferson@ectechnologies.com.br",
"first_name": "Jefferson",
"last_name": "Souza",
"gender": "M",
"phone_number": "+55 (27) 99578-6767",
"birth_date": "1988-05-11",
"address": null,
"use_boleto": true,
"status": 10,
"status_label": "Ativo",
"created_at": "2023-07-10 21:24:48",
"updated_at": "2023-10-20 15:23:02"
},
"name": "8/10 - Crediário #1",
"amount": 10000,
"amount_refunded": 0,
"fee_value": null,
"refunded_fee": 0,
"installments": 1,
"is_recurrent": false,
"recurrence_code": null,
"frequency": null,
"method": 50,
"method_label": "Crediário Boleto",
"method_slug": null,
"boleto": {
"id": 11,
"linha_digitavel": "00190000090341722699499999989173196700000010000",
"sequencial_code": 9999999989,
"nosso_numero": "00034172269999999989",
"codigo_barras": "00191967000000100000000003417226999999998917",
"due_date": "2024-03-29T03:00:00.000000Z",
"issue_date": "2023-07-29T03:00:00.000000Z",
"amount": 100,
"interest": null,
"fine": null,
"accept_after_due_date": null,
"boleto_url": "https://api.webpag.com.br/r/42b79469-f29a"
},
"notification_url": null,
"pix": null,
"installments_paid": 0,
"spplited": false,
"split_without_fee": false,
"soft_descriptor": null,
"order_id": null,
"active": true,
"status": 60,
"status_label": "Cancelado",
"start_date": null,
"next_date": null,
"next_recurrence_date": null,
"refunds": [],
"created_at": "2023-07-29 21:57",
"paid_at": null,
"updated_at": "2025-10-13 06:43",
"receipt_pdf_path": "https://api.webpag.com.br/payments/56fca9d74f377a6f148db3dcf/pdf",
"card_flag": null,
"card_flag_label": null
}
},
{
"id": 9,
"installment_plan_id": 1,
"payment_id": 460,
"code": "64c5b55a3c463",
"due_date": "2024-04-29 00:00:00",
"liquidation_date": null,
"payment_info": null,
"number": 9,
"amount": "100.00",
"status": 40,
"status_label": "Cancelado",
"payment": {
"id": 460,
"business": {
"id": 10,
"name": "Empresa deletada"
},
"payer_id": 209,
"card_id": null,
"payer": {
"id": 209,
"cpf_cnpj": "05920092700",
"is_business": false,
"email": "jefferson@ectechnologies.com.br",
"first_name": "Jefferson",
"last_name": "Souza",
"gender": "M",
"phone_number": "+55 (27) 99578-6767",
"birth_date": "1988-05-11",
"address": null,
"use_boleto": true,
"status": 10,
"status_label": "Ativo",
"created_at": "2023-07-10 21:24:48",
"updated_at": "2023-10-20 15:23:02"
},
"name": "9/10 - Crediário #1",
"amount": 10000,
"amount_refunded": 0,
"fee_value": null,
"refunded_fee": 0,
"installments": 1,
"is_recurrent": false,
"recurrence_code": null,
"frequency": null,
"method": 50,
"method_label": "Crediário Boleto",
"method_slug": null,
"boleto": {
"id": 12,
"linha_digitavel": "00190000090341722699499999988175297010000010000",
"sequencial_code": 9999999988,
"nosso_numero": "00034172269999999988",
"codigo_barras": "00192970100000100000000003417226999999998817",
"due_date": "2024-04-29T03:00:00.000000Z",
"issue_date": "2023-07-29T03:00:00.000000Z",
"amount": 100,
"interest": null,
"fine": null,
"accept_after_due_date": null,
"boleto_url": "https://api.webpag.com.br/r/2046481d-165f"
},
"notification_url": null,
"pix": null,
"installments_paid": 0,
"spplited": false,
"split_without_fee": false,
"soft_descriptor": null,
"order_id": null,
"active": true,
"status": 60,
"status_label": "Cancelado",
"start_date": null,
"next_date": null,
"next_recurrence_date": null,
"refunds": [],
"created_at": "2023-07-29 21:57",
"paid_at": null,
"updated_at": "2025-10-13 06:43",
"receipt_pdf_path": "https://api.webpag.com.br/payments/0577bbc9ae8d32f9280e3f4d3/pdf",
"card_flag": null,
"card_flag_label": null
}
},
{
"id": 10,
"installment_plan_id": 1,
"payment_id": 461,
"code": "64c5b55a3d787",
"due_date": "2024-05-29 00:00:00",
"liquidation_date": null,
"payment_info": null,
"number": 10,
"amount": "100.00",
"status": 40,
"status_label": "Cancelado",
"payment": {
"id": 461,
"business": {
"id": 10,
"name": "Empresa deletada"
},
"payer_id": 209,
"card_id": null,
"payer": {
"id": 209,
"cpf_cnpj": "05920092700",
"is_business": false,
"email": "jefferson@ectechnologies.com.br",
"first_name": "Jefferson",
"last_name": "Souza",
"gender": "M",
"phone_number": "+55 (27) 99578-6767",
"birth_date": "1988-05-11",
"address": null,
"use_boleto": true,
"status": 10,
"status_label": "Ativo",
"created_at": "2023-07-10 21:24:48",
"updated_at": "2023-10-20 15:23:02"
},
"name": "10/10 - Crediário #1",
"amount": 10000,
"amount_refunded": 0,
"fee_value": null,
"refunded_fee": 0,
"installments": 1,
"is_recurrent": false,
"recurrence_code": null,
"frequency": null,
"method": 50,
"method_label": "Crediário Boleto",
"method_slug": null,
"boleto": {
"id": 13,
"linha_digitavel": "00190000090341722699499999987177197310000010000",
"sequencial_code": 9999999987,
"nosso_numero": "00034172269999999987",
"codigo_barras": "00191973100000100000000003417226999999998717",
"due_date": "2024-05-29T03:00:00.000000Z",
"issue_date": "2023-07-29T03:00:00.000000Z",
"amount": 100,
"interest": null,
"fine": null,
"accept_after_due_date": null,
"boleto_url": "https://api.webpag.com.br/r/c2f602fe-4a15"
},
"notification_url": null,
"pix": null,
"installments_paid": 0,
"spplited": false,
"split_without_fee": false,
"soft_descriptor": null,
"order_id": null,
"active": true,
"status": 60,
"status_label": "Cancelado",
"start_date": null,
"next_date": null,
"next_recurrence_date": null,
"refunds": [],
"created_at": "2023-07-29 21:57",
"paid_at": null,
"updated_at": "2025-10-13 06:43",
"receipt_pdf_path": "https://api.webpag.com.br/payments/4dd4462d29799375f740c06e5/pdf",
"card_flag": null,
"card_flag_label": null
}
}
]
}
}
Resposta recebida:
Requisição falhou com erro:
Dica: Verifique se você está devidamente conectado à rede.
Se você é o mantenedor desta API, verifique se a sua API está em execução e se você habilitou o CORS.
Você pode verificar o console das Ferramentas de Desenvolvedor para informações de depuração.Cancelar um crediário
requires authentication
Exemplo de Requisição:
$client = new \GuzzleHttp\Client();
$url = 'https://api.webpag.com.br/api/installments/1/cancel';
$response = $client->post(
$url,
[
'headers' => [
'auth-token' => '{CHAVE_API}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));curl --request POST \
"https://api.webpag.com.br/api/installments/1/cancel" \
--header "auth-token: {CHAVE_API}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"Exemplo de Resposta (200):
{
"data": {
"id": 1,
"name": "Crediário do(a) Jefferson Souza",
"business_id": 10,
"payer_id": 209,
"number_installments": 10,
"amount_original": "1000.00",
"first_date": "2023-08-29 00:00:00",
"type": 10,
"type_label": "Boleto",
"status": 10,
"status_label": "Ativo",
"accept_after_due_date": null,
"created_at": "2023-07-29 21:56:58",
"updated_at": "2023-07-29 21:56:58",
"payer": {
"id": 209,
"cpf_cnpj": "05920092700",
"is_business": false,
"email": "jefferson@ectechnologies.com.br",
"first_name": "Jefferson",
"last_name": "Souza",
"gender": "M",
"phone_number": "+55 (27) 99578-6767",
"birth_date": "1988-05-11",
"address": null,
"use_boleto": true,
"status": 10,
"status_label": "Ativo",
"created_at": "2023-07-10 21:24:48",
"updated_at": "2023-10-20 15:23:02"
},
"installments": [
{
"id": 1,
"installment_plan_id": 1,
"payment_id": 452,
"code": "64c5b55a31417",
"due_date": "2023-08-29 00:00:00",
"liquidation_date": null,
"payment_info": null,
"number": 1,
"amount": "100.00",
"status": 40,
"status_label": "Cancelado",
"payment": {
"id": 452,
"business": {
"id": 10,
"name": "Empresa deletada"
},
"payer_id": 209,
"card_id": null,
"payer": {
"id": 209,
"cpf_cnpj": "05920092700",
"is_business": false,
"email": "jefferson@ectechnologies.com.br",
"first_name": "Jefferson",
"last_name": "Souza",
"gender": "M",
"phone_number": "+55 (27) 99578-6767",
"birth_date": "1988-05-11",
"address": null,
"use_boleto": true,
"status": 10,
"status_label": "Ativo",
"created_at": "2023-07-10 21:24:48",
"updated_at": "2023-10-20 15:23:02"
},
"name": "1/10 - Crediário #1",
"amount": 10000,
"amount_refunded": 0,
"fee_value": null,
"refunded_fee": 0,
"installments": 1,
"is_recurrent": false,
"recurrence_code": null,
"frequency": null,
"method": 50,
"method_label": "Crediário Boleto",
"method_slug": null,
"boleto": {
"id": 4,
"linha_digitavel": "00190000090341722699499999996178194570000010000",
"sequencial_code": 9999999996,
"nosso_numero": "00034172269999999996",
"codigo_barras": "00191945700000100000000003417226999999999617",
"due_date": "2023-08-29T03:00:00.000000Z",
"issue_date": "2023-07-29T03:00:00.000000Z",
"amount": 100,
"interest": null,
"fine": null,
"accept_after_due_date": null,
"boleto_url": "https://api.webpag.com.br/r/dedf6e7b-950b"
},
"notification_url": null,
"pix": null,
"installments_paid": 0,
"spplited": false,
"split_without_fee": false,
"soft_descriptor": null,
"order_id": null,
"active": true,
"status": 60,
"status_label": "Cancelado",
"start_date": null,
"next_date": null,
"next_recurrence_date": null,
"refunds": [],
"created_at": "2023-07-29 21:56",
"paid_at": null,
"updated_at": "2025-10-13 06:43",
"receipt_pdf_path": "https://api.webpag.com.br/payments/69fdba13f6f8a577c8ebe21d6/pdf",
"card_flag": null,
"card_flag_label": null
}
},
{
"id": 2,
"installment_plan_id": 1,
"payment_id": 453,
"code": "64c5b55a32915",
"due_date": "2023-09-29 00:00:00",
"liquidation_date": null,
"payment_info": null,
"number": 2,
"amount": "100.00",
"status": 40,
"status_label": "Cancelado",
"payment": {
"id": 453,
"business": {
"id": 10,
"name": "Empresa deletada"
},
"payer_id": 209,
"card_id": null,
"payer": {
"id": 209,
"cpf_cnpj": "05920092700",
"is_business": false,
"email": "jefferson@ectechnologies.com.br",
"first_name": "Jefferson",
"last_name": "Souza",
"gender": "M",
"phone_number": "+55 (27) 99578-6767",
"birth_date": "1988-05-11",
"address": null,
"use_boleto": true,
"status": 10,
"status_label": "Ativo",
"created_at": "2023-07-10 21:24:48",
"updated_at": "2023-10-20 15:23:02"
},
"name": "2/10 - Crediário #1",
"amount": 10000,
"amount_refunded": 0,
"fee_value": null,
"refunded_fee": 0,
"installments": 1,
"is_recurrent": false,
"recurrence_code": null,
"frequency": null,
"method": 50,
"method_label": "Crediário Boleto",
"method_slug": null,
"boleto": {
"id": 5,
"linha_digitavel": "00190000090341722699499999995170294880000010000",
"sequencial_code": 9999999995,
"nosso_numero": "00034172269999999995",
"codigo_barras": "00192948800000100000000003417226999999999517",
"due_date": "2023-09-29T03:00:00.000000Z",
"issue_date": "2023-07-29T03:00:00.000000Z",
"amount": 100,
"interest": null,
"fine": null,
"accept_after_due_date": null,
"boleto_url": "https://api.webpag.com.br/r/97489a4a-73b9"
},
"notification_url": null,
"pix": null,
"installments_paid": 0,
"spplited": false,
"split_without_fee": false,
"soft_descriptor": null,
"order_id": null,
"active": true,
"status": 60,
"status_label": "Cancelado",
"start_date": null,
"next_date": null,
"next_recurrence_date": null,
"refunds": [],
"created_at": "2023-07-29 21:57",
"paid_at": null,
"updated_at": "2025-10-13 06:43",
"receipt_pdf_path": "https://api.webpag.com.br/payments/a53782e2d80f8b5c982716d1f/pdf",
"card_flag": null,
"card_flag_label": null
}
},
{
"id": 3,
"installment_plan_id": 1,
"payment_id": 454,
"code": "64c5b55a33b18",
"due_date": "2023-10-29 00:00:00",
"liquidation_date": null,
"payment_info": null,
"number": 3,
"amount": "100.00",
"status": 40,
"status_label": "Cancelado",
"payment": {
"id": 454,
"business": {
"id": 10,
"name": "Empresa deletada"
},
"payer_id": 209,
"card_id": null,
"payer": {
"id": 209,
"cpf_cnpj": "05920092700",
"is_business": false,
"email": "jefferson@ectechnologies.com.br",
"first_name": "Jefferson",
"last_name": "Souza",
"gender": "M",
"phone_number": "+55 (27) 99578-6767",
"birth_date": "1988-05-11",
"address": null,
"use_boleto": true,
"status": 10,
"status_label": "Ativo",
"created_at": "2023-07-10 21:24:48",
"updated_at": "2023-10-20 15:23:02"
},
"name": "3/10 - Crediário #1",
"amount": 10000,
"amount_refunded": 0,
"fee_value": null,
"refunded_fee": 0,
"installments": 1,
"is_recurrent": false,
"recurrence_code": null,
"frequency": null,
"method": 50,
"method_label": "Crediário Boleto",
"method_slug": null,
"boleto": {
"id": 6,
"linha_digitavel": "00190000090341722699499999994173895180000010000",
"sequencial_code": 9999999994,
"nosso_numero": "00034172269999999994",
"codigo_barras": "00198951800000100000000003417226999999999417",
"due_date": "2023-10-29T03:00:00.000000Z",
"issue_date": "2023-07-29T03:00:00.000000Z",
"amount": 100,
"interest": null,
"fine": null,
"accept_after_due_date": null,
"boleto_url": "https://api.webpag.com.br/r/704f4ca5-f096"
},
"notification_url": null,
"pix": null,
"installments_paid": 0,
"spplited": false,
"split_without_fee": false,
"soft_descriptor": null,
"order_id": null,
"active": true,
"status": 60,
"status_label": "Cancelado",
"start_date": null,
"next_date": null,
"next_recurrence_date": null,
"refunds": [],
"created_at": "2023-07-29 21:57",
"paid_at": null,
"updated_at": "2025-10-13 06:43",
"receipt_pdf_path": "https://api.webpag.com.br/payments/39887ec8745459963897afa7f/pdf",
"card_flag": null,
"card_flag_label": null
}
},
{
"id": 4,
"installment_plan_id": 1,
"payment_id": 455,
"code": "64c5b55a353e4",
"due_date": "2023-11-29 00:00:00",
"liquidation_date": null,
"payment_info": null,
"number": 4,
"amount": "100.00",
"status": 40,
"status_label": "Cancelado",
"payment": {
"id": 455,
"business": {
"id": 10,
"name": "Empresa deletada"
},
"payer_id": 209,
"card_id": null,
"payer": {
"id": 209,
"cpf_cnpj": "05920092700",
"is_business": false,
"email": "jefferson@ectechnologies.com.br",
"first_name": "Jefferson",
"last_name": "Souza",
"gender": "M",
"phone_number": "+55 (27) 99578-6767",
"birth_date": "1988-05-11",
"address": null,
"use_boleto": true,
"status": 10,
"status_label": "Ativo",
"created_at": "2023-07-10 21:24:48",
"updated_at": "2023-10-20 15:23:02"
},
"name": "4/10 - Crediário #1",
"amount": 10000,
"amount_refunded": 0,
"fee_value": null,
"refunded_fee": 0,
"installments": 1,
"is_recurrent": false,
"recurrence_code": null,
"frequency": null,
"method": 50,
"method_label": "Crediário Boleto",
"method_slug": null,
"boleto": {
"id": 7,
"linha_digitavel": "00190000090341722699499999993175195490000010000",
"sequencial_code": 9999999993,
"nosso_numero": "00034172269999999993",
"codigo_barras": "00191954900000100000000003417226999999999317",
"due_date": "2023-11-29T03:00:00.000000Z",
"issue_date": "2023-07-29T03:00:00.000000Z",
"amount": 100,
"interest": null,
"fine": null,
"accept_after_due_date": null,
"boleto_url": "https://api.webpag.com.br/r/bf3bea52-9d28"
},
"notification_url": null,
"pix": null,
"installments_paid": 0,
"spplited": false,
"split_without_fee": false,
"soft_descriptor": null,
"order_id": null,
"active": true,
"status": 60,
"status_label": "Cancelado",
"start_date": null,
"next_date": null,
"next_recurrence_date": null,
"refunds": [],
"created_at": "2023-07-29 21:57",
"paid_at": null,
"updated_at": "2025-10-13 06:43",
"receipt_pdf_path": "https://api.webpag.com.br/payments/6eeb21929f81c90f23da423b9/pdf",
"card_flag": null,
"card_flag_label": null
}
},
{
"id": 5,
"installment_plan_id": 1,
"payment_id": 456,
"code": "64c5b55a36320",
"due_date": "2023-12-29 00:00:00",
"liquidation_date": null,
"payment_info": null,
"number": 5,
"amount": "100.00",
"status": 40,
"status_label": "Cancelado",
"payment": {
"id": 456,
"business": {
"id": 10,
"name": "Empresa deletada"
},
"payer_id": 209,
"card_id": null,
"payer": {
"id": 209,
"cpf_cnpj": "05920092700",
"is_business": false,
"email": "jefferson@ectechnologies.com.br",
"first_name": "Jefferson",
"last_name": "Souza",
"gender": "M",
"phone_number": "+55 (27) 99578-6767",
"birth_date": "1988-05-11",
"address": null,
"use_boleto": true,
"status": 10,
"status_label": "Ativo",
"created_at": "2023-07-10 21:24:48",
"updated_at": "2023-10-20 15:23:02"
},
"name": "5/10 - Crediário #1",
"amount": 10000,
"amount_refunded": 0,
"fee_value": null,
"refunded_fee": 0,
"installments": 1,
"is_recurrent": false,
"recurrence_code": null,
"frequency": null,
"method": 50,
"method_label": "Crediário Boleto",
"method_slug": null,
"boleto": {
"id": 8,
"linha_digitavel": "00190000090341722699499999992177895790000010000",
"sequencial_code": 9999999992,
"nosso_numero": "00034172269999999992",
"codigo_barras": "00198957900000100000000003417226999999999217",
"due_date": "2023-12-29T03:00:00.000000Z",
"issue_date": "2023-07-29T03:00:00.000000Z",
"amount": 100,
"interest": null,
"fine": null,
"accept_after_due_date": null,
"boleto_url": "https://api.webpag.com.br/r/69e845ec-39f4"
},
"notification_url": null,
"pix": null,
"installments_paid": 0,
"spplited": false,
"split_without_fee": false,
"soft_descriptor": null,
"order_id": null,
"active": true,
"status": 60,
"status_label": "Cancelado",
"start_date": null,
"next_date": null,
"next_recurrence_date": null,
"refunds": [],
"created_at": "2023-07-29 21:57",
"paid_at": null,
"updated_at": "2025-10-13 06:43",
"receipt_pdf_path": "https://api.webpag.com.br/payments/6633ac8ea9615b48e5336f0c9/pdf",
"card_flag": null,
"card_flag_label": null
}
},
{
"id": 6,
"installment_plan_id": 1,
"payment_id": 457,
"code": "64c5b55a3733f",
"due_date": "2024-01-29 00:00:00",
"liquidation_date": null,
"payment_info": null,
"number": 6,
"amount": "100.00",
"status": 40,
"status_label": "Cancelado",
"payment": {
"id": 457,
"business": {
"id": 10,
"name": "Empresa deletada"
},
"payer_id": 209,
"card_id": null,
"payer": {
"id": 209,
"cpf_cnpj": "05920092700",
"is_business": false,
"email": "jefferson@ectechnologies.com.br",
"first_name": "Jefferson",
"last_name": "Souza",
"gender": "M",
"phone_number": "+55 (27) 99578-6767",
"birth_date": "1988-05-11",
"address": null,
"use_boleto": true,
"status": 10,
"status_label": "Ativo",
"created_at": "2023-07-10 21:24:48",
"updated_at": "2023-10-20 15:23:02"
},
"name": "6/10 - Crediário #1",
"amount": 10000,
"amount_refunded": 0,
"fee_value": null,
"refunded_fee": 0,
"installments": 1,
"is_recurrent": false,
"recurrence_code": null,
"frequency": null,
"method": 50,
"method_label": "Crediário Boleto",
"method_slug": null,
"boleto": {
"id": 9,
"linha_digitavel": "00190000090341722699499999991179996100000010000",
"sequencial_code": 9999999991,
"nosso_numero": "00034172269999999991",
"codigo_barras": "00199961000000100000000003417226999999999117",
"due_date": "2024-01-29T03:00:00.000000Z",
"issue_date": "2023-07-29T03:00:00.000000Z",
"amount": 100,
"interest": null,
"fine": null,
"accept_after_due_date": null,
"boleto_url": "https://api.webpag.com.br/r/9501ed28-17df"
},
"notification_url": null,
"pix": null,
"installments_paid": 0,
"spplited": false,
"split_without_fee": false,
"soft_descriptor": null,
"order_id": null,
"active": true,
"status": 60,
"status_label": "Cancelado",
"start_date": null,
"next_date": null,
"next_recurrence_date": null,
"refunds": [],
"created_at": "2023-07-29 21:57",
"paid_at": null,
"updated_at": "2025-10-13 06:43",
"receipt_pdf_path": "https://api.webpag.com.br/payments/b058cab9327727c397921a743/pdf",
"card_flag": null,
"card_flag_label": null
}
},
{
"id": 7,
"installment_plan_id": 1,
"payment_id": 458,
"code": "64c5b55a3a029",
"due_date": "2024-02-29 00:00:00",
"liquidation_date": null,
"payment_info": null,
"number": 7,
"amount": "100.00",
"status": 40,
"status_label": "Cancelado",
"payment": {
"id": 458,
"business": {
"id": 10,
"name": "Empresa deletada"
},
"payer_id": 209,
"card_id": null,
"payer": {
"id": 209,
"cpf_cnpj": "05920092700",
"is_business": false,
"email": "jefferson@ectechnologies.com.br",
"first_name": "Jefferson",
"last_name": "Souza",
"gender": "M",
"phone_number": "+55 (27) 99578-6767",
"birth_date": "1988-05-11",
"address": null,
"use_boleto": true,
"status": 10,
"status_label": "Ativo",
"created_at": "2023-07-10 21:24:48",
"updated_at": "2023-10-20 15:23:02"
},
"name": "7/10 - Crediário #1",
"amount": 10000,
"amount_refunded": 0,
"fee_value": null,
"refunded_fee": 0,
"installments": 1,
"is_recurrent": false,
"recurrence_code": null,
"frequency": null,
"method": 50,
"method_label": "Crediário Boleto",
"method_slug": null,
"boleto": {
"id": 10,
"linha_digitavel": "00190000090341722699499999990171196410000010000",
"sequencial_code": 9999999990,
"nosso_numero": "00034172269999999990",
"codigo_barras": "00191964100000100000000003417226999999999017",
"due_date": "2024-02-29T03:00:00.000000Z",
"issue_date": "2023-07-29T03:00:00.000000Z",
"amount": 100,
"interest": null,
"fine": null,
"accept_after_due_date": null,
"boleto_url": "https://api.webpag.com.br/r/97915983-5822"
},
"notification_url": null,
"pix": null,
"installments_paid": 0,
"spplited": false,
"split_without_fee": false,
"soft_descriptor": null,
"order_id": null,
"active": true,
"status": 60,
"status_label": "Cancelado",
"start_date": null,
"next_date": null,
"next_recurrence_date": null,
"refunds": [],
"created_at": "2023-07-29 21:57",
"paid_at": null,
"updated_at": "2025-10-13 06:43",
"receipt_pdf_path": "https://api.webpag.com.br/payments/7fa920445ed2a3846c06af665/pdf",
"card_flag": null,
"card_flag_label": null
}
},
{
"id": 8,
"installment_plan_id": 1,
"payment_id": 459,
"code": "64c5b55a3b2b9",
"due_date": "2024-03-29 00:00:00",
"liquidation_date": null,
"payment_info": null,
"number": 8,
"amount": "100.00",
"status": 40,
"status_label": "Cancelado",
"payment": {
"id": 459,
"business": {
"id": 10,
"name": "Empresa deletada"
},
"payer_id": 209,
"card_id": null,
"payer": {
"id": 209,
"cpf_cnpj": "05920092700",
"is_business": false,
"email": "jefferson@ectechnologies.com.br",
"first_name": "Jefferson",
"last_name": "Souza",
"gender": "M",
"phone_number": "+55 (27) 99578-6767",
"birth_date": "1988-05-11",
"address": null,
"use_boleto": true,
"status": 10,
"status_label": "Ativo",
"created_at": "2023-07-10 21:24:48",
"updated_at": "2023-10-20 15:23:02"
},
"name": "8/10 - Crediário #1",
"amount": 10000,
"amount_refunded": 0,
"fee_value": null,
"refunded_fee": 0,
"installments": 1,
"is_recurrent": false,
"recurrence_code": null,
"frequency": null,
"method": 50,
"method_label": "Crediário Boleto",
"method_slug": null,
"boleto": {
"id": 11,
"linha_digitavel": "00190000090341722699499999989173196700000010000",
"sequencial_code": 9999999989,
"nosso_numero": "00034172269999999989",
"codigo_barras": "00191967000000100000000003417226999999998917",
"due_date": "2024-03-29T03:00:00.000000Z",
"issue_date": "2023-07-29T03:00:00.000000Z",
"amount": 100,
"interest": null,
"fine": null,
"accept_after_due_date": null,
"boleto_url": "https://api.webpag.com.br/r/42b79469-f29a"
},
"notification_url": null,
"pix": null,
"installments_paid": 0,
"spplited": false,
"split_without_fee": false,
"soft_descriptor": null,
"order_id": null,
"active": true,
"status": 60,
"status_label": "Cancelado",
"start_date": null,
"next_date": null,
"next_recurrence_date": null,
"refunds": [],
"created_at": "2023-07-29 21:57",
"paid_at": null,
"updated_at": "2025-10-13 06:43",
"receipt_pdf_path": "https://api.webpag.com.br/payments/56fca9d74f377a6f148db3dcf/pdf",
"card_flag": null,
"card_flag_label": null
}
},
{
"id": 9,
"installment_plan_id": 1,
"payment_id": 460,
"code": "64c5b55a3c463",
"due_date": "2024-04-29 00:00:00",
"liquidation_date": null,
"payment_info": null,
"number": 9,
"amount": "100.00",
"status": 40,
"status_label": "Cancelado",
"payment": {
"id": 460,
"business": {
"id": 10,
"name": "Empresa deletada"
},
"payer_id": 209,
"card_id": null,
"payer": {
"id": 209,
"cpf_cnpj": "05920092700",
"is_business": false,
"email": "jefferson@ectechnologies.com.br",
"first_name": "Jefferson",
"last_name": "Souza",
"gender": "M",
"phone_number": "+55 (27) 99578-6767",
"birth_date": "1988-05-11",
"address": null,
"use_boleto": true,
"status": 10,
"status_label": "Ativo",
"created_at": "2023-07-10 21:24:48",
"updated_at": "2023-10-20 15:23:02"
},
"name": "9/10 - Crediário #1",
"amount": 10000,
"amount_refunded": 0,
"fee_value": null,
"refunded_fee": 0,
"installments": 1,
"is_recurrent": false,
"recurrence_code": null,
"frequency": null,
"method": 50,
"method_label": "Crediário Boleto",
"method_slug": null,
"boleto": {
"id": 12,
"linha_digitavel": "00190000090341722699499999988175297010000010000",
"sequencial_code": 9999999988,
"nosso_numero": "00034172269999999988",
"codigo_barras": "00192970100000100000000003417226999999998817",
"due_date": "2024-04-29T03:00:00.000000Z",
"issue_date": "2023-07-29T03:00:00.000000Z",
"amount": 100,
"interest": null,
"fine": null,
"accept_after_due_date": null,
"boleto_url": "https://api.webpag.com.br/r/2046481d-165f"
},
"notification_url": null,
"pix": null,
"installments_paid": 0,
"spplited": false,
"split_without_fee": false,
"soft_descriptor": null,
"order_id": null,
"active": true,
"status": 60,
"status_label": "Cancelado",
"start_date": null,
"next_date": null,
"next_recurrence_date": null,
"refunds": [],
"created_at": "2023-07-29 21:57",
"paid_at": null,
"updated_at": "2025-10-13 06:43",
"receipt_pdf_path": "https://api.webpag.com.br/payments/0577bbc9ae8d32f9280e3f4d3/pdf",
"card_flag": null,
"card_flag_label": null
}
},
{
"id": 10,
"installment_plan_id": 1,
"payment_id": 461,
"code": "64c5b55a3d787",
"due_date": "2024-05-29 00:00:00",
"liquidation_date": null,
"payment_info": null,
"number": 10,
"amount": "100.00",
"status": 40,
"status_label": "Cancelado",
"payment": {
"id": 461,
"business": {
"id": 10,
"name": "Empresa deletada"
},
"payer_id": 209,
"card_id": null,
"payer": {
"id": 209,
"cpf_cnpj": "05920092700",
"is_business": false,
"email": "jefferson@ectechnologies.com.br",
"first_name": "Jefferson",
"last_name": "Souza",
"gender": "M",
"phone_number": "+55 (27) 99578-6767",
"birth_date": "1988-05-11",
"address": null,
"use_boleto": true,
"status": 10,
"status_label": "Ativo",
"created_at": "2023-07-10 21:24:48",
"updated_at": "2023-10-20 15:23:02"
},
"name": "10/10 - Crediário #1",
"amount": 10000,
"amount_refunded": 0,
"fee_value": null,
"refunded_fee": 0,
"installments": 1,
"is_recurrent": false,
"recurrence_code": null,
"frequency": null,
"method": 50,
"method_label": "Crediário Boleto",
"method_slug": null,
"boleto": {
"id": 13,
"linha_digitavel": "00190000090341722699499999987177197310000010000",
"sequencial_code": 9999999987,
"nosso_numero": "00034172269999999987",
"codigo_barras": "00191973100000100000000003417226999999998717",
"due_date": "2024-05-29T03:00:00.000000Z",
"issue_date": "2023-07-29T03:00:00.000000Z",
"amount": 100,
"interest": null,
"fine": null,
"accept_after_due_date": null,
"boleto_url": "https://api.webpag.com.br/r/c2f602fe-4a15"
},
"notification_url": null,
"pix": null,
"installments_paid": 0,
"spplited": false,
"split_without_fee": false,
"soft_descriptor": null,
"order_id": null,
"active": true,
"status": 60,
"status_label": "Cancelado",
"start_date": null,
"next_date": null,
"next_recurrence_date": null,
"refunds": [],
"created_at": "2023-07-29 21:57",
"paid_at": null,
"updated_at": "2025-10-13 06:43",
"receipt_pdf_path": "https://api.webpag.com.br/payments/4dd4462d29799375f740c06e5/pdf",
"card_flag": null,
"card_flag_label": null
}
}
]
}
}
Resposta recebida:
Requisição falhou com erro:
Dica: Verifique se você está devidamente conectado à rede.
Se você é o mantenedor desta API, verifique se a sua API está em execução e se você habilitou o CORS.
Você pode verificar o console das Ferramentas de Desenvolvedor para informações de depuração.Consultar um crediário
requires authentication
Exemplo de Requisição:
$client = new \GuzzleHttp\Client();
$url = 'https://api.webpag.com.br/api/installments/1';
$response = $client->get(
$url,
[
'headers' => [
'auth-token' => '{CHAVE_API}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));curl --request GET \
--get "https://api.webpag.com.br/api/installments/1" \
--header "auth-token: {CHAVE_API}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"Exemplo de Resposta (200):
{
"data": {
"id": 1,
"name": "Crediário do(a) Jefferson Souza",
"business_id": 10,
"payer_id": 209,
"number_installments": 10,
"amount_original": "1000.00",
"first_date": "2023-08-29 00:00:00",
"type": 10,
"type_label": "Boleto",
"status": 10,
"status_label": "Ativo",
"accept_after_due_date": null,
"created_at": "2023-07-29 21:56:58",
"updated_at": "2023-07-29 21:56:58",
"payer": {
"id": 209,
"cpf_cnpj": "05920092700",
"is_business": false,
"email": "jefferson@ectechnologies.com.br",
"first_name": "Jefferson",
"last_name": "Souza",
"gender": "M",
"phone_number": "+55 (27) 99578-6767",
"birth_date": "1988-05-11",
"address": null,
"use_boleto": true,
"status": 10,
"status_label": "Ativo",
"created_at": "2023-07-10 21:24:48",
"updated_at": "2023-10-20 15:23:02"
},
"installments": [
{
"id": 1,
"installment_plan_id": 1,
"payment_id": 452,
"code": "64c5b55a31417",
"due_date": "2023-08-29 00:00:00",
"liquidation_date": null,
"payment_info": null,
"number": 1,
"amount": "100.00",
"status": 40,
"status_label": "Cancelado",
"payment": {
"id": 452,
"business": {
"id": 10,
"name": "Empresa deletada"
},
"payer_id": 209,
"card_id": null,
"payer": {
"id": 209,
"cpf_cnpj": "05920092700",
"is_business": false,
"email": "jefferson@ectechnologies.com.br",
"first_name": "Jefferson",
"last_name": "Souza",
"gender": "M",
"phone_number": "+55 (27) 99578-6767",
"birth_date": "1988-05-11",
"address": null,
"use_boleto": true,
"status": 10,
"status_label": "Ativo",
"created_at": "2023-07-10 21:24:48",
"updated_at": "2023-10-20 15:23:02"
},
"name": "1/10 - Crediário #1",
"amount": 10000,
"amount_refunded": 0,
"fee_value": null,
"refunded_fee": 0,
"installments": 1,
"is_recurrent": false,
"recurrence_code": null,
"frequency": null,
"method": 50,
"method_label": "Crediário Boleto",
"method_slug": null,
"boleto": {
"id": 4,
"linha_digitavel": "00190000090341722699499999996178194570000010000",
"sequencial_code": 9999999996,
"nosso_numero": "00034172269999999996",
"codigo_barras": "00191945700000100000000003417226999999999617",
"due_date": "2023-08-29T03:00:00.000000Z",
"issue_date": "2023-07-29T03:00:00.000000Z",
"amount": 100,
"interest": null,
"fine": null,
"accept_after_due_date": null,
"boleto_url": "https://api.webpag.com.br/r/dedf6e7b-950b"
},
"notification_url": null,
"pix": null,
"installments_paid": 0,
"spplited": false,
"split_without_fee": false,
"soft_descriptor": null,
"order_id": null,
"active": true,
"status": 60,
"status_label": "Cancelado",
"start_date": null,
"next_date": null,
"next_recurrence_date": null,
"refunds": [],
"created_at": "2023-07-29 21:56",
"paid_at": null,
"updated_at": "2025-10-13 06:43",
"receipt_pdf_path": "https://api.webpag.com.br/payments/69fdba13f6f8a577c8ebe21d6/pdf",
"card_flag": null,
"card_flag_label": null
}
},
{
"id": 2,
"installment_plan_id": 1,
"payment_id": 453,
"code": "64c5b55a32915",
"due_date": "2023-09-29 00:00:00",
"liquidation_date": null,
"payment_info": null,
"number": 2,
"amount": "100.00",
"status": 40,
"status_label": "Cancelado",
"payment": {
"id": 453,
"business": {
"id": 10,
"name": "Empresa deletada"
},
"payer_id": 209,
"card_id": null,
"payer": {
"id": 209,
"cpf_cnpj": "05920092700",
"is_business": false,
"email": "jefferson@ectechnologies.com.br",
"first_name": "Jefferson",
"last_name": "Souza",
"gender": "M",
"phone_number": "+55 (27) 99578-6767",
"birth_date": "1988-05-11",
"address": null,
"use_boleto": true,
"status": 10,
"status_label": "Ativo",
"created_at": "2023-07-10 21:24:48",
"updated_at": "2023-10-20 15:23:02"
},
"name": "2/10 - Crediário #1",
"amount": 10000,
"amount_refunded": 0,
"fee_value": null,
"refunded_fee": 0,
"installments": 1,
"is_recurrent": false,
"recurrence_code": null,
"frequency": null,
"method": 50,
"method_label": "Crediário Boleto",
"method_slug": null,
"boleto": {
"id": 5,
"linha_digitavel": "00190000090341722699499999995170294880000010000",
"sequencial_code": 9999999995,
"nosso_numero": "00034172269999999995",
"codigo_barras": "00192948800000100000000003417226999999999517",
"due_date": "2023-09-29T03:00:00.000000Z",
"issue_date": "2023-07-29T03:00:00.000000Z",
"amount": 100,
"interest": null,
"fine": null,
"accept_after_due_date": null,
"boleto_url": "https://api.webpag.com.br/r/97489a4a-73b9"
},
"notification_url": null,
"pix": null,
"installments_paid": 0,
"spplited": false,
"split_without_fee": false,
"soft_descriptor": null,
"order_id": null,
"active": true,
"status": 60,
"status_label": "Cancelado",
"start_date": null,
"next_date": null,
"next_recurrence_date": null,
"refunds": [],
"created_at": "2023-07-29 21:57",
"paid_at": null,
"updated_at": "2025-10-13 06:43",
"receipt_pdf_path": "https://api.webpag.com.br/payments/a53782e2d80f8b5c982716d1f/pdf",
"card_flag": null,
"card_flag_label": null
}
},
{
"id": 3,
"installment_plan_id": 1,
"payment_id": 454,
"code": "64c5b55a33b18",
"due_date": "2023-10-29 00:00:00",
"liquidation_date": null,
"payment_info": null,
"number": 3,
"amount": "100.00",
"status": 40,
"status_label": "Cancelado",
"payment": {
"id": 454,
"business": {
"id": 10,
"name": "Empresa deletada"
},
"payer_id": 209,
"card_id": null,
"payer": {
"id": 209,
"cpf_cnpj": "05920092700",
"is_business": false,
"email": "jefferson@ectechnologies.com.br",
"first_name": "Jefferson",
"last_name": "Souza",
"gender": "M",
"phone_number": "+55 (27) 99578-6767",
"birth_date": "1988-05-11",
"address": null,
"use_boleto": true,
"status": 10,
"status_label": "Ativo",
"created_at": "2023-07-10 21:24:48",
"updated_at": "2023-10-20 15:23:02"
},
"name": "3/10 - Crediário #1",
"amount": 10000,
"amount_refunded": 0,
"fee_value": null,
"refunded_fee": 0,
"installments": 1,
"is_recurrent": false,
"recurrence_code": null,
"frequency": null,
"method": 50,
"method_label": "Crediário Boleto",
"method_slug": null,
"boleto": {
"id": 6,
"linha_digitavel": "00190000090341722699499999994173895180000010000",
"sequencial_code": 9999999994,
"nosso_numero": "00034172269999999994",
"codigo_barras": "00198951800000100000000003417226999999999417",
"due_date": "2023-10-29T03:00:00.000000Z",
"issue_date": "2023-07-29T03:00:00.000000Z",
"amount": 100,
"interest": null,
"fine": null,
"accept_after_due_date": null,
"boleto_url": "https://api.webpag.com.br/r/704f4ca5-f096"
},
"notification_url": null,
"pix": null,
"installments_paid": 0,
"spplited": false,
"split_without_fee": false,
"soft_descriptor": null,
"order_id": null,
"active": true,
"status": 60,
"status_label": "Cancelado",
"start_date": null,
"next_date": null,
"next_recurrence_date": null,
"refunds": [],
"created_at": "2023-07-29 21:57",
"paid_at": null,
"updated_at": "2025-10-13 06:43",
"receipt_pdf_path": "https://api.webpag.com.br/payments/39887ec8745459963897afa7f/pdf",
"card_flag": null,
"card_flag_label": null
}
},
{
"id": 4,
"installment_plan_id": 1,
"payment_id": 455,
"code": "64c5b55a353e4",
"due_date": "2023-11-29 00:00:00",
"liquidation_date": null,
"payment_info": null,
"number": 4,
"amount": "100.00",
"status": 40,
"status_label": "Cancelado",
"payment": {
"id": 455,
"business": {
"id": 10,
"name": "Empresa deletada"
},
"payer_id": 209,
"card_id": null,
"payer": {
"id": 209,
"cpf_cnpj": "05920092700",
"is_business": false,
"email": "jefferson@ectechnologies.com.br",
"first_name": "Jefferson",
"last_name": "Souza",
"gender": "M",
"phone_number": "+55 (27) 99578-6767",
"birth_date": "1988-05-11",
"address": null,
"use_boleto": true,
"status": 10,
"status_label": "Ativo",
"created_at": "2023-07-10 21:24:48",
"updated_at": "2023-10-20 15:23:02"
},
"name": "4/10 - Crediário #1",
"amount": 10000,
"amount_refunded": 0,
"fee_value": null,
"refunded_fee": 0,
"installments": 1,
"is_recurrent": false,
"recurrence_code": null,
"frequency": null,
"method": 50,
"method_label": "Crediário Boleto",
"method_slug": null,
"boleto": {
"id": 7,
"linha_digitavel": "00190000090341722699499999993175195490000010000",
"sequencial_code": 9999999993,
"nosso_numero": "00034172269999999993",
"codigo_barras": "00191954900000100000000003417226999999999317",
"due_date": "2023-11-29T03:00:00.000000Z",
"issue_date": "2023-07-29T03:00:00.000000Z",
"amount": 100,
"interest": null,
"fine": null,
"accept_after_due_date": null,
"boleto_url": "https://api.webpag.com.br/r/bf3bea52-9d28"
},
"notification_url": null,
"pix": null,
"installments_paid": 0,
"spplited": false,
"split_without_fee": false,
"soft_descriptor": null,
"order_id": null,
"active": true,
"status": 60,
"status_label": "Cancelado",
"start_date": null,
"next_date": null,
"next_recurrence_date": null,
"refunds": [],
"created_at": "2023-07-29 21:57",
"paid_at": null,
"updated_at": "2025-10-13 06:43",
"receipt_pdf_path": "https://api.webpag.com.br/payments/6eeb21929f81c90f23da423b9/pdf",
"card_flag": null,
"card_flag_label": null
}
},
{
"id": 5,
"installment_plan_id": 1,
"payment_id": 456,
"code": "64c5b55a36320",
"due_date": "2023-12-29 00:00:00",
"liquidation_date": null,
"payment_info": null,
"number": 5,
"amount": "100.00",
"status": 40,
"status_label": "Cancelado",
"payment": {
"id": 456,
"business": {
"id": 10,
"name": "Empresa deletada"
},
"payer_id": 209,
"card_id": null,
"payer": {
"id": 209,
"cpf_cnpj": "05920092700",
"is_business": false,
"email": "jefferson@ectechnologies.com.br",
"first_name": "Jefferson",
"last_name": "Souza",
"gender": "M",
"phone_number": "+55 (27) 99578-6767",
"birth_date": "1988-05-11",
"address": null,
"use_boleto": true,
"status": 10,
"status_label": "Ativo",
"created_at": "2023-07-10 21:24:48",
"updated_at": "2023-10-20 15:23:02"
},
"name": "5/10 - Crediário #1",
"amount": 10000,
"amount_refunded": 0,
"fee_value": null,
"refunded_fee": 0,
"installments": 1,
"is_recurrent": false,
"recurrence_code": null,
"frequency": null,
"method": 50,
"method_label": "Crediário Boleto",
"method_slug": null,
"boleto": {
"id": 8,
"linha_digitavel": "00190000090341722699499999992177895790000010000",
"sequencial_code": 9999999992,
"nosso_numero": "00034172269999999992",
"codigo_barras": "00198957900000100000000003417226999999999217",
"due_date": "2023-12-29T03:00:00.000000Z",
"issue_date": "2023-07-29T03:00:00.000000Z",
"amount": 100,
"interest": null,
"fine": null,
"accept_after_due_date": null,
"boleto_url": "https://api.webpag.com.br/r/69e845ec-39f4"
},
"notification_url": null,
"pix": null,
"installments_paid": 0,
"spplited": false,
"split_without_fee": false,
"soft_descriptor": null,
"order_id": null,
"active": true,
"status": 60,
"status_label": "Cancelado",
"start_date": null,
"next_date": null,
"next_recurrence_date": null,
"refunds": [],
"created_at": "2023-07-29 21:57",
"paid_at": null,
"updated_at": "2025-10-13 06:43",
"receipt_pdf_path": "https://api.webpag.com.br/payments/6633ac8ea9615b48e5336f0c9/pdf",
"card_flag": null,
"card_flag_label": null
}
},
{
"id": 6,
"installment_plan_id": 1,
"payment_id": 457,
"code": "64c5b55a3733f",
"due_date": "2024-01-29 00:00:00",
"liquidation_date": null,
"payment_info": null,
"number": 6,
"amount": "100.00",
"status": 40,
"status_label": "Cancelado",
"payment": {
"id": 457,
"business": {
"id": 10,
"name": "Empresa deletada"
},
"payer_id": 209,
"card_id": null,
"payer": {
"id": 209,
"cpf_cnpj": "05920092700",
"is_business": false,
"email": "jefferson@ectechnologies.com.br",
"first_name": "Jefferson",
"last_name": "Souza",
"gender": "M",
"phone_number": "+55 (27) 99578-6767",
"birth_date": "1988-05-11",
"address": null,
"use_boleto": true,
"status": 10,
"status_label": "Ativo",
"created_at": "2023-07-10 21:24:48",
"updated_at": "2023-10-20 15:23:02"
},
"name": "6/10 - Crediário #1",
"amount": 10000,
"amount_refunded": 0,
"fee_value": null,
"refunded_fee": 0,
"installments": 1,
"is_recurrent": false,
"recurrence_code": null,
"frequency": null,
"method": 50,
"method_label": "Crediário Boleto",
"method_slug": null,
"boleto": {
"id": 9,
"linha_digitavel": "00190000090341722699499999991179996100000010000",
"sequencial_code": 9999999991,
"nosso_numero": "00034172269999999991",
"codigo_barras": "00199961000000100000000003417226999999999117",
"due_date": "2024-01-29T03:00:00.000000Z",
"issue_date": "2023-07-29T03:00:00.000000Z",
"amount": 100,
"interest": null,
"fine": null,
"accept_after_due_date": null,
"boleto_url": "https://api.webpag.com.br/r/9501ed28-17df"
},
"notification_url": null,
"pix": null,
"installments_paid": 0,
"spplited": false,
"split_without_fee": false,
"soft_descriptor": null,
"order_id": null,
"active": true,
"status": 60,
"status_label": "Cancelado",
"start_date": null,
"next_date": null,
"next_recurrence_date": null,
"refunds": [],
"created_at": "2023-07-29 21:57",
"paid_at": null,
"updated_at": "2025-10-13 06:43",
"receipt_pdf_path": "https://api.webpag.com.br/payments/b058cab9327727c397921a743/pdf",
"card_flag": null,
"card_flag_label": null
}
},
{
"id": 7,
"installment_plan_id": 1,
"payment_id": 458,
"code": "64c5b55a3a029",
"due_date": "2024-02-29 00:00:00",
"liquidation_date": null,
"payment_info": null,
"number": 7,
"amount": "100.00",
"status": 40,
"status_label": "Cancelado",
"payment": {
"id": 458,
"business": {
"id": 10,
"name": "Empresa deletada"
},
"payer_id": 209,
"card_id": null,
"payer": {
"id": 209,
"cpf_cnpj": "05920092700",
"is_business": false,
"email": "jefferson@ectechnologies.com.br",
"first_name": "Jefferson",
"last_name": "Souza",
"gender": "M",
"phone_number": "+55 (27) 99578-6767",
"birth_date": "1988-05-11",
"address": null,
"use_boleto": true,
"status": 10,
"status_label": "Ativo",
"created_at": "2023-07-10 21:24:48",
"updated_at": "2023-10-20 15:23:02"
},
"name": "7/10 - Crediário #1",
"amount": 10000,
"amount_refunded": 0,
"fee_value": null,
"refunded_fee": 0,
"installments": 1,
"is_recurrent": false,
"recurrence_code": null,
"frequency": null,
"method": 50,
"method_label": "Crediário Boleto",
"method_slug": null,
"boleto": {
"id": 10,
"linha_digitavel": "00190000090341722699499999990171196410000010000",
"sequencial_code": 9999999990,
"nosso_numero": "00034172269999999990",
"codigo_barras": "00191964100000100000000003417226999999999017",
"due_date": "2024-02-29T03:00:00.000000Z",
"issue_date": "2023-07-29T03:00:00.000000Z",
"amount": 100,
"interest": null,
"fine": null,
"accept_after_due_date": null,
"boleto_url": "https://api.webpag.com.br/r/97915983-5822"
},
"notification_url": null,
"pix": null,
"installments_paid": 0,
"spplited": false,
"split_without_fee": false,
"soft_descriptor": null,
"order_id": null,
"active": true,
"status": 60,
"status_label": "Cancelado",
"start_date": null,
"next_date": null,
"next_recurrence_date": null,
"refunds": [],
"created_at": "2023-07-29 21:57",
"paid_at": null,
"updated_at": "2025-10-13 06:43",
"receipt_pdf_path": "https://api.webpag.com.br/payments/7fa920445ed2a3846c06af665/pdf",
"card_flag": null,
"card_flag_label": null
}
},
{
"id": 8,
"installment_plan_id": 1,
"payment_id": 459,
"code": "64c5b55a3b2b9",
"due_date": "2024-03-29 00:00:00",
"liquidation_date": null,
"payment_info": null,
"number": 8,
"amount": "100.00",
"status": 40,
"status_label": "Cancelado",
"payment": {
"id": 459,
"business": {
"id": 10,
"name": "Empresa deletada"
},
"payer_id": 209,
"card_id": null,
"payer": {
"id": 209,
"cpf_cnpj": "05920092700",
"is_business": false,
"email": "jefferson@ectechnologies.com.br",
"first_name": "Jefferson",
"last_name": "Souza",
"gender": "M",
"phone_number": "+55 (27) 99578-6767",
"birth_date": "1988-05-11",
"address": null,
"use_boleto": true,
"status": 10,
"status_label": "Ativo",
"created_at": "2023-07-10 21:24:48",
"updated_at": "2023-10-20 15:23:02"
},
"name": "8/10 - Crediário #1",
"amount": 10000,
"amount_refunded": 0,
"fee_value": null,
"refunded_fee": 0,
"installments": 1,
"is_recurrent": false,
"recurrence_code": null,
"frequency": null,
"method": 50,
"method_label": "Crediário Boleto",
"method_slug": null,
"boleto": {
"id": 11,
"linha_digitavel": "00190000090341722699499999989173196700000010000",
"sequencial_code": 9999999989,
"nosso_numero": "00034172269999999989",
"codigo_barras": "00191967000000100000000003417226999999998917",
"due_date": "2024-03-29T03:00:00.000000Z",
"issue_date": "2023-07-29T03:00:00.000000Z",
"amount": 100,
"interest": null,
"fine": null,
"accept_after_due_date": null,
"boleto_url": "https://api.webpag.com.br/r/42b79469-f29a"
},
"notification_url": null,
"pix": null,
"installments_paid": 0,
"spplited": false,
"split_without_fee": false,
"soft_descriptor": null,
"order_id": null,
"active": true,
"status": 60,
"status_label": "Cancelado",
"start_date": null,
"next_date": null,
"next_recurrence_date": null,
"refunds": [],
"created_at": "2023-07-29 21:57",
"paid_at": null,
"updated_at": "2025-10-13 06:43",
"receipt_pdf_path": "https://api.webpag.com.br/payments/56fca9d74f377a6f148db3dcf/pdf",
"card_flag": null,
"card_flag_label": null
}
},
{
"id": 9,
"installment_plan_id": 1,
"payment_id": 460,
"code": "64c5b55a3c463",
"due_date": "2024-04-29 00:00:00",
"liquidation_date": null,
"payment_info": null,
"number": 9,
"amount": "100.00",
"status": 40,
"status_label": "Cancelado",
"payment": {
"id": 460,
"business": {
"id": 10,
"name": "Empresa deletada"
},
"payer_id": 209,
"card_id": null,
"payer": {
"id": 209,
"cpf_cnpj": "05920092700",
"is_business": false,
"email": "jefferson@ectechnologies.com.br",
"first_name": "Jefferson",
"last_name": "Souza",
"gender": "M",
"phone_number": "+55 (27) 99578-6767",
"birth_date": "1988-05-11",
"address": null,
"use_boleto": true,
"status": 10,
"status_label": "Ativo",
"created_at": "2023-07-10 21:24:48",
"updated_at": "2023-10-20 15:23:02"
},
"name": "9/10 - Crediário #1",
"amount": 10000,
"amount_refunded": 0,
"fee_value": null,
"refunded_fee": 0,
"installments": 1,
"is_recurrent": false,
"recurrence_code": null,
"frequency": null,
"method": 50,
"method_label": "Crediário Boleto",
"method_slug": null,
"boleto": {
"id": 12,
"linha_digitavel": "00190000090341722699499999988175297010000010000",
"sequencial_code": 9999999988,
"nosso_numero": "00034172269999999988",
"codigo_barras": "00192970100000100000000003417226999999998817",
"due_date": "2024-04-29T03:00:00.000000Z",
"issue_date": "2023-07-29T03:00:00.000000Z",
"amount": 100,
"interest": null,
"fine": null,
"accept_after_due_date": null,
"boleto_url": "https://api.webpag.com.br/r/2046481d-165f"
},
"notification_url": null,
"pix": null,
"installments_paid": 0,
"spplited": false,
"split_without_fee": false,
"soft_descriptor": null,
"order_id": null,
"active": true,
"status": 60,
"status_label": "Cancelado",
"start_date": null,
"next_date": null,
"next_recurrence_date": null,
"refunds": [],
"created_at": "2023-07-29 21:57",
"paid_at": null,
"updated_at": "2025-10-13 06:43",
"receipt_pdf_path": "https://api.webpag.com.br/payments/0577bbc9ae8d32f9280e3f4d3/pdf",
"card_flag": null,
"card_flag_label": null
}
},
{
"id": 10,
"installment_plan_id": 1,
"payment_id": 461,
"code": "64c5b55a3d787",
"due_date": "2024-05-29 00:00:00",
"liquidation_date": null,
"payment_info": null,
"number": 10,
"amount": "100.00",
"status": 40,
"status_label": "Cancelado",
"payment": {
"id": 461,
"business": {
"id": 10,
"name": "Empresa deletada"
},
"payer_id": 209,
"card_id": null,
"payer": {
"id": 209,
"cpf_cnpj": "05920092700",
"is_business": false,
"email": "jefferson@ectechnologies.com.br",
"first_name": "Jefferson",
"last_name": "Souza",
"gender": "M",
"phone_number": "+55 (27) 99578-6767",
"birth_date": "1988-05-11",
"address": null,
"use_boleto": true,
"status": 10,
"status_label": "Ativo",
"created_at": "2023-07-10 21:24:48",
"updated_at": "2023-10-20 15:23:02"
},
"name": "10/10 - Crediário #1",
"amount": 10000,
"amount_refunded": 0,
"fee_value": null,
"refunded_fee": 0,
"installments": 1,
"is_recurrent": false,
"recurrence_code": null,
"frequency": null,
"method": 50,
"method_label": "Crediário Boleto",
"method_slug": null,
"boleto": {
"id": 13,
"linha_digitavel": "00190000090341722699499999987177197310000010000",
"sequencial_code": 9999999987,
"nosso_numero": "00034172269999999987",
"codigo_barras": "00191973100000100000000003417226999999998717",
"due_date": "2024-05-29T03:00:00.000000Z",
"issue_date": "2023-07-29T03:00:00.000000Z",
"amount": 100,
"interest": null,
"fine": null,
"accept_after_due_date": null,
"boleto_url": "https://api.webpag.com.br/r/c2f602fe-4a15"
},
"notification_url": null,
"pix": null,
"installments_paid": 0,
"spplited": false,
"split_without_fee": false,
"soft_descriptor": null,
"order_id": null,
"active": true,
"status": 60,
"status_label": "Cancelado",
"start_date": null,
"next_date": null,
"next_recurrence_date": null,
"refunds": [],
"created_at": "2023-07-29 21:57",
"paid_at": null,
"updated_at": "2025-10-13 06:43",
"receipt_pdf_path": "https://api.webpag.com.br/payments/4dd4462d29799375f740c06e5/pdf",
"card_flag": null,
"card_flag_label": null
}
}
]
}
}
Resposta recebida:
Requisição falhou com erro:
Dica: Verifique se você está devidamente conectado à rede.
Se você é o mantenedor desta API, verifique se a sua API está em execução e se você habilitou o CORS.
Você pode verificar o console das Ferramentas de Desenvolvedor para informações de depuração.Empresa
Verificar autenticação do usuário
requires authentication
Utilizado para autenticar e verificar um usuário da empresa no sistema.
Exemplo de Requisição:
$client = new \GuzzleHttp\Client();
$url = 'https://api.webpag.com.br/api/authenticate';
$response = $client->post(
$url,
[
'headers' => [
'auth-token' => '{CHAVE_API}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'email' => 'grady.dax@example.org',
'password' => 'Rer|.fuB}z6:',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));curl --request POST \
"https://api.webpag.com.br/api/authenticate" \
--header "auth-token: {CHAVE_API}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"email\": \"grady.dax@example.org\",
\"password\": \"Rer|.fuB}z6:\"
}"
Exemplo de Resposta (200):
{
"id": 1,
"business_id": 123,
"email": "user@example.com",
"name": "Nome do Usuário"
}
Exemplo de Resposta (401):
{
"message": "Unauthorized"
}
Resposta recebida:
Requisição falhou com erro:
Dica: Verifique se você está devidamente conectado à rede.
Se você é o mantenedor desta API, verifique se a sua API está em execução e se você habilitou o CORS.
Você pode verificar o console das Ferramentas de Desenvolvedor para informações de depuração.Dados da empresa logada
requires authentication
Retorna os dados da empresa em que o auth-token está associado.
Exemplo de Requisição:
$client = new \GuzzleHttp\Client();
$url = 'https://api.webpag.com.br/api/me';
$response = $client->get(
$url,
[
'headers' => [
'auth-token' => '{CHAVE_API}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));curl --request GET \
--get "https://api.webpag.com.br/api/me" \
--header "auth-token: {CHAVE_API}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"Exemplo de Resposta (200):
{
"id": 1,
"name": "Empresa Exemplo",
"gateway_name": "Empresa Exemplo",
"notification_email": "empresa@example.com",
"cnpj": "12.345.678/0001-99",
"phone_number": "41999999999",
"status": 10,
"current_balance": 150050,
"fees": {
"service_fee": 2.5,
"service_fee_type": "F",
"credit_1x_fee": 3.99,
"pix_fee": 0.99,
"boleto_fee": 2.5
}
}
Resposta recebida:
Requisição falhou com erro:
Dica: Verifique se você está devidamente conectado à rede.
Se você é o mantenedor desta API, verifique se a sua API está em execução e se você habilitou o CORS.
Você pode verificar o console das Ferramentas de Desenvolvedor para informações de depuração.Chave publica para tokenizacao do cartao
requires authentication
Para facilitar a integração no frontend, recomendamos o uso do pacote oficial NPM: https://www.npmjs.com/package/@webpag/card-tokenizer/
Exemplo de Requisição:
$client = new \GuzzleHttp\Client();
$url = 'https://api.webpag.com.br/api/card-token/public-key';
$response = $client->get(
$url,
[
'headers' => [
'auth-token' => '{CHAVE_API}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));curl --request GET \
--get "https://api.webpag.com.br/api/card-token/public-key" \
--header "auth-token: {CHAVE_API}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"Exemplo de Resposta (200):
{
"public_key": "<base64 key>"
}
Resposta recebida:
Requisição falhou com erro:
Dica: Verifique se você está devidamente conectado à rede.
Se você é o mantenedor desta API, verifique se a sua API está em execução e se você habilitou o CORS.
Você pode verificar o console das Ferramentas de Desenvolvedor para informações de depuração.Criar uma nova filial
requires authentication
Cria uma nova filial vinculada à empresa autenticada como matriz. A Filial herda todas as configurações de taxas da matriz. Dados que não forem passados como parâmetro serão herdado da matriz.
Exemplo de Requisição:
$client = new \GuzzleHttp\Client();
$url = 'https://api.webpag.com.br/api/franchises';
$response = $client->post(
$url,
[
'headers' => [
'auth-token' => '{CHAVE_API}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'razao_social' => 'Filial Norte LTDA',
'cnpj' => '12.345.678/0001-99',
'transfer_frequency' => 7,
'credit_installment_limit' => 12,
'notification_email' => 'Filial@exemplo.com',
'gateway_name' => 'FilialNorte',
'account_bank_code' => '341',
'account_type' => 'F',
'account_holder' => 'Empresa Filial LTDA',
'account_document' => '12.345.678/0001-99',
'account_agency' => '1234',
'account_number' => '12345-6',
'pix_key_type' => 20,
'pix_key' => '12345678000199',
'phone_number' => '(41) 99999-9999',
'address' => [
'street' => 'Rua Exemplo',
'number' => '123',
'city' => 'Curitiba',
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));curl --request POST \
"https://api.webpag.com.br/api/franchises" \
--header "auth-token: {CHAVE_API}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"razao_social\": \"Filial Norte LTDA\",
\"cnpj\": \"12.345.678\\/0001-99\",
\"transfer_frequency\": 7,
\"credit_installment_limit\": 12,
\"notification_email\": \"Filial@exemplo.com\",
\"gateway_name\": \"FilialNorte\",
\"account_bank_code\": \"341\",
\"account_type\": \"F\",
\"account_holder\": \"Empresa Filial LTDA\",
\"account_document\": \"12.345.678\\/0001-99\",
\"account_agency\": \"1234\",
\"account_number\": \"12345-6\",
\"pix_key_type\": 20,
\"pix_key\": \"12345678000199\",
\"phone_number\": \"(41) 99999-9999\",
\"address\": {
\"street\": \"Rua Exemplo\",
\"number\": \"123\",
\"city\": \"Curitiba\"
}
}"
Exemplo de Resposta (200):
{
"data": {
"franchise": {
"id": 306,
"name": "Franquia Norte LTDA"
},
"api_token": "c5cab386-88d5-43e4-8ca2-b433d4307abb"
}
}
Resposta recebida:
Requisição falhou com erro:
Dica: Verifique se você está devidamente conectado à rede.
Se você é o mantenedor desta API, verifique se a sua API está em execução e se você habilitou o CORS.
Você pode verificar o console das Ferramentas de Desenvolvedor para informações de depuração.Link de pagamento
Listar os links de pagamento
requires authentication
Exemplo de Requisição:
$client = new \GuzzleHttp\Client();
$url = 'https://api.webpag.com.br/api/payment-links';
$response = $client->get(
$url,
[
'headers' => [
'auth-token' => '{CHAVE_API}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));curl --request GET \
--get "https://api.webpag.com.br/api/payment-links" \
--header "auth-token: {CHAVE_API}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"Exemplo de Resposta (200):
{
"data": [
{
"id": 5381,
"payer_id": null,
"expire_after_usage": false,
"name": "esse possimus cum",
"description": "Aut non tempore vel ut ratione odio ut molestias.",
"value": 20670,
"is_recurrence": 0,
"frequency": null,
"pix_enabled": 0,
"credit_enabled": 0,
"boleto_enabled": 1,
"due_date_boleto": 18,
"accept_after_due_date": 1,
"number_installments": 12,
"recurrence_time": null,
"url": "https://api.webpag.com.br/payment-link/5381/AYR23QzKLBlRr60v",
"return_url": "http://www.miller.com/in-commodi-adipisci-nobis-voluptatum"
},
{
"id": 5382,
"payer_id": null,
"expire_after_usage": false,
"name": "labore perspiciatis illo",
"description": "Dicta quisquam est eveniet rerum.",
"value": 116047,
"is_recurrence": 0,
"frequency": null,
"pix_enabled": 1,
"credit_enabled": 0,
"boleto_enabled": 1,
"due_date_boleto": 30,
"accept_after_due_date": 0,
"number_installments": 1,
"recurrence_time": null,
"url": "https://api.webpag.com.br/payment-link/5382/WxhqsLTpofIjfGeY",
"return_url": "http://gorczany.org/ea-libero-nam-sed.html"
}
]
}
Resposta recebida:
Requisição falhou com erro:
Dica: Verifique se você está devidamente conectado à rede.
Se você é o mantenedor desta API, verifique se a sua API está em execução e se você habilitou o CORS.
Você pode verificar o console das Ferramentas de Desenvolvedor para informações de depuração.Criar um link de pagamento
requires authentication
Exemplo de Requisição:
$client = new \GuzzleHttp\Client();
$url = 'https://api.webpag.com.br/api/payment-links/register';
$response = $client->post(
$url,
[
'headers' => [
'auth-token' => '{CHAVE_API}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'accepted_methods' => [
'credit_card',
'pix',
],
'name' => 'Pagamento de teste',
'description' => 'Pagamento de teste',
'value' => 1000,
'validity' => '2025-01-01 15:00',
'validity_boleto' => 3,
'number_installments' => 12,
'is_recurrence' => false,
'recurrence_time' => 12,
'payer_id' => 11,
'expire_after_usage' => false,
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));curl --request POST \
"https://api.webpag.com.br/api/payment-links/register" \
--header "auth-token: {CHAVE_API}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"accepted_methods\": [
\"credit_card\",
\"pix\"
],
\"name\": \"Pagamento de teste\",
\"description\": \"Pagamento de teste\",
\"value\": 1000,
\"validity\": \"2025-01-01 15:00\",
\"validity_boleto\": 3,
\"number_installments\": 12,
\"is_recurrence\": false,
\"recurrence_time\": 12,
\"payer_id\": 11,
\"expire_after_usage\": false
}"
Exemplo de Resposta (200):
{
"data": {
"id": 5383,
"payer_id": null,
"expire_after_usage": false,
"name": "voluptatibus quas tempore",
"description": "Iste dolore culpa dolores reiciendis.",
"value": 40960,
"is_recurrence": 0,
"frequency": null,
"pix_enabled": 1,
"credit_enabled": 0,
"boleto_enabled": 1,
"due_date_boleto": 4,
"accept_after_due_date": 0,
"number_installments": 7,
"recurrence_time": null,
"url": "https://api.webpag.com.br/payment-link/5383/pxDQYyhB0RDmoHPi",
"return_url": "http://fay.com/id-dolorum-culpa-aut-sit-praesentium-et-et-illum.html"
}
}
Resposta recebida:
Requisição falhou com erro:
Dica: Verifique se você está devidamente conectado à rede.
Se você é o mantenedor desta API, verifique se a sua API está em execução e se você habilitou o CORS.
Você pode verificar o console das Ferramentas de Desenvolvedor para informações de depuração.Pagador
Listar os pagadores cadastrados
requires authentication
Exemplo de Requisição:
$client = new \GuzzleHttp\Client();
$url = 'https://api.webpag.com.br/api/payers';
$response = $client->get(
$url,
[
'headers' => [
'auth-token' => '{CHAVE_API}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));curl --request GET \
--get "https://api.webpag.com.br/api/payers" \
--header "auth-token: {CHAVE_API}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"Exemplo de Resposta (200):
{
"data": [
{
"id": 249792,
"cpf_cnpj": "80424422034",
"is_business": false,
"email": "bsimonis@example.net",
"first_name": "aut",
"last_name": "consequatur",
"gender": "F",
"phone_number": "+55 (27) 99988-7766",
"birth_date": "1993-01-10",
"address": {
"city": "Colatina",
"state": "SP",
"number": "99999",
"street": "Rua dos Milagres",
"country": "BR",
"district": "Santa Efigênia",
"zip_code": "39777-999"
},
"use_boleto": true,
"status": 10,
"status_label": "Ativo",
"created_at": "2026-10-13 14:31:05",
"updated_at": "2026-10-13 14:31:05"
},
{
"id": 249793,
"cpf_cnpj": "74685944658",
"is_business": false,
"email": "von.tanner@example.com",
"first_name": "quasi",
"last_name": "est",
"gender": "F",
"phone_number": "+55 (27) 99988-7766",
"birth_date": "2004-11-24",
"address": {
"city": "Colatina",
"state": "SP",
"number": "99999",
"street": "Rua dos Milagres",
"country": "BR",
"district": "Santa Efigênia",
"zip_code": "39777-999"
},
"use_boleto": true,
"status": 10,
"status_label": "Ativo",
"created_at": "2026-10-13 14:31:05",
"updated_at": "2026-10-13 14:31:05"
}
]
}
Resposta recebida:
Requisição falhou com erro:
Dica: Verifique se você está devidamente conectado à rede.
Se você é o mantenedor desta API, verifique se a sua API está em execução e se você habilitou o CORS.
Você pode verificar o console das Ferramentas de Desenvolvedor para informações de depuração.Retorna dados de um pagador pelo ID
requires authentication
Exemplo de Requisição:
$client = new \GuzzleHttp\Client();
$url = 'https://api.webpag.com.br/api/payers/22';
$response = $client->get(
$url,
[
'headers' => [
'auth-token' => '{CHAVE_API}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));curl --request GET \
--get "https://api.webpag.com.br/api/payers/22" \
--header "auth-token: {CHAVE_API}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"Exemplo de Resposta (200):
{
"data": {
"id": 249794,
"cpf_cnpj": "92661172777",
"is_business": false,
"email": "schaefer.mafalda@example.com",
"first_name": "nobis",
"last_name": "doloremque",
"gender": "F",
"phone_number": "+55 (27) 99988-7766",
"birth_date": "1982-03-05",
"address": {
"city": "Colatina",
"state": "SP",
"number": "99999",
"street": "Rua dos Milagres",
"country": "BR",
"district": "Santa Efigênia",
"zip_code": "39777-999"
},
"use_boleto": true,
"status": 10,
"status_label": "Ativo",
"created_at": "2026-10-13 14:31:05",
"updated_at": "2026-10-13 14:31:05"
}
}
Resposta recebida:
Requisição falhou com erro:
Dica: Verifique se você está devidamente conectado à rede.
Se você é o mantenedor desta API, verifique se a sua API está em execução e se você habilitou o CORS.
Você pode verificar o console das Ferramentas de Desenvolvedor para informações de depuração.Registra um pagador
requires authentication
Exemplo de Requisição:
$client = new \GuzzleHttp\Client();
$url = 'https://api.webpag.com.br/api/payers/register';
$response = $client->post(
$url,
[
'headers' => [
'auth-token' => '{CHAVE_API}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'first_name' => 'João',
'last_name' => 'Silva',
'email' => 'eboehm@example.net',
'is_business' => false,
'cpf_cnpj' => '82110880023',
'phone_number' => '41999998888',
'birth_date' => '1998-01-05',
'address' => [
'zip_code' => '80000-000',
'street' => 'Rua das Flores',
'number' => '231',
'district' => 'Centro',
'city' => 'Curitiba',
'state' => 'PR',
'country' => 'BR',
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));curl --request POST \
"https://api.webpag.com.br/api/payers/register" \
--header "auth-token: {CHAVE_API}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"first_name\": \"João\",
\"last_name\": \"Silva\",
\"email\": \"eboehm@example.net\",
\"is_business\": false,
\"cpf_cnpj\": \"82110880023\",
\"phone_number\": \"41999998888\",
\"birth_date\": \"1998-01-05\",
\"address\": {
\"zip_code\": \"80000-000\",
\"street\": \"Rua das Flores\",
\"number\": \"231\",
\"district\": \"Centro\",
\"city\": \"Curitiba\",
\"state\": \"PR\",
\"country\": \"BR\"
}
}"
Exemplo de Resposta (200):
{
"data": {
"id": 249795,
"cpf_cnpj": "18329402681",
"is_business": false,
"email": "tyler16@example.net",
"first_name": "vero",
"last_name": "nulla",
"gender": "F",
"phone_number": "+55 (27) 99988-7766",
"birth_date": "2000-04-04",
"address": {
"city": "Colatina",
"state": "SP",
"number": "99999",
"street": "Rua dos Milagres",
"country": "BR",
"district": "Santa Efigênia",
"zip_code": "39777-999"
},
"use_boleto": true,
"status": 10,
"status_label": "Ativo",
"created_at": "2026-10-13 14:31:05",
"updated_at": "2026-10-13 14:31:05"
}
}
Resposta recebida:
Requisição falhou com erro:
Dica: Verifique se você está devidamente conectado à rede.
Se você é o mantenedor desta API, verifique se a sua API está em execução e se você habilitou o CORS.
Você pode verificar o console das Ferramentas de Desenvolvedor para informações de depuração.Atualiza um pagador pelo ID
requires authentication
Exemplo de Requisição:
$client = new \GuzzleHttp\Client();
$url = 'https://api.webpag.com.br/api/payers/enim/update';
$response = $client->put(
$url,
[
'headers' => [
'auth-token' => '{CHAVE_API}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'first_name' => null,
'last_name' => null,
'email' => 'zmarquardt@example.net',
'is_business' => null,
'cpf_cnpj' => '82110880023',
'phone_number' => '41999998888',
'birth_date' => '1998-01-05',
'address' => [
'zip_code' => '80000-000',
'street' => 'Rua das Flores',
'number' => '231',
'district' => 'Centro',
'city' => 'Curitiba',
'state' => 'PR',
'country' => 'BR',
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));curl --request PUT \
"https://api.webpag.com.br/api/payers/enim/update" \
--header "auth-token: {CHAVE_API}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"first_name\": null,
\"last_name\": null,
\"email\": \"zmarquardt@example.net\",
\"is_business\": null,
\"cpf_cnpj\": \"82110880023\",
\"phone_number\": \"41999998888\",
\"birth_date\": \"1998-01-05\",
\"address\": {
\"zip_code\": \"80000-000\",
\"street\": \"Rua das Flores\",
\"number\": \"231\",
\"district\": \"Centro\",
\"city\": \"Curitiba\",
\"state\": \"PR\",
\"country\": \"BR\"
}
}"
Exemplo de Resposta (200):
{
"data": {
"id": 249796,
"cpf_cnpj": "21751689301",
"is_business": false,
"email": "elsa30@example.com",
"first_name": "sed",
"last_name": "ipsum",
"gender": "F",
"phone_number": "+55 (27) 99988-7766",
"birth_date": "2022-11-11",
"address": {
"city": "Colatina",
"state": "SP",
"number": "99999",
"street": "Rua dos Milagres",
"country": "BR",
"district": "Santa Efigênia",
"zip_code": "39777-999"
},
"use_boleto": false,
"status": 10,
"status_label": "Ativo",
"created_at": "2026-10-13 14:31:05",
"updated_at": "2026-10-13 14:31:05"
}
}
Resposta recebida:
Requisição falhou com erro:
Dica: Verifique se você está devidamente conectado à rede.
Se você é o mantenedor desta API, verifique se a sua API está em execução e se você habilitou o CORS.
Você pode verificar o console das Ferramentas de Desenvolvedor para informações de depuração.Inativa um pagador
requires authentication
Exemplo de Requisição:
$client = new \GuzzleHttp\Client();
$url = 'https://api.webpag.com.br/api/payers/22/inactivate';
$response = $client->put(
$url,
[
'headers' => [
'auth-token' => '{CHAVE_API}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));curl --request PUT \
"https://api.webpag.com.br/api/payers/22/inactivate" \
--header "auth-token: {CHAVE_API}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"Exemplo de Resposta (200):
{
"data": {
"id": 249797,
"cpf_cnpj": "97402704769",
"is_business": false,
"email": "ismith@example.org",
"first_name": "id",
"last_name": "rerum",
"gender": "F",
"phone_number": "+55 (27) 99988-7766",
"birth_date": "1984-07-17",
"address": {
"city": "Colatina",
"state": "SP",
"number": "99999",
"street": "Rua dos Milagres",
"country": "BR",
"district": "Santa Efigênia",
"zip_code": "39777-999"
},
"use_boleto": false,
"status": 10,
"status_label": "Ativo",
"created_at": "2026-10-13 14:31:05",
"updated_at": "2026-10-13 14:31:05"
}
}
Resposta recebida:
Requisição falhou com erro:
Dica: Verifique se você está devidamente conectado à rede.
Se você é o mantenedor desta API, verifique se a sua API está em execução e se você habilitou o CORS.
Você pode verificar o console das Ferramentas de Desenvolvedor para informações de depuração.Salvar cartão para um pagador
requires authentication
Exemplo de Requisição:
$client = new \GuzzleHttp\Client();
$url = 'https://api.webpag.com.br/api/payers/quos/creditcard';
$response = $client->post(
$url,
[
'headers' => [
'auth-token' => '{CHAVE_API}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'number' => '4111111111111111',
'name' => 'João da Silva',
'expiration_month' => '12',
'expiration_year' => '2025',
'security_code' => '999',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));curl --request POST \
"https://api.webpag.com.br/api/payers/quos/creditcard" \
--header "auth-token: {CHAVE_API}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"number\": \"4111111111111111\",
\"name\": \"João da Silva\",
\"expiration_month\": \"12\",
\"expiration_year\": \"2025\",
\"security_code\": \"999\"
}"
Exemplo de Resposta (200):
{
"data": {
"id": 350999,
"last_numbers": "5065",
"active": true,
"created_at": "2026-10-13 14:31:05"
}
}
Resposta recebida:
Requisição falhou com erro:
Dica: Verifique se você está devidamente conectado à rede.
Se você é o mantenedor desta API, verifique se a sua API está em execução e se você habilitou o CORS.
Você pode verificar o console das Ferramentas de Desenvolvedor para informações de depuração.Remove um cartão de um pagador
requires authentication
Exemplo de Requisição:
$client = new \GuzzleHttp\Client();
$url = 'https://api.webpag.com.br/api/payers/provident/creditcard/rerum/remove';
$response = $client->delete(
$url,
[
'headers' => [
'auth-token' => '{CHAVE_API}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));curl --request DELETE \
"https://api.webpag.com.br/api/payers/provident/creditcard/rerum/remove" \
--header "auth-token: {CHAVE_API}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"Resposta recebida:
Requisição falhou com erro:
Dica: Verifique se você está devidamente conectado à rede.
Se você é o mantenedor desta API, verifique se a sua API está em execução e se você habilitou o CORS.
Você pode verificar o console das Ferramentas de Desenvolvedor para informações de depuração.Pagamentos
Listar os pagamentos cadastrados
requires authentication
Exemplo de Requisição:
$client = new \GuzzleHttp\Client();
$url = 'https://api.webpag.com.br/api/payments';
$response = $client->get(
$url,
[
'headers' => [
'auth-token' => '{CHAVE_API}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));curl --request GET \
--get "https://api.webpag.com.br/api/payments" \
--header "auth-token: {CHAVE_API}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"Exemplo de Resposta (200):
{
"data": [
{
"id": 682034,
"payer_id": 249799,
"card_id": null,
"name": "Dr. Brody Will",
"amount": 705,
"amount_refunded": 0,
"fee_value": "28.67",
"refunded_fee": 0,
"installments": 3,
"is_recurrent": false,
"recurrence_code": 35251231,
"frequency": null,
"method": 10,
"method_label": "Cartão de Crédito",
"method_slug": "credit_card",
"boleto": {
"id": 29342,
"linha_digitavel": "206497249344235",
"sequencial_code": null,
"nosso_numero": "5280914592",
"codigo_barras": "885495777505080",
"due_date": null,
"issue_date": "2004-04-17T13:23:14.000000Z",
"amount": 569.97,
"interest": "88.425",
"fine": "65.401",
"accept_after_due_date": true,
"boleto_url": "https://api.webpag.com.br/r/b4947c57-27ee"
},
"notification_url": null,
"pix": {
"id": 434316,
"uuid": null,
"business_id": 8602,
"payment_id": 682033,
"name": "necessitatibus magnam ut",
"txid": "UvdwFAhU1BHz8po06biWY0p29xjl0uGQ",
"key": "Ea maiores molestiae labore omnis quae reiciendis.",
"qrcode_data": "Ea maiores molestiae labore omnis quae reiciendis.",
"amount": "244.45",
"expiration_date": "2026-10-14T17:31:05.000000Z",
"status": 10,
"created_at": "2026-10-13T17:31:05.000000Z",
"updated_at": "2026-10-13T17:31:05.000000Z"
},
"installments_paid": 0,
"spplited": false,
"split_without_fee": false,
"soft_descriptor": null,
"order_id": null,
"active": true,
"status": 10,
"status_label": "Aguardando",
"start_date": "2026-09-19 02:26",
"next_date": "2026-02-10 20:42",
"next_recurrence_date": null,
"created_at": "2026-03-15 20:45",
"paid_at": "2026-09-16 14:40",
"updated_at": "2026-07-22 07:45",
"receipt_pdf_path": "https://api.webpag.com.br/payments/01M4V52RS1VK1ETVZ476ZPXQ7N/pdf",
"card_flag": 10,
"card_flag_label": "Amex"
},
{
"id": 682036,
"payer_id": 249801,
"card_id": null,
"name": "Prof. Nelson Parker DVM",
"amount": 930,
"amount_refunded": 0,
"fee_value": "57.04",
"refunded_fee": 0,
"installments": 1,
"is_recurrent": false,
"recurrence_code": 46297177,
"frequency": null,
"method": 10,
"method_label": "Cartão de Crédito",
"method_slug": "credit_card",
"boleto": {
"id": 29343,
"linha_digitavel": "195706105961681",
"sequencial_code": null,
"nosso_numero": "2649966196",
"codigo_barras": "519842398856186",
"due_date": "2020-08-15T16:28:00.000000Z",
"issue_date": null,
"amount": 140.35,
"interest": "95.861",
"fine": "58.666",
"accept_after_due_date": null,
"boleto_url": "https://api.webpag.com.br/r/2b715096-0b7a"
},
"notification_url": null,
"pix": {
"id": 434317,
"uuid": null,
"business_id": 8608,
"payment_id": 682035,
"name": "doloribus voluptatem temporibus",
"txid": "xHLA0OJcfEsSj3Mwh97SZJNnTYcvdzm9",
"key": "Consequatur cum rem libero et omnis. Velit omnis numquam velit ut.",
"qrcode_data": "Consequatur cum rem libero et omnis. Velit omnis numquam velit ut.",
"amount": "245.07",
"expiration_date": "2026-10-14T17:31:05.000000Z",
"status": 10,
"created_at": "2026-10-13T17:31:05.000000Z",
"updated_at": "2026-10-13T17:31:05.000000Z"
},
"installments_paid": 0,
"spplited": false,
"split_without_fee": false,
"soft_descriptor": null,
"order_id": null,
"active": true,
"status": 10,
"status_label": "Aguardando",
"start_date": "2026-05-10 13:25",
"next_date": "2026-01-20 22:58",
"next_recurrence_date": null,
"created_at": "2026-06-26 06:39",
"paid_at": "2025-11-14 03:10",
"updated_at": "2026-06-06 20:01",
"receipt_pdf_path": "https://api.webpag.com.br/payments/01M4V52RTKNPNCS0DKKR5PX2FV/pdf",
"card_flag": 10,
"card_flag_label": "Amex"
}
]
}
Resposta recebida:
Requisição falhou com erro:
Dica: Verifique se você está devidamente conectado à rede.
Se você é o mantenedor desta API, verifique se a sua API está em execução e se você habilitou o CORS.
Você pode verificar o console das Ferramentas de Desenvolvedor para informações de depuração.Processar ou criar um pagamento
requires authentication
Quando informado o cartão, o pagamento é realizado no mesmo instante. Quando é boleto ou Pix, o pagamento é registrado e aguarda a compensação. Você poderá registrar o pagador e cartão de forma separada, e informar o ID do pagador.
Exemplo de Requisição:
$client = new \GuzzleHttp\Client();
$url = 'https://api.webpag.com.br/api/payments/process';
$response = $client->post(
$url,
[
'headers' => [
'auth-token' => '{CHAVE_API}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'payer_id' => 15,
'name' => 'Pagamento de teste',
'amount' => 1500,
'installments' => 1,
'method' => 'credit_card',
'card_token' => 'tok_01j9h8g7f6e5d4c3b2a1',
'card' => [
'number' => '4111111111111111',
'name' => 'João da Silva',
'expiration_month' => '12',
'expiration_year' => '2024',
'security_code' => '123',
],
'split_without_fee' => false,
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));curl --request POST \
"https://api.webpag.com.br/api/payments/process" \
--header "auth-token: {CHAVE_API}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"payer_id\": 15,
\"name\": \"Pagamento de teste\",
\"amount\": 1500,
\"installments\": 1,
\"method\": \"credit_card\",
\"card_token\": \"tok_01j9h8g7f6e5d4c3b2a1\",
\"card\": {
\"number\": \"4111111111111111\",
\"name\": \"João da Silva\",
\"expiration_month\": \"12\",
\"expiration_year\": \"2024\",
\"security_code\": \"123\"
},
\"split_without_fee\": false
}"
Exemplo de Resposta (200, Pagamento processado):
{
"data": {
"id": 2825,
"business": {
"id": 537,
"name": "Empresa Exemplo"
},
"payer_id": 881,
"card_id": null,
"name": "Pagamento utilizando pix",
"amount": 1000,
"fee_value": "3.62",
"installments": 1,
"is_recurrent": false,
"recurrence_code": null,
"frequency": null,
"order_id": "2159",
"method": 30,
"method_label": "Boleto",
"method_slug": "bank_slip",
"boleto": {
"id": 265,
"linha_digitavel": "00000000000000000000000000000000000000000000000",
"sequencial_code": null,
"nosso_numero": "1111",
"codigo_barras": "00000000000000000000000000000000000000000000",
"due_date": "2024-09-09T13:42:47.000000Z",
"issue_date": "2024-09-06T13:42:47.000000Z",
"amount": 10,
"interest": "7.000",
"fine": "4.000",
"accept_after_due_date": true,
"boleto_url": "http://localhost:81/r/048cfb0d-e9ed"
},
"notification_url": "https://exemplo.com.br/order-confirm/4df6e224-259e-444e-9245-93ad17aad277",
"pix": {
"id": 39,
"uuid": "4222b7d7-0c98-4c48-b94a-49d23a98c245",
"business_id": 45,
"payment_id": 39488,
"txid": "FdbMqfiIT2ki7FSKdMlofsNjzF",
"key": "9e881f18-cc66-4fc7-8f2c-a795dbb2bfc1",
"qrcode_data": "00020101021226870014br.gov.bcb.pix2565qrcodepix-h.bb.com.br/pix/v2/8c672b36-459e-48dc-aa14-0544186e321b520400005303986540550.005802BR5921EMPRESA EXEMPLO6012CIDADE EXEMPLO62070503***63044061",
"amount": "50.00",
"expiration_date": "2024-05-08T21:43:33.000000Z",
"status": 10,
"created_at": "2024-05-08T20:43:33.000000Z",
"updated_at": "2024-05-08T20:43:33.000000Z"
},
"spplited": false,
"split_without_fee": false,
"gateway": "IUGU",
"active": true,
"status": 10,
"status_label": "Disponível",
"start_date": null,
"next_date": null,
"transactions": [
{
"id": 3830,
"type": 10,
"type_label": "Aprovação",
"transaction_id": null,
"response_status": "OK",
"errors": null,
"status": 10,
"status_label": "Sucesso",
"created_at": "2024-09-06 10:42"
}
],
"splits": [],
"created_at": "2024-09-06 10:42",
"paid_at": null,
"updated_at": "2024-09-06 10:42",
"receipt_pdf_path": "http://localhost:81/payments/71a4545b2c0275d50f02d561a/pdf",
"card_flag": null,
"card_flag_label": null
}
}
Exemplo de Resposta (422, Erro ao processar):
{
"error": "Erro ao processar pagamento",
"error_code": 20,
"error_previous": "Erro ao processar pagamento"
}
Resposta recebida:
Requisição falhou com erro:
Dica: Verifique se você está devidamente conectado à rede.
Se você é o mantenedor desta API, verifique se a sua API está em execução e se você habilitou o CORS.
Você pode verificar o console das Ferramentas de Desenvolvedor para informações de depuração.Estornar um pagamento
requires authentication
Estorna um pagamento específico. Por padrão, o valor total do pagamento é estornado. Para estornar um valor específico, informe o valor em centavos. O reembolso é processado de forma assíncrona. A resposta retorna o registro do reembolso com status "pending".
Exemplo de Requisição:
$client = new \GuzzleHttp\Client();
$url = 'https://api.webpag.com.br/api/payments/15/refund';
$response = $client->put(
$url,
[
'headers' => [
'auth-token' => '{CHAVE_API}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'value' => 1500,
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));curl --request PUT \
"https://api.webpag.com.br/api/payments/15/refund" \
--header "auth-token: {CHAVE_API}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"value\": 1500
}"
Exemplo de Resposta (200):
{
"data": {
"id": "277bddd5-cf57-4403-86a3-349e254efc4a",
"payment_id": 436984,
"business_id": 3789,
"status": 40,
"status_label": "Sucesso",
"refund_amount": 6500,
"refund_fee": 125,
"before_amount": 6500,
"before_fee": 125,
"after_amount": 0,
"after_fee": 0,
"credit_schedule_refund": 6375,
"financial_entry_refund": 0,
"refund_receipt_url": "https://api.webpag.com.br/refunds/277bddd5-cf57-4403-86a3-349e254efc4a/pdf",
"processed_at": null,
"created_at": "2025-10-13 08:56",
"updated_at": "2025-10-13 08:56"
}
}
Resposta recebida:
Requisição falhou com erro:
Dica: Verifique se você está devidamente conectado à rede.
Se você é o mantenedor desta API, verifique se a sua API está em execução e se você habilitou o CORS.
Você pode verificar o console das Ferramentas de Desenvolvedor para informações de depuração.Consultar estorno
requires authentication
Retorna os detalhes de um estorno específico.
Exemplo de Requisição:
$client = new \GuzzleHttp\Client();
$url = 'https://api.webpag.com.br/api/payments/refunds/01J9XYZABCDE1234567890';
$response = $client->get(
$url,
[
'headers' => [
'auth-token' => '{CHAVE_API}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));curl --request GET \
--get "https://api.webpag.com.br/api/payments/refunds/01J9XYZABCDE1234567890" \
--header "auth-token: {CHAVE_API}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"Exemplo de Resposta (200):
{
"data": {
"id": "277bddd5-cf57-4403-86a3-349e254efc4a",
"payment_id": 436984,
"business_id": 3789,
"status": 40,
"status_label": "Sucesso",
"refund_amount": 6500,
"refund_fee": 125,
"before_amount": 6500,
"before_fee": 125,
"after_amount": 0,
"after_fee": 0,
"credit_schedule_refund": 6375,
"financial_entry_refund": 0,
"refund_receipt_url": "https://api.webpag.com.br/refunds/277bddd5-cf57-4403-86a3-349e254efc4a/pdf",
"processed_at": null,
"created_at": "2025-10-13 08:56",
"updated_at": "2025-10-13 08:56"
}
}
Exemplo de Resposta (404):
{
"message": "Estorno não encontrado."
}
Resposta recebida:
Requisição falhou com erro:
Dica: Verifique se você está devidamente conectado à rede.
Se você é o mantenedor desta API, verifique se a sua API está em execução e se você habilitou o CORS.
Você pode verificar o console das Ferramentas de Desenvolvedor para informações de depuração.Consultar um pagamento
requires authentication
Retorna os detalhes de um pagamento específico.
Exemplo de Requisição:
$client = new \GuzzleHttp\Client();
$url = 'https://api.webpag.com.br/api/payments/6';
$response = $client->get(
$url,
[
'headers' => [
'auth-token' => '{CHAVE_API}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));curl --request GET \
--get "https://api.webpag.com.br/api/payments/6" \
--header "auth-token: {CHAVE_API}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"Exemplo de Resposta (200):
{
"data": {
"id": 682038,
"payer_id": 249803,
"card_id": null,
"name": "Alden Mertz V",
"amount": 345,
"amount_refunded": 0,
"fee_value": "42.36",
"refunded_fee": 0,
"installments": 5,
"is_recurrent": false,
"recurrence_code": 61684318,
"frequency": null,
"method": 10,
"method_label": "Cartão de Crédito",
"method_slug": "credit_card",
"boleto": {
"id": 29344,
"linha_digitavel": "559482173320543",
"sequencial_code": null,
"nosso_numero": "8590562026",
"codigo_barras": "824477222651707",
"due_date": "2017-11-06T01:07:33.000000Z",
"issue_date": null,
"amount": 1783.27,
"interest": "11.493",
"fine": "8.634",
"accept_after_due_date": true,
"boleto_url": "https://api.webpag.com.br/r/ab50d702-9688"
},
"notification_url": null,
"pix": {
"id": 434318,
"uuid": null,
"business_id": 8614,
"payment_id": 682037,
"name": "ad fugiat qui",
"txid": "tWYJV1u67DRPN3gNt1VvGX8B0VRMLmXv",
"key": "",
"qrcode_data": "",
"amount": "197.52",
"expiration_date": "2026-10-14T17:31:06.000000Z",
"status": 10,
"created_at": "2026-10-13T17:31:06.000000Z",
"updated_at": "2026-10-13T17:31:06.000000Z"
},
"installments_paid": 0,
"spplited": false,
"split_without_fee": false,
"soft_descriptor": null,
"order_id": null,
"active": true,
"status": 10,
"status_label": "Aguardando",
"start_date": "2025-11-12 00:40",
"next_date": "2026-06-22 08:32",
"next_recurrence_date": null,
"created_at": "2026-09-15 05:19",
"paid_at": "2026-03-14 02:18",
"updated_at": "2026-05-21 00:08",
"receipt_pdf_path": "https://api.webpag.com.br/payments/01M4V52RY0HQSMV0DDR2SMHBHN/pdf",
"card_flag": 10,
"card_flag_label": "Amex"
}
}
Resposta recebida:
Requisição falhou com erro:
Dica: Verifique se você está devidamente conectado à rede.
Se você é o mantenedor desta API, verifique se a sua API está em execução e se você habilitou o CORS.
Você pode verificar o console das Ferramentas de Desenvolvedor para informações de depuração.Cancelar um pagamento
requires authentication
Solicita o cancelamento de um pagamento que ainda está aguardando, seja Boleto ou PIX.
Exemplo de Requisição:
$client = new \GuzzleHttp\Client();
$url = 'https://api.webpag.com.br/api/payments/6';
$response = $client->delete(
$url,
[
'headers' => [
'auth-token' => '{CHAVE_API}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));curl --request DELETE \
"https://api.webpag.com.br/api/payments/6" \
--header "auth-token: {CHAVE_API}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"Exemplo de Resposta (200):
{
"data": {
"id": 682040,
"payer_id": 249805,
"card_id": null,
"name": "Maribel Lind",
"amount": 843,
"amount_refunded": 0,
"fee_value": "36.77",
"refunded_fee": 0,
"installments": 1,
"is_recurrent": false,
"recurrence_code": 65966722,
"frequency": null,
"method": 10,
"method_label": "Cartão de Crédito",
"method_slug": "credit_card",
"boleto": {
"id": 29345,
"linha_digitavel": "243130008613131",
"sequencial_code": null,
"nosso_numero": "8926190512",
"codigo_barras": "467502601410764",
"due_date": "1979-09-05T06:00:53.000000Z",
"issue_date": null,
"amount": 7711.97,
"interest": "46.210",
"fine": "93.799",
"accept_after_due_date": true,
"boleto_url": "https://api.webpag.com.br/r/578f0a27-1bde"
},
"notification_url": null,
"pix": {
"id": 434319,
"uuid": null,
"business_id": 8620,
"payment_id": 682039,
"name": "quibusdam ut hic",
"txid": "pbX32O45HlJspWWt72GkIwJOBivnCqEE",
"key": "Rerum dolores maiores accusamus nam.",
"qrcode_data": "Rerum dolores maiores accusamus nam.",
"amount": "325.21",
"expiration_date": "2026-10-14T17:31:06.000000Z",
"status": 10,
"created_at": "2026-10-13T17:31:06.000000Z",
"updated_at": "2026-10-13T17:31:06.000000Z"
},
"installments_paid": 0,
"spplited": false,
"split_without_fee": false,
"soft_descriptor": null,
"order_id": null,
"active": true,
"status": 10,
"status_label": "Aguardando",
"start_date": "2026-10-09 04:53",
"next_date": "2026-03-03 08:41",
"next_recurrence_date": null,
"created_at": "2026-03-05 11:40",
"paid_at": "2026-03-16 22:50",
"updated_at": "2026-07-09 20:58",
"receipt_pdf_path": "https://api.webpag.com.br/payments/01M4V52S0461F584T9JWEF8TSW/pdf",
"card_flag": 10,
"card_flag_label": "Amex"
}
}
Exemplo de Resposta (202):
{
"message": "Cancelamento solicitado com sucesso."
}
Exemplo de Resposta (404):
{
"message": "Pagamento não encontrado."
}
Exemplo de Resposta (422):
{
"message": "Somente pagamentos PIX ou Boleto aguardando podem ser cancelados por este endpoint."
}
Resposta recebida:
Requisição falhou com erro:
Dica: Verifique se você está devidamente conectado à rede.
Se você é o mantenedor desta API, verifique se a sua API está em execução e se você habilitou o CORS.
Você pode verificar o console das Ferramentas de Desenvolvedor para informações de depuração.Marcar pagamento como pago (Apenas Sandbox/Desenvolvimento)
requires authentication
Este endpoint está disponível APENAS em ambiente de desenvolvimento. Marca manualmente um pagamento de Boleto ou PIX como pago para testar o fluxo de pagamento.
Exemplo de Requisição:
$client = new \GuzzleHttp\Client();
$url = 'https://api.webpag.com.br/api/payments/123/mark-as-paid-dev';
$response = $client->post(
$url,
[
'headers' => [
'auth-token' => '{CHAVE_API}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));curl --request POST \
"https://api.webpag.com.br/api/payments/123/mark-as-paid-dev" \
--header "auth-token: {CHAVE_API}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"Exemplo de Resposta (403):
{
"message": "Este endpoint está disponível apenas em ambiente de desenvolvimento."
}
Exemplo de Resposta (404):
{
"message": "Pagamento não encontrado."
}
Exemplo de Resposta (422):
{
"message": "O método de pagamento deve ser PIX ou Boleto.",
"errors": {
"method": [
"O método de pagamento deve ser PIX ou Boleto."
]
}
}
Resposta recebida:
Requisição falhou com erro:
Dica: Verifique se você está devidamente conectado à rede.
Se você é o mantenedor desta API, verifique se a sua API está em execução e se você habilitou o CORS.
Você pode verificar o console das Ferramentas de Desenvolvedor para informações de depuração.Saques/Transferências
Listar saques/transferências
requires authentication
Lista todas as solicitações de saque/transferência da empresa.
Exemplo de Requisição:
$client = new \GuzzleHttp\Client();
$url = 'https://api.webpag.com.br/api/transfers';
$response = $client->get(
$url,
[
'headers' => [
'auth-token' => '{CHAVE_API}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'page' => '1',
'per_page' => '15',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));curl --request GET \
--get "https://api.webpag.com.br/api/transfers?page=1&per_page=15" \
--header "auth-token: {CHAVE_API}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"Exemplo de Resposta (200):
{
"data": [
{
"id": 12,
"amount": 241542,
"destination_type": 10,
"destination_type_name": "Minha conta bancária",
"destination_business_id": null,
"service_fee": 480,
"fee_service": 480,
"debited_amount": 242022,
"service_fee_type": "F",
"transfer_type": 10,
"transfer_type_name": "Normal",
"business_notes": "Payments ID: 27,28,24,26",
"admin_notes": "Banco Itaú\r\nAg: 1568\r\nC/C: 06186-3\r\nCNPJ: 76.591.569.0001-30\r\nRazão Social: Associação Hospital de Proteção a Infância Dr. Raul Carneiro",
"notification_url": null,
"status": 40,
"status_name": "Paga",
"created_at": "2023-04-30T03:00:04.000000Z",
"finished_at": "2023-05-02T22:54:50.000000Z",
"updated_at": "2023-05-02T22:54:50.000000Z",
"pix_key": null,
"pix_key_type": null,
"account_document": null,
"account_holder": null
},
{
"id": 12,
"amount": 241542,
"destination_type": 10,
"destination_type_name": "Minha conta bancária",
"destination_business_id": null,
"service_fee": 480,
"fee_service": 480,
"debited_amount": 242022,
"service_fee_type": "F",
"transfer_type": 10,
"transfer_type_name": "Normal",
"business_notes": "Payments ID: 27,28,24,26",
"admin_notes": "Banco Itaú\r\nAg: 1568\r\nC/C: 06186-3\r\nCNPJ: 76.591.569.0001-30\r\nRazão Social: Associação Hospital de Proteção a Infância Dr. Raul Carneiro",
"notification_url": null,
"status": 40,
"status_name": "Paga",
"created_at": "2023-04-30T03:00:04.000000Z",
"finished_at": "2023-05-02T22:54:50.000000Z",
"updated_at": "2023-05-02T22:54:50.000000Z",
"pix_key": null,
"pix_key_type": null,
"account_document": null,
"account_holder": null
}
]
}
Exemplo de Resposta (200):
{
"data": [
{
"id": 101,
"amount": 2500,
"destination_type": 10,
"destination_type_name": "Minha conta bancária",
"destination_business_id": null,
"service_fee": 125,
"fee_service": 125,
"debited_amount": 2625,
"service_fee_type": null,
"business_notes": "Saque de exemplo",
"admin_notes": "Nenhuma observação interna.",
"notification_url": null,
"status": 20,
"status_name": "Em processamento",
"created_at": "2026-02-01T10:00:00.000000Z",
"finished_at": null,
"updated_at": "2026-02-01T10:05:00.000000Z",
"pix_key": "chave-pix-exemplo-1",
"pix_key_type": 20,
"account_document": "00000000000",
"account_holder": "Empresa Exemplo 1"
},
{
"id": 102,
"amount": 8000,
"destination_type": 30,
"destination_type_name": "Outra conta bancária",
"destination_business_id": null,
"service_fee": 400,
"fee_service": 400,
"debited_amount": 8400,
"service_fee_type": null,
"business_notes": "Transferência de teste",
"admin_notes": "Transferência processada com sucesso.",
"notification_url": "https://webhook.exemplo.com/transfer/102",
"status": 30,
"status_name": "Concluída",
"created_at": "2026-02-02T09:30:00.000000Z",
"finished_at": "2026-02-02T09:35:00.000000Z",
"updated_at": "2026-02-02T09:35:00.000000Z",
"pix_key": "chave-pix-exemplo-2",
"pix_key_type": 10,
"account_document": "11111111111",
"account_holder": "Empresa Exemplo 2"
}
]
}
Resposta recebida:
Requisição falhou com erro:
Dica: Verifique se você está devidamente conectado à rede.
Se você é o mantenedor desta API, verifique se a sua API está em execução e se você habilitou o CORS.
Você pode verificar o console das Ferramentas de Desenvolvedor para informações de depuração.Solicitar um saque (transferência)
requires authentication
Cria uma solicitação de saque/transferência de valores da conta da empresa. O saque pode ser feito para a conta bancária própria da empresa ou para outra conta bancária via PIX.
Exemplo de Requisição:
$client = new \GuzzleHttp\Client();
$url = 'https://api.webpag.com.br/api/transfers';
$response = $client->post(
$url,
[
'headers' => [
'auth-token' => '{CHAVE_API}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'amount' => '100',
'type' => 10,
'transfer_type' => 20,
'notes' => 'Saque para pagamento de fornecedores',
'pix_key' => '12.345.678/0001-90',
'pix_key_type' => 'cnpj',
'account_document' => '12.345.678/0001-90',
'account_holder' => 'João Silva',
'notification_url' => 'https://exemplo.com/webhook/transfer',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));curl --request POST \
"https://api.webpag.com.br/api/transfers" \
--header "auth-token: {CHAVE_API}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"amount\": \"100\",
\"type\": 10,
\"transfer_type\": 20,
\"notes\": \"Saque para pagamento de fornecedores\",
\"pix_key\": \"12.345.678\\/0001-90\",
\"pix_key_type\": \"cnpj\",
\"account_document\": \"12.345.678\\/0001-90\",
\"account_holder\": \"João Silva\",
\"notification_url\": \"https:\\/\\/exemplo.com\\/webhook\\/transfer\"
}"
Exemplo de Resposta (200):
{
"data": {
"id": 12,
"amount": 241542,
"destination_type": 10,
"destination_type_name": "Minha conta bancária",
"destination_business_id": null,
"service_fee": 480,
"fee_service": 480,
"debited_amount": 242022,
"service_fee_type": "F",
"transfer_type": 10,
"transfer_type_name": "Normal",
"business_notes": "Payments ID: 27,28,24,26",
"admin_notes": "Banco Itaú\r\nAg: 1568\r\nC/C: 06186-3\r\nCNPJ: 76.591.569.0001-30\r\nRazão Social: Associação Hospital de Proteção a Infância Dr. Raul Carneiro",
"notification_url": null,
"status": 40,
"status_name": "Paga",
"created_at": "2023-04-30T03:00:04.000000Z",
"finished_at": "2023-05-02T22:54:50.000000Z",
"updated_at": "2023-05-02T22:54:50.000000Z",
"pix_key": null,
"pix_key_type": null,
"account_document": null,
"account_holder": null
}
}
Exemplo de Resposta (201):
{
"id": 123,
"amount": 5000,
"destination_type": 10,
"destination_type_name": "Minha conta bancária",
"destination_business_id": null,
"service_fee": 250,
"fee_service": 250,
"debited_amount": 5250,
"service_fee_type": null,
"business_notes": "Saque para despesas gerais",
"admin_notes": "Transferência criada com sucesso.",
"notification_url": "https://webhook.exemplo.com/transfer",
"status": 10,
"status_name": "Solicitado",
"created_at": "2026-01-01T12:00:00.000000Z",
"finished_at": null,
"updated_at": "2026-01-01T12:00:00.000000Z",
"pix_key": "chave-pix-exemplo",
"pix_key_type": 20,
"account_document": "00000000000",
"account_holder": "Empresa Exemplo"
}
Exemplo de Resposta (422):
{
"message": "The given data was invalid.",
"errors": {
"amount": [
"O valor é obrigatório."
],
"type": [
"O tipo de destino é obrigatório."
]
}
}
Resposta recebida:
Requisição falhou com erro:
Dica: Verifique se você está devidamente conectado à rede.
Se você é o mantenedor desta API, verifique se a sua API está em execução e se você habilitou o CORS.
Você pode verificar o console das Ferramentas de Desenvolvedor para informações de depuração.Obter detalhes de um saque/transferência
requires authentication
Retorna os detalhes de uma solicitação específica de saque/transferência.
Exemplo de Requisição:
$client = new \GuzzleHttp\Client();
$url = 'https://api.webpag.com.br/api/transfers/123';
$response = $client->get(
$url,
[
'headers' => [
'auth-token' => '{CHAVE_API}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));curl --request GET \
--get "https://api.webpag.com.br/api/transfers/123" \
--header "auth-token: {CHAVE_API}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"Exemplo de Resposta (200):
{
"data": {
"id": 12,
"amount": 241542,
"destination_type": 10,
"destination_type_name": "Minha conta bancária",
"destination_business_id": null,
"service_fee": 480,
"fee_service": 480,
"debited_amount": 242022,
"service_fee_type": "F",
"transfer_type": 10,
"transfer_type_name": "Normal",
"business_notes": "Payments ID: 27,28,24,26",
"admin_notes": "Banco Itaú\r\nAg: 1568\r\nC/C: 06186-3\r\nCNPJ: 76.591.569.0001-30\r\nRazão Social: Associação Hospital de Proteção a Infância Dr. Raul Carneiro",
"notification_url": null,
"status": 40,
"status_name": "Paga",
"created_at": "2023-04-30T03:00:04.000000Z",
"finished_at": "2023-05-02T22:54:50.000000Z",
"updated_at": "2023-05-02T22:54:50.000000Z",
"pix_key": null,
"pix_key_type": null,
"account_document": null,
"account_holder": null
}
}
Exemplo de Resposta (200):
{
"id": 200,
"amount": 7500,
"destination_type": 10,
"destination_type_name": "Minha conta bancária",
"destination_business_id": null,
"service_fee": 375,
"fee_service": 375,
"debited_amount": 7875,
"service_fee_type": null,
"business_notes": "Saque de exemplo para relatório",
"admin_notes": "Nenhuma observação interna.",
"notification_url": null,
"status": 20,
"status_name": "Em processamento",
"created_at": "2026-02-03T14:00:00.000000Z",
"finished_at": null,
"updated_at": "2026-02-03T14:05:00.000000Z",
"pix_key": "chave-pix-exemplo-unica",
"pix_key_type": 20,
"account_document": "22222222222",
"account_holder": "Empresa Exemplo Única"
}
Exemplo de Resposta (404):
{
"message": "Transferência não encontrada."
}
Resposta recebida:
Requisição falhou com erro:
Dica: Verifique se você está devidamente conectado à rede.
Se você é o mantenedor desta API, verifique se a sua API está em execução e se você habilitou o CORS.
Você pode verificar o console das Ferramentas de Desenvolvedor para informações de depuração.Cancelar um saque/transferência
requires authentication
Cancela uma solicitação de saque/transferência. Só é possível cancelar transferências que estejam com status "Solicitado" (10) ou "Processando" (50).
Exemplo de Requisição:
$client = new \GuzzleHttp\Client();
$url = 'https://api.webpag.com.br/api/transfers/123';
$response = $client->delete(
$url,
[
'headers' => [
'auth-token' => '{CHAVE_API}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));curl --request DELETE \
"https://api.webpag.com.br/api/transfers/123" \
--header "auth-token: {CHAVE_API}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"Exemplo de Resposta (200):
{
"message": "Transferência cancelada com sucesso.",
"transfer": {
"id": 300,
"amount": 6000,
"destination_type": 10,
"destination_type_name": "Minha conta bancária",
"destination_business_id": null,
"service_fee": 300,
"fee_service": 300,
"debited_amount": 6300,
"service_fee_type": null,
"business_notes": "Saque cancelado a pedido do cliente.",
"admin_notes": "Cancelado via API Business.",
"notification_url": "https://webhook.exemplo.com/transfer/300",
"status": 30,
"status_name": "Recusada",
"created_at": "2026-02-04T09:00:00.000000Z",
"finished_at": "2026-02-04T09:10:00.000000Z",
"updated_at": "2026-02-04T09:10:00.000000Z",
"pix_key": "chave-pix-cancelada",
"pix_key_type": 10,
"account_document": "33333333333",
"account_holder": "Empresa Exemplo Cancelada"
}
}
Exemplo de Resposta (404):
{
"message": "Transferência não encontrada."
}
Exemplo de Resposta (422):
{
"message": "Essa transferência não pode ser recusada."
}
Resposta recebida:
Requisição falhou com erro:
Dica: Verifique se você está devidamente conectado à rede.
Se você é o mantenedor desta API, verifique se a sua API está em execução e se você habilitou o CORS.
Você pode verificar o console das Ferramentas de Desenvolvedor para informações de depuração.Alterar status da transferência (Apenas Sandbox/Desenvolvimento)
requires authentication
Este endpoint está disponível APENAS em ambiente de desenvolvimento. Altera manualmente o status de uma transferência para testar diferentes fluxos e webhooks.
Exemplo de Requisição:
$client = new \GuzzleHttp\Client();
$url = 'https://api.webpag.com.br/api/transfers/123/change-status-dev';
$response = $client->post(
$url,
[
'headers' => [
'auth-token' => '{CHAVE_API}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'status' => 40,
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));curl --request POST \
"https://api.webpag.com.br/api/transfers/123/change-status-dev" \
--header "auth-token: {CHAVE_API}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"status\": 40
}"
Exemplo de Resposta (403):
{
"message": "Este endpoint está disponível apenas em ambiente de desenvolvimento."
}
Exemplo de Resposta (404):
{
"message": "Transferência não encontrada."
}
Exemplo de Resposta (422):
{
"message": "O status informado é inválido.",
"errors": {
"status": [
"O status informado é inválido."
]
}
}
Resposta recebida:
Requisição falhou com erro:
Dica: Verifique se você está devidamente conectado à rede.
Se você é o mantenedor desta API, verifique se a sua API está em execução e se você habilitou o CORS.
Você pode verificar o console das Ferramentas de Desenvolvedor para informações de depuração.Webhook
Pagamentos
Ao informar notification_url no pagamento, a webpag envia uma requisição para o URL informado com estas informações quando há alguma alteração de status no pagamento, evitando a necessidade de realizar consultas manualmente. Utilize a propriedade "status" para verificar o status atual do pagamento.
Para garantir que a requisição foi enviada pela webpag, utilize o business.id
Verifique os valores do "Exemplo de Resposta" para entender melhor o retorno.
Valores possíveis de status:
10 = Disponível
20 = Em análise
30 = Falhou
40 = Pago
45 = Reembolso Parcial
50 = Reembolsado
60 = Cancelado
70 = Chargeback
80 = Em Disputa
90 = Em Contestação
Exemplo de Requisição:
$client = new \GuzzleHttp\Client();
$url = 'https://api.webpag.com.br/';
$response = $client->post(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));curl --request POST \
"https://api.webpag.com.br/" \
--header "Content-Type: application/json" \
--header "Accept: application/json"Exemplo de Resposta (200):
{
"id": 3493,
"business": {
"id": 537,
"name": "Maggio, Upton and Mann"
},
"payer_id": 881,
"card_id": 1478,
"name": "Pagamento utilizando pix",
"amount": 1000,
"fee_value": "1409.74",
"installments": 1,
"is_recurrent": false,
"recurrence_code": "18811727811431",
"frequency": null,
"method": 30,
"method_label": "Cartão de Crédito",
"order_id": "<order_id>",
"boleto": {
"id": 7178,
"linha_digitavel": "00190000090312855799299992855173897120000005000",
"sequencial_code": 9999992855,
"nosso_numero": "00031285579999992855",
"codigo_barras": "00198971200000050000000003128557999999285517",
"due_date": "2024-05-10T03:00:00.000000Z",
"issue_date": "2024-05-08T03:00:00.000000Z",
"amount": "50.00",
"interest": "1.000",
"fine": "2.000",
"accept_after_due_date": null
},
"notification_url": "https://confirma.com/pagamento/confirmacao",
"pix": {
"id": 39,
"uuid": "4222b7d7-0c98-4c48-b94a-49d23a98c245",
"business_id": 45,
"payment_id": 39488,
"txid": "FdbMqfiIT2ki7FSKdMlofsNjzF",
"key": "9e881f18-cc66-4fc7-8f2c-a795dbb2bfc1",
"qrcode_data": "00020101021226870014br.gov.bcb.pix2565qrcodepix-h.bb.com.br/pix/v2/8c672b36-459e-48dc-aa14-0544186e321b520400005303986540550.005802BR5921PAPELARIA LEITE CUNHA6012RONDONOPOLIS62070503***63044061",
"amount": "50.00",
"expiration_date": "2024-05-08T21:43:33.000000Z",
"status": 10,
"created_at": "2024-05-08T20:43:33.000000Z",
"updated_at": "2024-05-08T20:43:33.000000Z"
},
"spplited": false,
"gateway": "Cielo E-commerce",
"active": true,
"status": 40,
"status_label": "Pago",
"start_date": null,
"next_date": "2025-01-01",
"transactions": [
{
"id": 3325,
"type": 10,
"type_label": "Aprovação",
"transaction_id": "0820052749976",
"response_status": "6 - Operation Successful",
"errors": null,
"status": 10,
"status_label": "Sucesso",
"created_at": "2024-08-20 17:27"
}
],
"splits": [],
"created_at": "2024-08-20 17:27",
"paid_at": "2024-08-20 17:27",
"updated_at": "2024-08-20 17:27",
"receipt_pdf_path": "http://localhost:81/payments/934123e8d7e3401eb703195d1/pdf",
"card_flag": 20,
"card_flag_label": "Mastercard"
}
Resposta recebida:
Requisição falhou com erro:
Dica: Verifique se você está devidamente conectado à rede.
Se você é o mantenedor desta API, verifique se a sua API está em execução e se você habilitou o CORS.
Você pode verificar o console das Ferramentas de Desenvolvedor para informações de depuração.Transferência
Este exemplo representa o corpo enviado pelo webpag para a sua notification_url quando há alguma alteração de status em um saque/transferência.
O campo "type" segue o padrão transfer.<status_slug>, por exemplo transfer.pending, transfer.approved, transfer.denied, transfer.paid, transfer.processing ou transfer.cancelled.
Valores possíveis de status da transferência:
10 = Solicitado
20 = Aprovada
30 = Recusada
40 = Paga
50 = Processando
60 = Cancelado
Exemplo de Requisição:
$client = new \GuzzleHttp\Client();
$url = 'https://api.webpag.com.br/';
$response = $client->post(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));curl --request POST \
"https://api.webpag.com.br/" \
--header "Content-Type: application/json" \
--header "Accept: application/json"Exemplo de Resposta (200):
{
"id": "01J0Y7TF4QZ8KNGZ8DC1Y9TRNS",
"type": "transfer.paid",
"send_at": "2024-08-21T10:15:00.000000Z",
"data": {
"id": 1234,
"amount": 150000,
"destination_type": 10,
"destination_type_name": "Conta Bancária",
"destination_business_id": 45,
"service_fee": 500,
"fee_service": 500,
"debited_amount": 150500,
"service_fee_type": 10,
"business_notes": "Saque semanal para conta principal",
"admin_notes": null,
"notification_url": "https://meusistema.com/webhook/transferencias",
"status": 40,
"status_name": "Paga",
"created_at": "2024-08-21T09:00:00.000000Z",
"finished_at": "2024-08-21T10:15:00.000000Z",
"updated_at": "2024-08-21T10:15:00.000000Z",
"pix_key": "usuario@empresa.com",
"pix_key_type": 20,
"account_document": "12345678000199",
"account_holder": "EMPRESA EXEMPLO LTDA"
}
}
Resposta recebida:
Requisição falhou com erro:
Dica: Verifique se você está devidamente conectado à rede.
Se você é o mantenedor desta API, verifique se a sua API está em execução e se você habilitou o CORS.
Você pode verificar o console das Ferramentas de Desenvolvedor para informações de depuração.Estorno
Este exemplo representa o corpo enviado pelo webpag para a sua notification_url quando há alguma alteração de status em um estorno de pagamento (refund).
O campo "type" segue o padrão payment_refund.<status_slug>, por exemplo payment_refund.pending, payment_refund.processing, payment_refund.failed, payment_refund.success ou payment_refund.needs_reconciliation.
Valores possíveis de status do estorno:
10 = Pendente
20 = Processando
30 = Falhou
40 = Sucesso
50 = Necessita Reconciliação
Consulte também a seção "Webhooks de estorno (refunds)" para a tabela completa de status e mais detalhes sobre o payload.
Exemplo de Requisição:
$client = new \GuzzleHttp\Client();
$url = 'https://api.webpag.com.br/';
$response = $client->post(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));curl --request POST \
"https://api.webpag.com.br/" \
--header "Content-Type: application/json" \
--header "Accept: application/json"Exemplo de Resposta (200):
{
"id": "01J0Y7BAW4XHCNGZ8DC1Y9NRTJ",
"type": "payment_refund.success",
"send_at": "2024-08-20T17:27:00.000000Z",
"data": {
"id": "3f64b2e2-1c1a-4b5e-9c2b-5f8d07b6a9cd",
"payment_id": 39488,
"business_id": 45,
"status": 40,
"status_label": "Sucesso",
"refund_amount": 5000,
"refund_fee": 100,
"before_amount": 10000,
"before_fee": 200,
"after_amount": 5000,
"after_fee": 100,
"credit_schedule_refund": null,
"financial_entry_refund": null,
"processed_at": "2024-08-20 17:27",
"created_at": "2024-08-20 17:27",
"updated_at": "2024-08-20 17:27"
}
}
Resposta recebida:
Requisição falhou com erro:
Dica: Verifique se você está devidamente conectado à rede.
Se você é o mantenedor desta API, verifique se a sua API está em execução e se você habilitou o CORS.
Você pode verificar o console das Ferramentas de Desenvolvedor para informações de depuração.