Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Serviço destinado a fazer consulta de formas de recebimento.
POST https://api.tiny.com.br/api2/formas.recebimento.pesquisa.php
| Parâmetro | Tipo | Ocorrência | Descrição |
|---|---|---|---|
| token | string | obrigatório | Chave gerada para identificar sua empresa |
| formato | string | obrigatório | Formato do retorno (json) |
| situacao | string | opcional | Situação da forma de recebimento (Habilitada ou Desabilitada) (1) |
(1) Caso não seja enviado valor neste parâmetro, todas as situações serão consideradas.
| Campo | Tipo | Tamanho | Ocorrência | Descrição |
|---|---|---|---|---|
| retorno | object | - | obrigatório | Elemento raiz do retorno |
| retorno.status_processamento | int | - | obrigatório | Conforme tabela “Status de Processamento” |
| retorno.status | string | - | obrigatório | ”OK” ou “Erro” |
| retorno.codigo_erro | int | - | condicional | Conforme tabela “Códigos de erro” (2) |
| retorno.erros[] | list | - | condicional | Lista dos erros encontrados [0..n] (2) |
| retorno.erros[].erro | string | - | condicional | Descrição do erro (2) |
| retorno.formasRecebimento[] | list | - | condicional | Lista de resultados da pesquisa (3) |
| retorno.formasRecebimento[].formaRecebimento | object | - | condicional | Elemento representando uma forma de recebimento (3) |
| retorno.formasRecebimento[].formaRecebimento.descricao | string | 50 | condicional | Descrição da forma de recebimento (3) |
| retorno.formasRecebimento[].formaRecebimento.situacao | string | 12 | condicional | Situação (Habilitada, Desabilitada) (3) |
(2) Campos de erro aparecem apenas quando status = “Erro”
(3) Campos de formas de recebimento aparecem apenas quando status = “OK”
curl -X POST https://api.tiny.com.br/api2/formas.recebimento.pesquisa.php \
-d "token=SEU_TOKEN&formato=json&situacao=Habilitada"
{
"retorno": {
"status_processamento": 1,
"status": "Erro",
"codigo_erro": 2,
"erros": [
{
"erro": "token invalido"
}
]
}
}
{
"retorno": {
"status_processamento": 2,
"status": "Erro",
"codigo_erro": 20,
"erros": [
{
"erro": "A Consulta não retornou registros"
}
]
}
}
{
"retorno": {
"status_processamento": 3,
"status": "OK",
"formasRecebimento": [
{
"formaRecebimento": {
"descricao": "Dinheiro",
"situacao": "Desabilitada"
}
},
{
"formaRecebimento": {
"descricao": "Cartão de crédito",
"situacao": "Habilitada"
}
}
]
}
}