Skip to main content

​
Endpoint

POST https://api.tiny.com.br/api2/formas.recebimento.pesquisa.php

​
Parâmetros

ParâmetroTipoOcorrênciaDescrição
tokenstringobrigatórioChave gerada para identificar sua empresa
formatostringobrigatórioFormato do retorno (json)
situacaostringopcionalSituaçã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.

​
Retorno

CampoTipoTamanhoOcorrênciaDescrição
retornoobject-obrigatórioElemento raiz do retorno
retorno.status_processamentoint-obrigatórioConforme tabela “Status de Processamento”
retorno.statusstring-obrigatório”OK” ou “Erro”
retorno.codigo_erroint-condicionalConforme tabela “Códigos de erro” (2)
retorno.erros[]list-condicionalLista dos erros encontrados [0..n] (2)
retorno.erros[].errostring-condicionalDescrição do erro (2)
retorno.formasRecebimento[]list-condicionalLista de resultados da pesquisa (3)
retorno.formasRecebimento[].formaRecebimentoobject-condicionalElemento representando uma forma de recebimento (3)
retorno.formasRecebimento[].formaRecebimento.descricaostring50condicionalDescrição da forma de recebimento (3)
retorno.formasRecebimento[].formaRecebimento.situacaostring12condicionalSituação (Habilitada, Desabilitada) (3)
(2) Campos de erro aparecem apenas quando status = “Erro”
(3) Campos de formas de recebimento aparecem apenas quando status = “OK”

​
Exemplo de chamada

curl -X POST https://api.tiny.com.br/api2/formas.recebimento.pesquisa.php \
  -d "token=SEU_TOKEN&formato=json&situacao=Habilitada"

​
Exemplos de retorno

​
Erro - Token inválido

{
  "retorno": {
    "status_processamento": 1,
    "status": "Erro",
    "codigo_erro": 2,
    "erros": [
      {
        "erro": "token invalido"
      }
    ]
  }
}

​
Erro - Nenhum resultado

{
  "retorno": {
    "status_processamento": 2,
    "status": "Erro",
    "codigo_erro": 20,
    "erros": [
      {
        "erro": "A Consulta não retornou registros"
      }
    ]
  }
}

​
Sucesso

{
  "retorno": {
    "status_processamento": 3,
    "status": "OK",
    "formasRecebimento": [
      {
        "formaRecebimento": {
          "descricao": "Dinheiro",
          "situacao": "Desabilitada"
        }
      },
      {
        "formaRecebimento": {
          "descricao": "Cartão de crédito",
          "situacao": "Habilitada"
        }
      }
    ]
  }
}