Cativar Saldo

Link API  (Ambiente Desenvolvimento) :

https://devservice.paysimplex.com/API.svc?wsdl

Método CatchBalance
Permite cativar um certo montante (Usado em transações simples).

Parâmetro Entrada:

Parâmetro Descrição Tipo
APIUser Utilizador de acesso à API String
APIPassword Password de acesso à API String
UserGUIDSender Guid do user a quem se pretender cativar o saldo. Disponibilizado pelo paySimplex quando o user efectua o registo/LogIN String
UserGUIDReceiver Guid do user que vai receber o dinheiro que está cativo. Disponibilizado pelo paySimplex quando o user efectua o registo/LogIN String
amount PValor que se pretende cativar Decimal

Parâmetro Saída:

Error Se 0 = Sucesso, se 1 = Erro Int
ErrorsList Listagem de Erros * List
TransactionID ID da transação que foi criada(Pedida sempre que se pretende tratar algo sobre a transação em si) Int
AvaiableBalanceSender Saldo(atualizado) do user a quem se cativou saldo Decimal

Exemplo:

 


Método CancelCaptivateBalance
Cancelar o saldo cativado (Usado em transações simples e complexas).

Parâmetro Entrada:

Parâmetro Descrição Tipo
APIUser Utilizador de acesso à API String
APIPassword Password de acesso à API String
TransactionID ID da transação que foi gerado quando houve o pedido para cativar saldo Int
UserGUIDSender Guid do user a quem se cativou o montante. Disponibilizado pelo paySimplex quando o user efectua o registo/LogIN String
UserGUIDReceiver Guid do user que iria receber o valor cativado. Disponibilizado pelo paySimplex quando o user efectua o registo/LogIN String
Amount Valor que está cativo Decimal

Parâmetro Saída:

Parâmetro Descrição Tipo
Error Se 0 = Sucesso, se 1 = Erro Int
ErrorsList Listagem de Erros * List
AvaiableBalanceSender Saldo(atualizado) do user a quem se cativou o montante Decimal
AvaiableBalanceReceiver Saldo do user que iria receber o que se cativou Decimal

 


Método CollectCaptiveBalance
Método para cobrar saldo cativo e terminar transação (Usado em transações simples).

Parâmetro Entrada:

Parâmetro Descrição Tipo
APIUser Utilizador de acesso à API String
APIPassword Password de acesso à API String
TransactionID ID da transação que foi gerado quando houve o pedido para cativar saldo Int
UserGUIDSender Guid do user a quem se cativou o montante. Disponibilizado pelo paySimplex quando o user efectua o registo/LogIN String
UserGUIDReceiver Guid do user que iria receber o valor cativado. Disponibilizado pelo paySimplex quando o user efectua o registo/LogIN String
Amount Valor que está cativo Decimal
Comission Comissão a ser cobrada ao user que recebe o dinheiro que estava cativado(A comissão pode ser 0) Decimal (Vai ser calculado em % internamente)

Parâmetro Saída:

Parâmetro Descrição Tipo
Error Se 0 = Sucesso, se 1 = Erro Int
ErrorsList Listagem de Erros * List
AvaiableBalanceSender Saldo(atualizado) do user a quem se cativou o montante Decimal
AvaiableBalanceReceiver Saldo do user que iria receber o que se cativou Decimal
SendMoneyTransactionID ID da Transação final(Este ID é diferente do transactionID anteriormente dado) -> ID para referência futura da transação Int

 


API usada para * -> 1 isto é quando vários users vão pagar a 1 user (Chamada de transação complexa)

Método CreateCaptivateProcess
Método para abrir processo, processo ao qual as transações vão estar agregadas -(Transação Complexa)

Parâmetro Entrada:

Parâmetro Descrição Tipo
APIUser Utilizador de acesso à API String
APIPassword Password de acesso à API String
UserGUIDReceiver Guid do user que vai receber o valor cativado. Disponibilizado pelo paySimplex quando o user efectua o registo/LogIN String
Amount Valor Total do processo (Montante total que o user vai receber) Decimal

Parâmetro Saída:

Parâmetro Descrição Tipo
Error Se 0 = Sucesso, se 1 = Erro Int
ErrorsList Listagem de Erros * List
ProcessID Número do processo(As transactionID vão estar ligadas a este processo) Int

 


Método CatchBalanceInProcess
Método para cativar um certo montante agregado a um Processo(Transação Complexa)

Parâmetro Entrada:

Parâmetro Descrição Tipo
APIUser Utilizador de acesso à API String
APIPassword Password de acesso à API String
UserGUIDSender Guid do user a quem se pretender cativar o saldo. Disponibilizado pelo paySimplex quando o user efectua o registo/LogIN String
UserGUIDReceiver Guid do user que vai receber o dinheiro que se pretende cativar. Disponibilizado pelo paySimplex quando o user efectua o registo/LogIN String
Amount Valor que se pretende cativar ao UserGUIDSender Decimal
ProcessID Número do processo(Processo ao qual se quer agregar este montante que se vai cativar) Int

Parâmetro Saída:

Parâmetro Descrição Tipo
Error Se 0 = Sucesso, se 1 = Erro Int
ErrorsList Listagem de Erros * List
TransactionID ID da transação que foi criada(Pedida sempre que se pretende tratar algo sobre a transação em si). Esta Transação ficou agregada ao Processo Int
AvaiableBalanceSender Saldo(atualizado) do user a quem se cativou saldo Decimal

 


Método CancelCaptivateProcess
Cancelar o Processo todo e os respectivos montantes cativados(Transactions) – (Transação Complexa)

Parâmetro Entrada:

Parâmetro Descrição Tipo
APIUser Utilizador de acesso à API String
APIPassword Password de acesso à API String
Amount Valor Total do Processo Decimal
ProcessID Número do processo(As transactionID estão agregadas a este processo) Int

Parâmetro Saída:

Parâmetro Descrição Tipo
Error Se 0 = Sucesso, se 1 = Erro Int
ErrorsList Listagem de Erros * List

 


Método CollectProcess
Cobrar Saldos Cativos de todo o processo – (Transação Complexa)

Parâmetro Entrada:

Parâmetro Descrição Tipo
APIUser Utilizador de acesso à API String
APIPassword Password de acesso à API String
Amount Valor Total do Processo Decimal
ProcessID Número do processo(As transactionID estão agregadas a este processo) Int
Comission Comissão Total a ser cobrada ao user que recebe o dinheiro que estava cativado(A comissão pode ser 0) Decimal –> Valor numerário total(Valor real que vai ser cobrado ao user)
Tax Imposto Adicional(Tipo taxa bancária etc, esta taxa pode ser 0) -> Montante Final) Decimal –> Valor numerário total(Valor real que vai ser cobrado ao user)

Parâmetro Saída:

Parâmetro Descrição Tipo
Error Se 0 = Sucesso, se 1 = Erro Int
ErrorsList Listagem de Erros * List

 


Método PaymentRequest
Permite o envio de pedidos de pagamento a um utilizador paySimplex através de e-mail, nº telemóvel ou nif.

Parâmetro Entrada:

Parâmetro Descrição Tipo
APIUserName Utilizador de acesso à API String
APIPassword Password de acesso à API String
PhoneNumber Nº de telemóvel associado ao utilizador paySimplex a quem se destina o pedido de pagamento String
NIF NIF associado ao utilizador paySimplex a quem se destina o pedido de pagamento String
Email Email associado ao utilizador paySimplex a quem se destina o pedido de pagamento String
Value Valor do Pagamento Decimal
RequestID Identificador do pedido de pagamento String
URLCallback Url usado para notificar a aceitação do pagamento por parte do utilizador paySimplex
A notificação é feita no formato {urlcallback}?requestid={requestid}
String

Parâmetro Saída:

Parâmetro Descrição Tipo
PaymentRequestGUID Identificador do pedido de pagamento no paySimplex String
RequestID Identificador do pedido de pagamento recebido String
OperationResultCode Código Resposta Int
OperationResultMessage Mensagem Resposta String

Método SetPaymentInvoice
Associar uma fatura(PDF) a um pagamento.

Parâmetro Entrada:

Parâmetro Descrição Tipo
APIUserName Utilizador de acesso à API String
APIPassword Password de acesso à API String
PaymentRequestGUID Identificador do pagamento gerado pelo paySimplex String
PDFFileBytes Bytes do ficheiro PDF byte[]
PDFFilename Nome do ficheiro PDF String

Parâmetro Saída:

Parâmetro Descrição Tipo
OperationResultCode Código Resposta Int
OperationResultMessage Mensagem Resposta String

Método GetPaymentRequestData
Obter os dados de um pedido de pagamento.

Parâmetro Entrada:

Parâmetro Descrição Tipo
APIUserName Utilizador de acesso à API String
APIPassword Password de acesso à API String
PaymentRequestGUID Identidicador do pagamento gerado pelo paySimplex String

Parâmetro Saída:

Parâmetro Descrição Tipo
OperationResultCode Código Resposta Int
OperationResultMessage Mensagem Resposta String
RequestID Identificador do pagamento recebido no pedido de pagamento String
PaymentDate Data de aceitação do pedido de pagamento caso tenha sido aceite DateTime
RequestDate Data do pedido de pagamento DateTime
Value Valor do Pagamento Decimal
PaymentStatusID Valor do Pagamento Int
HasBillingData Indica se existe dados de faturação associados ao pagamento. Boolean
HasDeliveryData Indica se existe dados de entrega associados ao pagamento. Boolean
BillingName Nome (Morada de Faturação) String
BillingStreet Rua (Morada de Faturação) String
BillingCity Cidade (Morada de Faturação) String
BillingPostalCode Código Postal (Morada de Faturação) String
BillingCountry País (Morada de Faturação) String
BillingNIF NIF (Morada de Faturação) String
DeliveryName Nome (Morada de Entrega) String
DeliveryStreet Rua (Morada de Entrega) String
DeliveryCity Cidade (Morada de Entrega) String
DeliveryPostalCode Código Postal (Morada de Entrega) String
DeliveryCountry País (Morada de Entrega) String