Em alternativa ou em complemento ao callback (webhook) pode ler os pagamentos efetuados utilizando um webservice. O webservice para ler os pagamentos efetuados está disponível no seguinte endereço:


 

https://ifthenpay.com/ifmbws/ifmbws.asmx

 

 

Os métodos getPayments, getPaymentsJson e getPaymentsXml devolvem os pagamentos efetuados na entidade e subentidade indicada.

A única diferença entre os três métodos é o formato em que a informação é devolvida. No primeiro (getPayments) é devolvido no formato SOAP (1.1 e 1.2); No segundo (getPaymentsJson) é devolvido em formato JSON; e no terceiro (getPaymentsXml) é devolvido em formato puro XML.

 

Os parâmetros a passar na chamada do método são:

  • Chavebackoffice: Chave fornecida pela IFTHENPAY na assinatura do contrato. Obrigatório.
  • Entidade: Entidade (5 dígitos) fornecida pela IFTHENPAY na assinatura do contrato. Facultativo.
  • Subentidade: Subentidade (3 dígitos) fornecida pela IFTHENPAY na assinatura do contrato. Facultativo.
  • dtHrInicio: Data/Hora inicial dos pagamentos pretendidos no formato dd-MM-yyyy HH:mm:ss. Facultativo.
  • dtHrFim: Data/Hora final dos pagamentos pretendidos no formato dd-MM-yyyy HH:mm:ss. Facultativo.
  • Referencia: Referência multibanco (9 dígitos) sobre a qual se pretende saber a informação do pagamento. Facultativo.
  • Valor: Valor em euros dos pagamentos que se pretende obter informação. Facultativo.
  • Sandbox: Devem indicar 1 ou 0 no caso de utilizarem ou não a plataforma de testes. Obrigatório.

 

O método pode ser chamado de várias formas, conforme as necessidades:


  • Se pretende obter todos os pagamentos efetuados entre duas datas/horas deverá passar os parâmetros chavebackoffice, entidade, subentidade, dtHrInicio, dtHrFim e sandbox. Todos os outros deverão ser deixados em branco. 
Exemplo:
https://ifthenpay.com/ifmbws/ifmbws.asmx/getPayments?chavebackoffice=0000-0000-0000-0000&entidade=11604&subentidade=999&dtHrInicio=23-05-2012 00:00:00&dtHrFim=23-05-2012 23:59:59&referencia=&valor=&sandbox=0 

 

Devolve os pagamentos da entidade 11604, subentidade 999 com a chave de backoffice 0000-0000-0000-0000 efetuados no dia 23-05-2012 entre as 00h00m00s e as 23h59m59s. 

NOTA: Deverá utilizar a sua chave, entidade e subentidade e não as indicadas neste exemplo.

 

 

  • Se pretende apenas saber se uma determinada entidade/referência/valor foi paga deverá passar os parâmetros chavebackoffice, entidade, subentidade, referencia, valor e sandbox e opcionalmente a dtHrInicio e dtHrFim
Exemplo:
https://ifthenpay.com/ifmbws/ifmbws.asmx/getPayments?chavebackoffice=0000-0000-0000-0000&entidade=11604&subentidade=999&dtHrInicio=&dtHrFim=&referencia=999123420&valor=10.25&sandbox=0

 

Devolve, caso existam, os pagamentos efetuados na entidade, referência e valor indicados. Ter em atenção que podem existir mais do que um pagamento dessa referência. Podem também ser passados os parâmetros da data/hora inicial e final. 

 

Estes métodos devolvem a seguinte informação para cada pagamento (1 ou mais):

  • Entidade – entidade utilizada no pagamento (string)
  • Sub_Entidade - subentidade utilizada no pagamento (string)
  • Referencia – referência multibanco paga (9 dígitos)
  • Valor – valor pago em euros
  • Id – id utilizado na geração da referência multibanco (4 dígitos)
  • DtHrPagamento – data/hora do pagamento em formato dd-MM-yyyy HH:mm:ss
  • Processamento – data de processamento yyyyMMdd1
  • Terminal – terminal utilizado no pagamento
  • Tarifa – tarifa do serviço
  • ValorLiquido – valor pago deduzido da tarifa
  • CodigoErro – código de erro
  • MensagemErro – mensagem de erro


Código

Mensagem

0

Sucesso.

1

Não existem pagamentos.

2

Erro nas Datas/Horas.

3

Chave inválida.

9

Erro desconhecido.