Simulação de cenários

Esta página descreve como simular a criação e cancelamento de entradas de instrumentos de pagamento para testar o fluxo de transações com cartões pós-pagos. Essas simulações são úteis para homologação e testes de integração.

Informação

Essas requisições simulam transações externas e retornam o status HTTP com a chave da entrada criada ou cancelada.

1 - Simulação de criação de entrada de instrumento de pagamento

Simula a criação de uma entrada de instrumento de pagamento (transação), como uma compra ou saque realizado com o cartão pós-pago. A entrada será automaticamente vinculada a itens de fatura conforme a configuração de parcelamento.

ENDPOINT

/mock/invoice/payment_instrument/PAYMENT_INSTRUMENT_KEY/payment_instrument_entry

MÉTODO

POST

Path Parameters

Campo	Tipo	Descrição	Caracteres
payment_instrument_key *	uuidv4	Chave única do instrumento de pagamento no formato UUID v4	36

Request Body

{
    "request_control_key": "f7947b9d-9be3-49d8-aca2-4b3249e5fa65",
    "payment_instrument_entry_amount": 100.50,
    "number_of_installments": 3,
    "installment_amount": 33.50,
    "payment_instrument_entry_type": "purchase",
    "payment_instrument_entry_data": {
        "merchant_name": "Test Merchant",
        "merchant_country": "BR",
        "merchant_postal_code": "01310-100",
        "merchant_city": "São Paulo",
        "merchant_street": "Av. Paulista"
    }
}

Objeto Request Body

Campo	Tipo	Descrição	Máx. Caract.
request_control_key *	uuidv4	Chave única de identificação da requisição utilizada pelo cliente	36
payment_instrument_entry_amount *	float	Valor total da transação	-
number_of_installments *	integer	Número de parcelas da transação	-
installment_amount *	float	Valor de cada parcela	-
payment_instrument_entry_type *	string	Tipo da entrada do instrumento de pagamento	Enumeradores payment_instrument_entry_type
payment_instrument_entry_data *	object	Dados adicionais da transação	Objeto payment_instrument_entry_data

Enumeradores payment_instrument_entry_type

Enumerador	Descrição
purchase	Compra realizada com o cartão
withdraw	Saque realizado com o cartão

Objeto payment_instrument_entry_data

Campo	Tipo	Descrição	Caracteres
merchant_name *	string	Nome do estabelecimento comercial	-
merchant_country *	string	País do estabelecimento comercial	-
merchant_postal_code *	string	Código postal do estabelecimento comercial	-
merchant_city *	string	Cidade do estabelecimento comercial	-
merchant_street *	string	Rua do estabelecimento comercial	-

Response

STATUS

201

Response Body

{
    "payment_instrument_entry_key": "8cb70dea-9fb0-4a68-9572-99a72849c8d6"
}

Response Body Params

Campo	Tipo	Descrição	Caracteres
payment_instrument_entry_key *	uuidv4	Chave única de identificação da entrada criada no formato UUID v4	36

Comportamento

• A simulação cria uma entrada de instrumento de pagamento com status active
• A entrada será automaticamente vinculada a itens de fatura (invoice items) conforme o número de parcelas informado
• Os itens de fatura serão organizados em faturas (invoices) conforme a configuração de fechamento da carteira
• O limite do instrumento de pagamento e da carteira serão validados antes de permitir a criação da entrada

2 - Simulação de cancelamento de entrada de instrumento de pagamento

Simula o cancelamento de uma entrada de instrumento de pagamento existente, alterando seu status para canceled e liberando o limite utilizado.

ENDPOINT

/mock/invoice/payment_instrument/PAYMENT_INSTRUMENT_KEY/payment_instrument_entry/REQUEST_CONTROL_KEY/cancel

MÉTODO

PATCH

Path Parameters

Campo	Tipo	Descrição	Caracteres
payment_instrument_key *	uuidv4	Chave única do instrumento de pagamento no formato UUID v4	36
request_control_key *	uuidv4	Chave única de identificação da requisição original utilizada na criação da entrada	36

Request Body

{
    "payment_instrument_entry_amount": 100.50
}

Objeto Request Body

Campo	Tipo	Descrição	Máx. Caract.
payment_instrument_entry_amount *	float	Valor do cancelamento. Se não informado, cancela o valor total da entrada	-

Response

STATUS

200

Response Body

{
    "payment_instrument_entry_key": "8cb70dea-9fb0-4a68-9572-99a72849c8d6"
}

Response Body Params

Campo	Tipo	Descrição	Caracteres
payment_instrument_entry_key *	uuidv4	Chave única de identificação da entrada cancelada no formato UUID v4	36

Comportamento

• Faturas abertas: Cancelamentos em faturas abertas liberam o limite imediatamente e removem o valor da fatura
• Faturas fechadas: Cancelamentos em faturas fechadas criam chargebacks que aparecerão no campo invoice_payments_chargebacks quando forem utilizados na próxima fatura