Skip to main content

Manual Consignado Privado - Portabilidade: Mocks e Sandbox

Aviso Importante!

Não utilize dados pessoais reais (CPF, CNPJ etc.) em ambiente sandbox.

Simulação de Cenários​

Portabilidade​

1. Solicitação do Saldo Devedor​

Após a assinatura da operação de portabilidade, caso o cliente tenha configuração de envio manual, a proposta será criada com status "pending_submission" e somente após a chamada da rota a seguir, a solicitação do saldo devedor será feita. Caso a configuração seja de envio automático a proposta será criada com status "pending_response", ou seja, já está aguardando o retorno do saldo e não é necessário chamar esta rota.

Requisição

ENDPOINT
/v2/credit_transfer/proposal/PROPOSAL-KEY
MÉTODO
PATCH
request.json
{
    "status": "pending_response"
}

2. Aprovação pelo CTC​

A proposta deve estar em status "pending_response".

Requisição

ENDPOINT
/mock/credit_transfer/ctc
MÉTODO
POST
request.json
{
    "proposal_key": "CHAVE DA PROPOSTA",
    "event_type": "proposal_creation_accepted"
}

3. Rejeição pelo CTC​

A proposta deve estar em status "pending_response".

Requisição

ENDPOINT
/mock/credit_transfer/ctc
MÉTODO
POST
request.json
{
    "proposal_key": "CHAVE DA PROPOSTA",
    "event_type": "proposal_creation_refused"
}

4. Envio de saldo devedor pelo banco de origem​

A chamada de aprovação pelo CTC (2) deve ser enviada antes. A proposta deve estar em status "pending_acceptance". Após esta rota, receberá o webhook informando o saldo devedor atual da dívida e caso queira seguir com a operação deve chamar a rota apresentada no fluxo de aceite da proposta.

Requisição

ENDPOINT
/mock/credit_transfer/ctc
MÉTODO
POST
request.json
{
    "proposal_key": "CHAVE DA PROPOSTA",
    "event_type": "proposal_approval",
    "due_balance": 9000, // Opcional, se não informado será enviado o valor usado na criação da proposta
    "installment_face_value": 300, // Opcional, se não informado será enviado o valor usado na criação da proposta
    "installment_number": 40, // Opcional, se não informado será enviado o valor usado na criação da proposta
    "opened_installment_number": 35, // Opcional, se não informado será enviado igual ao installment_number
    "overdue_installment_number": 5 // Opcional, se não informado será enviado 0
}

5. Retenção pelo banco de origem​

A chamada de aprovação pelo CTC (2) deve ser enviada antes. A proposta deve estar em status "pending_acceptance"

Requisição

ENDPOINT
/mock/credit_transfer/ctc
MÉTODO
POST
request.json
{
    "proposal_key": "CHAVE DA PROPOSTA",
    "event_type": "proposal_retention"
}

6. Devolução do pagamento pelo banco de origem​

Só pode ser enviado depois que a proposta for aceita e a operação de portabilidade desembolsada. Proposta deve estar em status "settlement_sent", "pending_settlement_confirmation" ou "paid".

Requisição

ENDPOINT
/mock/credit_transfer/str
MÉTODO
POST
request.json
{
    "proposal_key": "CHAVE DA PROPOSTA",
    "event_type": "payment_rejected"
}

7. Confirmação de pagamento pelo CTC​

Proposta deve ter sido aceita e a operação de portabilidade desembolsada. Status deve ser "settlement_sent".

Requisição

ENDPOINT
/mock/credit_transfer/ctc
MÉTODO
POST
request.json
{
    "proposal_key": "CHAVE DA PROPOSTA",
    "event_type": "settlement_confirmation"
}

8. Confirmação de pagamento pelo banco de origem​

Deve ser chamado após a confirmação de pagamento pelo CTC (7). Proposta deve estar em status "pending_settlement_confirmation".

Requisição

ENDPOINT
/mock/credit_transfer/ctc
MÉTODO
POST
request.json
{
    "proposal_key": "CHAVE DA PROPOSTA",
    "event_type": "payment_confirmation"
}

9. Averbação de garantia​

Proposta deve estar em status "pending_settlement_confirmation" ou "paid", após 7 ou 8.

Requisição

ENDPOINT
/mock/credit_transfer/collateral
MÉTODO
POST
request.json
{
    "proposal_key": "CHAVE DA PROPOSTA",
    "credit_operation_type": "portability",
    "collateral_constituted": true
}

Refinanciamento​

10. Averbação de garantia​

Proposta deve estar em status "paid" ou "pending_settlement_confirmation" com garantia de portabilidade averbada e o refinanciamento deve ter sido aceito.

Requisição

ENDPOINT
/mock/credit_transfer/collateral
MÉTODO
POST
request.json
{
    "proposal_key": "CHAVE DA PROPOSTA",
    "credit_operation_type": "refinancing",
    "collateral_constituted": true
}

11. Falha na averbação de garantia​

Proposta deve estar em status "paid" ou "pending_settlement_confirmation" com garantia de portabilidade averbada e o refinanciamento deve ter sido aceito.

Requisição

ENDPOINT
/mock/credit_transfer/collateral
MÉTODO
POST
request.json
{
    "proposal_key": "CHAVE DA PROPOSTA",
    "credit_operation_type": "refinancing",
    "collateral_constituted": false
}

12. Falha no desembolso​

Operação de refinanciamento deve ter sido desembolsada.

Requisição

ENDPOINT
/mock/credit_transfer/disbursement
MÉTODO
POST
request.json
{
    "proposal_key": "CHAVE DA PROPOSTA",
    "event_type": "disbursement_failed"
}