Exibir plano comercial

Essa rota permite consultar os detalhes completos de um plano comercial cadastrado, incluindo as taxas configuradas por modalidade de pagamento e por bandeira.

🔽

GET urlServidor/v1/marketplace/plans/id

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

Parâmetros da Requisição

NomeTipoObrigatórioDescrição
integration-keystringSimChave de integração.
x-tokenstringSimToken utilizado para autenticação. Pode ser encontrado no portal da API.
AuthorizationAuth Type Bearer TokenSimInserir o Bearer Token, gerado na rota Auth

Exemplo de header da requisição

curl--request GET \
--location '{{urlServidor}/v1/marketplace/plans/id' \
--header 'integration-key: your_integration_key' \
--header 'x-token: your_x_token' \
--header 'Authorization: Bearer {{bearer_token}}' \

Parâmetros de Path

NomeTipoObrigatórioDescrição
idstringSimID do plano a ser consultado

✅ Exemplo de Resposta - 200 OK

{
    "id": 47,
    "name": "comercial antifraude",
    "active": true,
    "gateway_id": 4,
    "description": "teste base",
    "type": "COMMERCIAL",
    "modality": "ONLINE",
    "allow_anticipation": true,
    "days_anticipation": 1,
    "created_at": "2024-10-15T17:03:28.000Z",
    "updated_at": "2024-10-16T10:54:44.000Z",
    "categories": [
        {
            "id": 367,
            "name": "Acampamentos Recreativos e Esportivos",
            "gateway_key": "7032"
        }
    ],
    "flags": [
        {
            "id": 1,
            "name": "MASTERCARD",
            "active": true,
            "standard": {
                "pix": 0,
                "debit": 0.02,
                "credit": {
                    "1x": 0.02,
                    "2x": 0.04,
                    "3x": 0.06,
                    "4x": 0.08,
                    "5x": 0.1,
                    "6x": 0.12,
                    "7x": 0.14,
                    "8x": 0.16,
                    "9x": 0.18,
                    "10x": 0.2,
                    "11x": 0.22,
                    "12x": 0.24,
                    "13x": 0.26,
                    "14x": 0.28,
                    "15x": 0.3,
                    "16x": 0.32,
                    "17x": 0.34,
                    "18x": 0.36
                }
            },
            "markup": {
                "pix": 0,
                "debit": 0.1,
                "credit": {
                    "1x": 0.01,
                    "2x": 0.02,
                    "3x": 0.03,
                    "4x": 0.04,
                    "5x": 0.05,
                    "6x": 0.06,
                    "7x": 0.07,
                    "8x": 0.08,
                    "9x": 0.09,
                    "10x": 0.1,
                    "11x": 0.11,
                    "12x": 0.12,
                    "13x": 0.13,
                    "14x": 0.14,
                    "15x": 0.15,
                    "16x": 0.16,
                    "17x": 0.17,
                    "18x": 0.18
                }
            },
            "fees": {
                "pix": 0,
                "debit": 0.12,
                "credit": {
                    "1x": 0.03,
                    "2x": 0.06,
                    "3x": 0.09,
                    "4x": 0.12,
                    "5x": 0.15,
                    "6x": 0.18,
                    "7x": 0.21,
                    "8x": 0.24,
                    "9x": 0.27,
                    "10x": 0.3,
                    "11x": 0.33,
                    "12x": 0.36,
                    "13x": 0.39,
                    "14x": 0.42,
                    "15x": 0.45,
                    "16x": 0.48,
                    "17x": 0.51,
                    "18x": 0.54
                }
            }
        },
        {
            "id": 2,
            "name": "VISA",
            "active": true,
            "standard": {
                "pix": 0,
                "debit": 0.02,
                "credit": {
                    "1x": 0.02,
                    "2x": 0.04,
                    "3x": 0.06,
                    "4x": 0.08,
                    "5x": 0.1,
                    "6x": 0.12,
                    "7x": 0.14,
                    "8x": 0.16,
                    "9x": 0.18,
                    "10x": 0.2,
                    "11x": 0.22,
                    "12x": 0.24,
                    "13x": 0.26,
                    "14x": 0.28,
                    "15x": 0.3,
                    "16x": 0.32,
                    "17x": 0.34,
                    "18x": 0.36
                }
            },
            "markup": {
                "pix": 0,
                "debit": 0.1,
                "credit": {
                    "1x": 0.01,
                    "2x": 0.02,
                    "3x": 0.03,
                    "4x": 0.04,
                    "5x": 0.05,
                    "6x": 0.06,
                    "7x": 0.07,
                    "8x": 0.08,
                    "9x": 0.09,
                    "10x": 0.1,
                    "11x": 0.11,
                    "12x": 0.12,
                    "13x": 0.13,
                    "14x": 0.14,
                    "15x": 0.15,
                    "16x": 0.16,
                    "17x": 0.17,
                    "18x": 0.18
                }
            },
            "fees": {
                "pix": 0,
                "debit": 0.12,
                "credit": {
                    "1x": 0.03,
                    "2x": 0.06,
                    "3x": 0.09,
                    "4x": 0.12,
                    "5x": 0.15,
                    "6x": 0.18,
                    "7x": 0.21,
                    "8x": 0.24,
                    "9x": 0.27,
                    "10x": 0.3,
                    "11x": 0.33,
                    "12x": 0.36,
                    "13x": 0.39,
                    "14x": 0.42,
                    "15x": 0.45,
                    "16x": 0.48,
                    "17x": 0.51,
                    "18x": 0.54
                }
            }
        },
        {
            "id": 3,
            "name": "ELO",
            "active": true,
            "standard": {
                "pix": 0,
                "debit": 0.02,
                "credit": {
                    "1x": 0.02,
                    "2x": 0.04,
                    "3x": 0.06,
                    "4x": 0.08,
                    "5x": 0.1,
                    "6x": 0.12,
                    "7x": 0.14,
                    "8x": 0.16,
                    "9x": 0.18,
                    "10x": 0.2,
                    "11x": 0.22,
                    "12x": 0.24,
                    "13x": 0.26,
                    "14x": 0.28,
                    "15x": 0.3,
                    "16x": 0.32,
                    "17x": 0.34,
                    "18x": 0.36
                }
            },
            "markup": {
                "pix": 0,
                "debit": 0.1,
                "credit": {
                    "1x": 0.01,
                    "2x": 0.02,
                    "3x": 0.03,
                    "4x": 0.04,
                    "5x": 0.05,
                    "6x": 0.06,
                    "7x": 0.07,
                    "8x": 0.08,
                    "9x": 0.09,
                    "10x": 0.1,
                    "11x": 0.11,
                    "12x": 0.12,
                    "13x": 0.13,
                    "14x": 0.14,
                    "15x": 0.15,
                    "16x": 0.16,
                    "17x": 0.17,
                    "18x": 0.18
                }
            },
            "fees": {
                "pix": 0,
                "debit": 0.12,
                "credit": {
                    "1x": 0.03,
                    "2x": 0.06,
                    "3x": 0.09,
                    "4x": 0.12,
                    "5x": 0.15,
                    "6x": 0.18,
                    "7x": 0.21,
                    "8x": 0.24,
                    "9x": 0.27,
                    "10x": 0.3,
                    "11x": 0.33,
                    "12x": 0.36,
                    "13x": 0.39,
                    "14x": 0.42,
                    "15x": 0.45,
                    "16x": 0.48,
                    "17x": 0.51,
                    "18x": 0.54
                }
            }
        },
        {
            "id": 4,
            "name": "AMERICAN EXPRESS",
            "active": true,
            "standard": {
                "pix": 0,
                "debit": 0.02,
                "credit": {
                    "1x": 0.02,
                    "2x": 0.04,
                    "3x": 0.06,
                    "4x": 0.08,
                    "5x": 0.1,
                    "6x": 0.12,
                    "7x": 0.14,
                    "8x": 0.16,
                    "9x": 0.18,
                    "10x": 0.2,
                    "11x": 0.22,
                    "12x": 0.24,
                    "13x": 0.26,
                    "14x": 0.28,
                    "15x": 0.3,
                    "16x": 0.32,
                    "17x": 0.34,
                    "18x": 0.36
                }
            },
            "markup": {
                "pix": 0,
                "debit": 0.1,
                "credit": {
                    "1x": 0.01,
                    "2x": 0.02,
                    "3x": 0.03,
                    "4x": 0.04,
                    "5x": 0.05,
                    "6x": 0.06,
                    "7x": 0.07,
                    "8x": 0.08,
                    "9x": 0.09,
                    "10x": 0.1,
                    "11x": 0.11,
                    "12x": 0.12,
                    "13x": 0.13,
                    "14x": 0.14,
                    "15x": 0.15,
                    "16x": 0.16,
                    "17x": 0.17,
                    "18x": 0.18
                }
            },
            "fees": {
                "pix": 0,
                "debit": 0.12,
                "credit": {
                    "1x": 0.03,
                    "2x": 0.06,
                    "3x": 0.09,
                    "4x": 0.12,
                    "5x": 0.15,
                    "6x": 0.18,
                    "7x": 0.21,
                    "8x": 0.24,
                    "9x": 0.27,
                    "10x": 0.3,
                    "11x": 0.33,
                    "12x": 0.36,
                    "13x": 0.39,
                    "14x": 0.42,
                    "15x": 0.45,
                    "16x": 0.48,
                    "17x": 0.51,
                    "18x": 0.54
                }
            }
        },
        {
            "id": 5,
            "name": "HIPER / HIPERCARD",
            "active": true,
            "standard": {
                "pix": 0,
                "debit": 0.02,
                "credit": {
                    "1x": 0.02,
                    "2x": 0.04,
                    "3x": 0.06,
                    "4x": 0.08,
                    "5x": 0.1,
                    "6x": 0.12,
                    "7x": 0.14,
                    "8x": 0.16,
                    "9x": 0.18,
                    "10x": 0.2,
                    "11x": 0.22,
                    "12x": 0.24,
                    "13x": 0.26,
                    "14x": 0.28,
                    "15x": 0.3,
                    "16x": 0.32,
                    "17x": 0.34,
                    "18x": 0.36
                }
            },
            "markup": {
                "pix": 0,
                "debit": 0.1,
                "credit": {
                    "1x": 0.01,
                    "2x": 0.02,
                    "3x": 0.03,
                    "4x": 0.04,
                    "5x": 0.05,
                    "6x": 0.06,
                    "7x": 0.07,
                    "8x": 0.08,
                    "9x": 0.09,
                    "10x": 0.1,
                    "11x": 0.11,
                    "12x": 0.12,
                    "13x": 0.13,
                    "14x": 0.14,
                    "15x": 0.15,
                    "16x": 0.16,
                    "17x": 0.17,
                    "18x": 0.18
                }
            },
            "fees": {
                "pix": 0,
                "debit": 0.12,
                "credit": {
                    "1x": 0.03,
                    "2x": 0.06,
                    "3x": 0.09,
                    "4x": 0.12,
                    "5x": 0.15,
                    "6x": 0.18,
                    "7x": 0.21,
                    "8x": 0.24,
                    "9x": 0.27,
                    "10x": 0.3,
                    "11x": 0.33,
                    "12x": 0.36,
                    "13x": 0.39,
                    "14x": 0.42,
                    "15x": 0.45,
                    "16x": 0.48,
                    "17x": 0.51,
                    "18x": 0.54
                }
            }
        },
        {
            "id": 6,
            "name": "OTHERS",
            "active": true,
            "standard": {
                "pix": 0,
                "debit": 0.02,
                "credit": {
                    "1x": 0.02,
                    "2x": 0.04,
                    "3x": 0.06,
                    "4x": 0.08,
                    "5x": 0.1,
                    "6x": 0.12,
                    "7x": 0.14,
                    "8x": 0.16,
                    "9x": 0.18,
                    "10x": 0.2,
                    "11x": 0.22,
                    "12x": 0.24,
                    "13x": 0.26,
                    "14x": 0.28,
                    "15x": 0.3,
                    "16x": 0.32,
                    "17x": 0.34,
                    "18x": 0.36
                }
            },
            "markup": {
                "pix": 0,
                "debit": 0.1,
                "credit": {
                    "1x": 0.01,
                    "2x": 0.02,
                    "3x": 0.03,
                    "4x": 0.04,
                    "5x": 0.05,
                    "6x": 0.06,
                    "7x": 0.07,
                    "8x": 0.08,
                    "9x": 0.09,
                    "10x": 0.1,
                    "11x": 0.11,
                    "12x": 0.12,
                    "13x": 0.13,
                    "14x": 0.14,
                    "15x": 0.15,
                    "16x": 0.16,
                    "17x": 0.17,
                    "18x": 0.18
                }
            },
            "fees": {
                "pix": 0,
                "debit": 0.12,
                "credit": {
                    "1x": 0.03,
                    "2x": 0.06,
                    "3x": 0.09,
                    "4x": 0.12,
                    "5x": 0.15,
                    "6x": 0.18,
                    "7x": 0.21,
                    "8x": 0.24,
                    "9x": 0.27,
                    "10x": 0.3,
                    "11x": 0.33,
                    "12x": 0.36,
                    "13x": 0.39,
                    "14x": 0.42,
                    "15x": 0.45,
                    "16x": 0.48,
                    "17x": 0.51,
                    "18x": 0.54
                }
            }
        },
        {
            "id": 7,
            "name": "BACEN",
            "active": true,
            "standard": {
                "pix": 0.02,
                "debit": 0,
                "credit": {
                    "1x": 0,
                    "2x": 0,
                    "3x": 0,
                    "4x": 0,
                    "5x": 0,
                    "6x": 0,
                    "7x": 0,
                    "8x": 0,
                    "9x": 0,
                    "10x": 0,
                    "11x": 0,
                    "12x": 0,
                    "13x": 0,
                    "14x": 0,
                    "15x": 0,
                    "16x": 0,
                    "17x": 0,
                    "18x": 0
                }
            },
            "markup": {
                "pix": 0.1,
                "debit": 0,
                "credit": {
                    "1x": 0,
                    "2x": 0,
                    "3x": 0,
                    "4x": 0,
                    "5x": 0,
                    "6x": 0,
                    "7x": 0,
                    "8x": 0,
                    "9x": 0,
                    "10x": 0,
                    "11x": 0,
                    "12x": 0,
                    "13x": 0,
                    "14x": 0,
                    "15x": 0,
                    "16x": 0,
                    "17x": 0,
                    "18x": 0
                }
            },
            "fees": {
                "pix": 0.12,
                "debit": 0,
                "credit": {
                    "1x": 0,
                    "2x": 0,
                    "3x": 0,
                    "4x": 0,
                    "5x": 0,
                    "6x": 0,
                    "7x": 0,
                    "8x": 0,
                    "9x": 0,
                    "10x": 0,
                    "11x": 0,
                    "12x": 0,
                    "13x": 0,
                    "14x": 0,
                    "15x": 0,
                    "16x": 0,
                    "17x": 0,
                    "18x": 0
                }
            }
        },
        {
            "id": 8,
            "name": "ANTIFRAUD",
            "active": true,
            "standard": {
                "pix": 0,
                "debit": 0,
                "credit": {
                    "1x": 0,
                    "2x": 0,
                    "3x": 0,
                    "4x": 0,
                    "5x": 0,
                    "6x": 0,
                    "7x": 0,
                    "8x": 0,
                    "9x": 0,
                    "10x": 0,
                    "11x": 0,
                    "12x": 0,
                    "13x": 0,
                    "14x": 0,
                    "15x": 0,
                    "16x": 0,
                    "17x": 0,
                    "18x": 0
                }
            },
            "markup": {
                "pix": 0,
                "debit": 0,
                "credit": {
                    "1x": 0,
                    "2x": 0,
                    "3x": 0,
                    "4x": 0,
                    "5x": 0,
                    "6x": 0,
                    "7x": 0,
                    "8x": 0,
                    "9x": 0,
                    "10x": 0,
                    "11x": 0,
                    "12x": 0,
                    "13x": 0,
                    "14x": 0,
                    "15x": 0,
                    "16x": 0,
                    "17x": 0,
                    "18x": 0
                }
            },
            "fees": {
                "pix": 0,
                "debit": 0,
                "credit": {
                    "1x": 0,
                    "2x": 0,
                    "3x": 0,
                    "4x": 0,
                    "5x": 0,
                    "6x": 0,
                    "7x": 0,
                    "8x": 0,
                    "9x": 0,
                    "10x": 0,
                    "11x": 0,
                    "12x": 0,
                    "13x": 0,
                    "14x": 0,
                    "15x": 0,
                    "16x": 0,
                    "17x": 0,
                    "18x": 0
                }
            }
        }
    ]
}

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.


Did this page help you?