Simulação de Valores de Transação

🔼
POSTurlServidor/v1/marketplace/transactions/simulate

Obs: A palavra urlServidor deve ser substituída pela url do servidor.

Parâmetros da Requisição

Headers

Parâmetro	Tipo	Obrigatório	Descrição
`integration-key`	string	Sim	Chave de integração fornecida pela Paytime.
`x-token`	string	Sim	Token utilizado para autenticação, disponível no portal da API.
`establishment_id`	string	Sim	ID do estabelecimento responsável pela transação.
`Authorization`	Auth Type Bearer Token	Sim	Inserir o Bearer Token, gerado na rota Auth

Exemplo de header da requisição

curl--request POST \
 --location 'urlServidor/v1/marketplace/transactions/123' \
--header 'integration-key: your_integration_key' \
--header 'x-token: your_x_token' \
--header 'establishment_id: 123' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{bearer_token}}' \

Body Parameters

A requisição exige um objeto JSON com a seguinte estrutura:

Parâmetro	Tipo	Obrigatório	Descrição
`amount`	number	Sim	Valor total em centavos da transação a ser simulada.
`flag_id`	number	Sim	Representa a bandeira do cartão de crédito. Bandeiras: 1 - MASTERCARD, 2 - VISA, 3 - ELO, 4 - AMERICAN_EXPRESS, 5 - HIPER_HIPERCARD, 6 - OTHERS, 8 - BACEN
`gateway_id`	number	Não	Representa qual gateway estará executando a transação. Gateways: 1 - ZOOP, 2 - PAGSEGURO, 4 - SUBPAYTIME
`modality`	String	Sim	Modalidades de venda: ONLINE, PHYSICAL, TAP_PHONE
`interest`	string	Sim	`CLIENT`: o valor das taxas serão passadas ao cliente, aumentando o valor bruto da transação. - `STORE`: o valor das taxas serão passadas ao estabelecimento, mantendo o valor bruto da transação.
`antifraud_type`	string	Não	Antifraude a ser utilizado: THREEDS, IDPAY

⚠️
Valor da parcela
Valor mínimo da parcela é R$ 5,00(cinco) reais.

Exemplo de Requisição:

{
  "amount": 5000,
  "flag_id": 1,
  "gateway_id": 4,
  "modality": "ONLINE",
  "interest": "ESTABLISHMENT"
}

Resposta

Se a requisição for processada com sucesso, será retornado um status 200 com a seguinte estrutura JSON:


    "amount": 5000,
    "simulation": {
        "credit": {
            "1x": {
                "total": 4820,
                "installment": 5000
            },
            "2x": {
                "total": 4820,
                "installment": 2500
            },
            "3x": {
                "total": 4820,
                "installment": 1667
            },
            "4x": {
                "total": 4820,
                "installment": 1250
            },
            "5x": {
                "total": 4820,
                "installment": 1000
            },
            "6x": {
                "total": 4820,
                "installment": 833
            },
            "7x": {
                "total": 4820,
                "installment": 714
            },
            "8x": {
                "total": 4820,
                "installment": 625
            },
            "9x": {
                "total": 4820,
                "installment": 556
            },
            "10x": {
                "total": 4820,
                "installment": 500
            }
        },
        "debit": 4820,
        "pix": 4940
    }
}

Códigos de Resposta

Consulte a página com os status: Status de respostas

Para mais detalhes sobre os parâmetros e funcionamento da API, acesse a documentação oficial da Paytime.

POSTurlServidor/v1/marketplace/transactions/simulate

Parâmetros da Requisição

Headers

Exemplo de header da requisição

Body Parameters

Valor da parcela

Resposta

Códigos de Resposta

POST`urlServidor/v1/marketplace/transactions/simulate`