Pesquisar Formas de Recebimento API 2.0

Serviço destinado a fazer consulta de formas de recebimento

ElementoTipoOcorrênciaDescrição
tokenstringobrigatórioChave gerada para identificar sua empresa
formatostringobrigatórioFormato do retorno (json ou xml)
situacao (1)stringopcionalSituação da forma de recebimento (Habilitada ou Desabilitada)

(1) - Caso não seja enviado valor neste parâmetro todas as situações serão consideradas.

ElementoTipoTamanhoOcorrênciaDescrição
retorno object-obrigatórioElemento raiz do retorno
retorno.status_processamentoint-obrigatórioConforme tabela "Status de Processamento"
retorno.statusstring-obrigatórioContém o status do retorno “OK” ou “Erro”. Para o caso de conter erros estes serão descritos abaixo
retorno.codigo_erro (1)int-condicionalConforme tabela "Códigos de erro"
retorno.erros[ ] (1) (3)list -condicional [0..n]Contém a lista dos erros encontrados.
retorno.erros[ ].errostring-condicionalMensagem contendo a descrição do erro
retorno.formasRecebimento[ ] (2)list-condicionalLista de resultados da pesquisa
retorno.formasRecebimento[ ].formaRecebimento (2)object-condicionalElemento utilizado para representar uma forma de recebimento.
retorno.formasRecebimento[ ].formaRecebimento.descricaostring50condicionalDescrição da forma de recebimento
retorno.formasRecebimento[ ].formaRecebimento.situacaostring12condicionalSituação da forma de recebimento (Habilitada, Desabilitada)

(1) - Somente estará presente no retorno caso o elemento "status" seja "Erro".
(2) - Somente estará presente no retorno caso o elemento "status" seja "OK".
(3) - Estes campos somente serão informados caso o retorno contenha erros.


$url = 'https://api.tiny.com.br/api2/formas.recebimento.pesquisa.php';
$token = 'coloque aqui a sua chave da api';
$formato = 'XML';
$data = "token=$token&formato=$formato";

enviarREST($url, $data);

function enviarREST($url, $data, $optional_headers = null) {
	$params = array('http' => array(
		'method' => 'POST',
	    'content' => $data
	));

	if ($optional_headers !== null) {
		$params['http']['header'] = $optional_headers;
	}

	$ctx = stream_context_create($params);
	$fp = @fopen($url, 'rb', false, $ctx);
	if (!$fp) {
		throw new Exception("Problema com $url, $php_errormsg");
	}
	$response = @stream_get_contents($fp);
	if ($response === false) {
		throw new Exception("Problema obtendo retorno de $url, $php_errormsg");
	}

	return $response;
}
<?xml version="1.0" encoding="UTF-8"?>
<retorno>
  <status_processamento>1</status_processamento>
  <status>Erro</status>
  <codigo_erro>2</codigo_erro>
  <erros>
    <erro>token invalido</erro>
  </erros>
</retorno>
<?xml version="1.0" encoding="UTF-8"?>
<retorno>
  <status_processamento>2</status_processamento>
  <status>Erro</status>
  <codigo_erro>21</codigo_erro>
  <erros>
    <erro>A consulta retornou mais registros que o permitido</erro>
  </erros>
</retorno>
<?xml version="1.0" encoding="UTF-8"?>
<retorno>
  <status_processamento>3</status_processamento>
  <status>OK</status>
  <pagina>1</pagina>
  <numero_paginas>1</numero_paginas>
  <formasRecebimento>
    <formaRecebimento>
      <descricao>Dinheiro</descricao>
      <situacao>Desabilitada</situacao>
    </formaRecebimento>
    <formaRecebimento>
      <descricao>Cartão de crédito</descricao>
      <situacao>Habilitada</situacao>
    </formaRecebimento>
  </formasRecebimento>
</retorno>