Simulador de Recebimento

Dados da API

• Dados da API:
  • URL: https://api.sopague.com.br/gateway
  • Arquitetura: Representational State Transfer (REST)

Introdução

Através desse endpoint é possível se obter o valor a ser cobrado em formas de parcelamento distintas para se receber um valor líquido específico. Nesse endpoint, o valor a ser enviado deve ser no formato decimal, assim como o retorno também será com casas decimais, ao contrato do endpoint de pagamento e cancelamento, onde os valores são enviados em centavos (do tipo inteiro).

Realizar Operação de Simulação de Recebimento

GET /v1/payments-simulator?Brand=visa&netValue=1000

Via request Representational State Transfer (REST) com o body:

Dicionário de dados - Parâmetros

PROPRIEDADE	DESCRIÇÃO	TIPO	LOCAL	OBRIGATÓRIO
Brand	Bandeira do cartão.	string	path	sim
netValue	Valor líquido a ser recebido.	decimal	path	sim

🟢 200

Pesquisa realizada com sucesso

  {
    "installments": [
      {
        "installment": 1,
        "amount": 1035.24
      },
      {
        "installment": 2,
        "amount": 1046.98
      },
      {
        "installment": 3,
        "amount": 1052.82
      },
      {
        "installment": 4,
        "amount": 1058.72
      },
      {
        "installment": 5,
        "amount": 1064.68
      },
      {
        "installment": 6,
        "amount": 1070.71
      },
      {
        "installment": 7,
        "amount": 1083.51
      },
      {
        "installment": 8,
        "amount": 1089.72
      },
      {
        "installment": 9,
        "amount": 1096.00
      },
      {
        "installment": 10,
        "amount": 1102.36
      },
      {
        "installment": 11,
        "amount": 1108.78
      },
      {
        "installment": 12,
        "amount": 1115.29
      }
    ]
  }

Dicionário de dados - Retorno

PROPRIEDADE	DESCRIÇÃO	TIPO
Installsments.installment	Número da parcela.	integer
Installsments.amount	Valor da parcela (em centavos).	decimal

🔴 400

Erro na requisição

[ 
  { 
    "tag": "", 
    "description": "Bandeira não identificada" 
  } 
] 

Dicionário de dados - Retorno

PROPRIEDADE	DESCRIÇÃO	TIPO
tag	Tag do erro	string
description	Descrição do erro	string

🔴 500

Erro interno

[ 
    { 
        "tag": "", 
        "description": "Não foi possível executar comando. Erro desconhecido." 
    } 
]

Dicionário de dados - Retorno

PROPRIEDADE	DESCRIÇÃO	TIPO
tag	Tag do erro	string
description	Descrição do erro	string