Apresentação dos web sercices ordem de pagamento por e-mail

Os web services são desenvolvidos de acordo com o protocolo SOAP versão 1.2 (Simple Object Access Protocol) e são apresentados no arquivo wsdl seguinte:

Se você se conectar a internet via um proxy a partir de um servidor aplicativo, favor entrar em contato com seu suporte informático para saber se vai ser preciso configurar o acesso a esta URL.

Para garantir a segurança da comunicação, os web services (SOAP) são criptografados com o protocolo HTTPS. Além disso, um mecanismo de assinatura foi implementado para validar e autenticar a troca dos dados.

Descrição do serviço

Este serviço permite automatizar a criação / modificação de uma ordem de pagamento para um ou mais destinatários.

Para isso, 2 métodos podem ser usados:

  • create quando criar uma ordem de pagamento por e-mail.
  • updatequando modificar uma ordem de pagamento por e-mail.

A resposta retornada pela plataforma de pagamento contém a lista das ordens criadas/modificadas.

Cada ordem é associada a um código, um endereço e-mail e uma URL de pagamento.

Envio para uma lista de destinatários:

Pode-se definir na solicitação uma lista de destinatários.

Neste caso, uma ordem de pagamento por destinatário é criada. Portanto, o número de ordens de pagamento e de destinatários é o mesmo.

Desta forma, após o pagamento, cada transação corresponderá a um único destinatário.

Para identificar as diferentes ordens criadas, o campo reference usa de 1 a 3 dígitos numéricos.

Estes dígitos são concatenados à referência da ordem com um hífen. Exemplo: [ref]-001, [ref]-002, [ref]-003.

Exemplo de uma ordem cujo campo reference tem o valor "Pagamento_xyz":

Se a ordem for enviada para 3 destinatários, então 3 ordens serão criadas com as referências seguintes:

  • Pagamento_xyz-001
  • Pagamento_xyz-002
  • Pagamento_xyz-003

Utilização de uma ferramenta de mailing externo:

Se o vendedor desejar usar sua própria ferramenta de difusão, deverá desativar o envio automático dos e-mails nas suas solicitações de criação / modificação de ordem de pagamento.

Ao analisar a resposta, ele encontrará as informações necessárias para completar seu e-mail: URL de pagamento, referência da ordem e endereço e-mail do destinatário.