Pular para o conteúdo principal

Cenários de Teste

No ambiente de sandbox, você pode testar diferentes cenários de link de pagamento para entender como a API responde em diversas situações. Por padrão, as tentativas de criação, inativação, estorno, listagem de transações da cobrança e listagem de detalhes da cobrança são configuradas para retornar com sucesso caso as regras sejam cumpridas. Para simular outros fluxos, utilize os seguintes IDs de link de pagamento e IDs de transações temporários:

IDCenário de TesteStatus CodeDescrição do Resultado
17496673826849ce36a1c29Link de pagamento inexistente404Este ID simula um cenário onde o link de pagamento não foi encontrado. Utilize-o para testar como sua aplicação lida com links de pagamento inexistentes.
17496626166849bb9851578Falha ao buscar transações500Este ID simula um cenário onde houve uma falha na busca das transações a partir no ID do link de pagamento. Utilize-o na rota de listagem de transação para testar e tratar este cenário na sua aplicação.
173887430167a51dbd8ee2dLink de pagamento sem transação200Este ID simula um cenário onde o link de pagamento não possui transação. Utilize-o para testar como sua aplicação lida com links válidos, mas sem transações.
Importante!

Qualquer outro ID retornará uma listagem fixa na rota de listagem de transações.

Para testar a inativação, será preciso criar um link de pagamento no ambiente de sandbox usando a rota de criação e usar o ID gerado, encontrado na url contida na chave link.

Considerando o retorno da criação de um novo link de pagamento:

{
...
"link": "https://link.ppay.me/p/173887430167a51dbd8ee2x",
...
}

O ID seria o 173887430167a51dbd8ee2x.

Importante!

Nenhum dos IDs da tabela anterior serão válidos, todos retornam erro (status code 404).

IDs de Transação​

Retorno de sucesso​

Status code: 200

Estes IDs simulam um cenário onde o estorno é realizado com sucesso. Utilize-o para testar como sua aplicação lida com estornos totais ou parciais bem sucedidos.

9f1c6b2a-3f4e-4b8d-a6c2-22e12f5a9d74
d5307f3e-6a0b-4f1b-bf44-85e1f6bce2e2
a834d7f4-1d3c-4eaa-8c10-b4a6f7587b29
c25b3c7e-04f9-4dfe-bdf1-1b59ecbbd0e4
7f4ae1b9-28a2-40c3-b74e-0a8f09b6a1d3

Retorno de erro​

Status code: 400

Estes IDs simulam um cenário onde o estorno é realizado com falha. Utilize-o para testar como sua aplicação lida com falha na realização de estornos totais ou parciais.

e379b4d5-791c-48c8-bc19-3e908a6de9b7
0e35f4a7-68b5-4d30-91f6-7d6e4d5acddb
b9d174c9-49f9-4b30-945a-90fc0d39e7a1
8b65a34f-0b21-46f9-b4e7-f2db2a3cb278
3d62b85f-9e74-4f66-9a44-4c73c94b9f5f
Importante!

Na execução de um estorno parcial, o retorno dependerá do valor enviado e será retornado no campo amount juntamente com o valor total da transação no campo originalValue.

Exemplo Considerando uma listagem de transações de um link de pagamento como a seguinte:

{
	"originId": "ID_Link_de_pagamento",
	"transactions": [
		{
			"id": "9f1c6b2a-3f4e-4b8d-a6c2-22e12f5a9d74",
			"status": "PAYED",
			"amount": 450,
			"createdAt": "2025-04-13 13:12:55",
			"updatedAt": "2025-04-15 13:12:55"
		},
	],
	"perPage": 10,
	"currentPage": 1,
	"nextPage": null
}

O estorno parcial gerado retorna o seguinte:

{
	"transactionId": "9f1c6b2a-3f4e-4b8d-a6c2-22e12f5a9d74",
	"amount": 100,
	"originalAmount": 450
}

Dicas para Testes de Cenários​

  • Certifique-se de testar todos os cenários para garantir que sua aplicação possa lidar com diferentes respostas da API.
  • Observe como sua aplicação trata os erros e as mensagens de resposta fornecidas pela API.

Utilizando esses cartões ou tokens em seus testes no ambiente de sandbox, você poderá preparar sua aplicação para lidar com uma variedade de situações que podem ocorrer em um ambiente de produção.