Consumption
Serviço responsável pelo monitoramento e pagamento de contas de consumos.
O monitoramente é realizado através da inclusão de contas de consumo com recepção periódica do saldo atualizado e consulta de movimentos para visualização de extrato sob demanda.
O pagamento é realizado através de transações de cartão de crédito para realizar recargas ou pagamentos.
Warning
O aplicativo deve estar preparado para que uma mesma conta de consumo esteja incluída em múltiplas contas de usuário, bem como estar igualmente preparado para que uma mesma conta de usuário esteja ativa simultaneamente em múltiplos aparelhos.
Connect
Testa a conectividade com o serviço.
POST {baseAddress}/connect
Parâmetros
Este método não possui nenhum parâmetro de entrada.
Retorno
false
| Tipo | Descrição |
|---|---|
| Boolean | Retorna verdadeiro se houver conectividade com o servidor. Obrigatório. |
AddAccount
Adiciona uma nova conta de consumo para ser monitorada em uma conta de acesso.
As contas de consumos criadas a partir dos ingressos adquiridos pela loja do cliente através da conta de acesso serão automaticamente vinculadas.
O campo NfcUid é obrigatório, caso o código da conta de consumo informado esteja criptografado
O campo NfcUid é opcional, caso o código da conta de consumo informado não esteja criptografado
POST {baseAddress}/addAccount
{
"CloudAccountEid": 0,
"Code": "{{texto}}",
"NfcUid": "{{texto}}"
}
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
| data | AddAccountData | Dados para adição. Obrigatório. |
Retorno
{
"Account": {
"AccountNumber": 0,
"MemberId": 0,
"Type": 0,
"CustomerType": {
"Id": 0,
"Name": "{{texto}}"
},
"Owner": "{{texto}}",
"Code": "{{texto}}",
"CreditLimit": 0.0,
"CurrentBalance": 0.0,
"AvailableCredit": 0.0,
"PayableValue": 0.0,
"Status": 0,
"HotelReserve": {
"HotelEid": "{{texto}}",
"RoomNumber": "{{texto}}",
"GuestEid": "{{texto}}",
"Reserve": "{{texto}}",
"ReserveEid": "{{texto}}"
}
}
}
| Tipo | Descrição |
|---|---|
| AddAccountResult | Retorna os dados conta de consumo adicionada. Obrigatório. |
RemoveAccount
Remove uma ou mais contas de consumo do monitoramento de uma conta de acesso.
As contas de consumos criadas a partir dos ingressos adquiridos pela loja do cliente através da conta de acesso não poderão ser removidos.
POST {baseAddress}/removeAccount
{
"CloudAccountEid": 0,
"AccountNumbers": [
0
]
}
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
| data | RemoveAccountData | Dados para remoção. Obrigatório. |
Retorno
Este método não possui retorno.
Refresh
Recebe as atualizações das contas de consumo monitoradas por uma conta de acesso, recebendo:
1. Saldo das contas de consumo monitoradas por uma conta de acesso.
2. As configurações atualizadas que orientam as ações que devem ser realizadas pelo aplicativo. Tais configurações podem ser alteradas a qualquer momento e o aplicativo deve ser preparado para mudanças a cada chamada.
Contas de consumo não retornadas devem ser removidas da visualização do usuário. Esta situação ocorre quando a conta de consumo for removida da conta de acesso através de outro aparelho logado.
POST {baseAddress}/refresh
{
"CloudAccountEid": 0
}
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
| data | RefreshData | Dados para atualização. Obrigatório. |
Retorno
{
"AllowPosPaidRecharge": false,
"AllowLowCreditNotification": false,
"LowCreditNotificationValue": 0.0,
"LowCreditNotificationInterval": 0,
"Accounts": [
{
"AccountNumber": 0,
"MemberId": 0,
"Type": 0,
"CustomerType": {
"Id": 0,
"Name": "{{texto}}"
},
"Owner": "{{texto}}",
"Code": "{{texto}}",
"CreditLimit": 0.0,
"CurrentBalance": 0.0,
"AvailableCredit": 0.0,
"PayableValue": 0.0,
"Status": 0,
"HotelReserve": {
"HotelEid": "{{texto}}",
"RoomNumber": "{{texto}}",
"GuestEid": "{{texto}}",
"Reserve": "{{texto}}",
"ReserveEid": "{{texto}}"
}
}
]
}
| Tipo | Descrição |
|---|---|
| RefreshResult | Retorna os dados atualizados das contas de consumo e configurações. Obrigatório. |
LoadMovements
Consulta os movimentos de consumo dos últimos 30 dias de uma conta de consumo.
O saldo dos movimentos anteriores a 30 dias são retornados como saldo anterior.
POST {baseAddress}/loadMovements
{
"CloudAccountEid": 0,
"AccountNumber": 0
}
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
| data | LoadMovementsData | Dados para consulta. Obrigatório. |
Retorno
{
"PreviousBalance": 0.0,
"Movements": [
{
"AccountNumber": 0,
"MovementNumber": 0,
"MovementUID": "{{texto}}",
"Shop": "{{texto}}",
"Type": 0,
"Origin": 0,
"Description": "{{texto}}",
"DateTime": "\/Date(1768791600000)\/",
"Value": 0.0,
"PosNumber": 0,
"PosType": "{{texto}}",
"Operator": "{{texto}}",
"Details": [
{
"ItemNumber": 0,
"ItemName": "{{texto}}",
"Quantity": 0.0,
"MeasureUnit": "{{texto}}",
"CanFractionate": false,
"UnitPrice": 0.0,
"SubTotal": 0.0,
"IsReversed": false
}
]
}
]
}
| Tipo | Descrição |
|---|---|
| LoadMovementsResult | Retorna os movimentos de consumo realizados. Obrigatório. |
LoadPayment
Carrega os dados necessários o pagamento de pós-pago ou recarga de pré-pago nas contas de consumo monitoradas por uma conta de acesso.
Além disso, esse método recebe eventuais atualizações realizadas nas contas de consumo. Este comportamento tem objetivo de evitar nova consulta ao servidor caso tenha havido atualizações e garantir que a função de pagamento seja sempre ativada com as contas de consumo atualizadas.
POST {baseAddress}/loadPayment
{
"CloudAccountEid": 0,
"AccountNumbers": [
0
]
}
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
| data | LoadPaymentData | Dados para carregamento. Obrigatório. |
Retorno
{
"MaxLengths": {
"CardHolderName": 0,
"CardNumber": 0,
"SecurityCode": 0
},
"TotalPayableValue": 0.0,
"ParcelOptions": [
{
"Quantity": 0,
"Value": 0.0
}
],
"ParcelSettings": {
"MaxParcels": 0,
"MinParcelValue": 0.0
},
"Refresh": {
"AllowPosPaidRecharge": false,
"AllowLowCreditNotification": false,
"LowCreditNotificationValue": 0.0,
"LowCreditNotificationInterval": 0,
"Accounts": [
{
"AccountNumber": 0,
"MemberId": 0,
"Type": 0,
"CustomerType": {
"Id": 0,
"Name": "{{texto}}"
},
"Owner": "{{texto}}",
"Code": "{{texto}}",
"CreditLimit": 0.0,
"CurrentBalance": 0.0,
"AvailableCredit": 0.0,
"PayableValue": 0.0,
"Status": 0,
"HotelReserve": {
"HotelEid": "{{texto}}",
"RoomNumber": "{{texto}}",
"GuestEid": "{{texto}}",
"Reserve": "{{texto}}",
"ReserveEid": "{{texto}}"
}
}
]
},
"Cards": [
{
"InputSecurityCode": false,
"Eid": 0,
"CardType": 0,
"CardHolderName": "{{texto}}",
"CardNumber": "{{texto}}",
"ExpiryMonth": 0,
"ExpiryYear": 0
}
],
"EnabledCardTypes": [
0
],
"HasAcquirerAuthentication": false,
"CanStoreCard": false,
"AcquirerAuthenticationProvider": 0
}
| Tipo | Descrição |
|---|---|
| LoadPaymentResult | Retorna os dados necessários para realização do pagamento e as últimas atualizações as contas de consumo. Obrigatório. |
LoadAcquirerAuthentication
Carrega os parâmetros necessários para compor os dados que serão utilizados no processo de autenticação do SDK (https://developercielo.github.io/manual/3ds)
O processo de autenticação deverá ser implementado de acordo com a documentação da adquirente Cielo, seja para plataforma Android, IOS ou JavaScript.
Android: https://developercielo.github.io/manual/integracao-sdk-android
IOS: https://developercielo.github.io/manual/integracao-sdk-ios
JavaScript: https://developercielo.github.io/manual/integracao-javascript
Fluxo resumido:
1) Realizar chamada ao método LoadAcquirerAuthentication da API antes da efetivação do pagamento, depois de todas as informações do cartão/pagamento terem sido capturadas.
2) Realizar o processo de autenticação do SDK utilizando os parâmetros retornados no método LoadAcquirerAuthentication, juntamente com os parâmetros existentes na própria aplicação, dados do cartão, valores, etc...
3) Usuário poderá interagir (gerenciado pelo SDK) com o popup do desafio (onde algumas informações serão requeridas/confirmadas)
4) Independente do resultado da autenticação no SDK, recomendamos realizar chamada aos métodos de pagamento (PerformPayment/PerformRecharge) passando todas as informações do resultado da autenticação (através do campo AcquirerAuthenticationData) juntamente com o restante das informações de pagamento.
5) A decisão do processamento do pagamento (processar ou descartar, de acordo com o resultado da autenticação) será guiado pela configuração 'Autenticação 3DS' nas configurações da API no MultiClubes.
Para ter acesso ao aplicativo de exemplo da implementação SDK Android, clique aqui.
POST {baseAddress}/loadAcquirerAuthentication
{
"CloudAccountEid": 0,
"NewCard": {
"CardType": 0,
"CardHolderName": "{{texto}}",
"CardNumber": "{{texto}}",
"ExpiryMonth": 0,
"ExpiryYear": 0,
"SecurityCode": "{{texto}}",
"StoreCard": false
},
"AccountNumbers": [
0
]
}
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
| data | LoadAcquirerAuthenticationData | Dados para carregamento. Obrigatório. |
Retorno
{
"AuthenticationToken": "{{texto}}",
"MerchantId": "{{texto}}",
"AccountApprovedCountPaymentsLast24Hours": 0,
"AccountApprovedCountPaymentsLast6Months": 0,
"AccountApprovedCountPaymentsLast1Year": 0,
"CardApprovedCountPaymentsLast24Hours": 0,
"AccountCreationDateTime": "\/Date(1768791600000)\/",
"AccountLastChangedDateTime": "\/Date(1768791600000)\/"
}
| Tipo | Descrição |
|---|---|
| LoadAcquirerAuthenticationResult | Retorna os parâmetros necessários para realização da autenticação. Obrigatório. |
PerformPayment
Paga um saldo negativo de uma conta de consumo pós-paga.
Caso a transação de cartão de crédito seja aprovada pela adquirente, o pagamento é realizado e as atualizações serão retornadas. Dentre as atualizações haverá o movimento de consumo de pagamento.
Caso a transação de cartão de crédito seja negada pela adquirente, o pagamento não será realizado e será retornada mensagem de erro contendo o motivo que deve ser exibido para o usuário.
POST {baseAddress}/performPayment
{
"AccountNumbers": [
0
],
"AcquirerAuthenticationData": {
"AcquirerAuthenticationResponse": 0,
"Cavv": "{{texto}}",
"Xid": "{{texto}}",
"Eci": "{{texto}}",
"Version": "{{texto}}",
"ReferenceId": "{{texto}}",
"ReturnCode": "{{texto}}",
"ReturnMessage": "{{texto}}"
},
"CloudAccountEid": 0,
"Value": 0.0,
"Parcels": 0,
"ExistingCard": {
"Eid": 0,
"SecurityCode": "{{texto}}"
},
"NewCard": {
"CardType": 0,
"CardHolderName": "{{texto}}",
"CardNumber": "{{texto}}",
"ExpiryMonth": 0,
"ExpiryYear": 0,
"SecurityCode": "{{texto}}",
"StoreCard": false
}
}
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
| data | PerformPaymentData | Dados para pagamento. Obrigatório. |
Retorno
{
"Approved": false,
"Message": "{{texto}}",
"Refresh": {
"AllowPosPaidRecharge": false,
"AllowLowCreditNotification": false,
"LowCreditNotificationValue": 0.0,
"LowCreditNotificationInterval": 0,
"Accounts": [
{
"AccountNumber": 0,
"MemberId": 0,
"Type": 0,
"CustomerType": {
"Id": 0,
"Name": "{{texto}}"
},
"Owner": "{{texto}}",
"Code": "{{texto}}",
"CreditLimit": 0.0,
"CurrentBalance": 0.0,
"AvailableCredit": 0.0,
"PayableValue": 0.0,
"Status": 0,
"HotelReserve": {
"HotelEid": "{{texto}}",
"RoomNumber": "{{texto}}",
"GuestEid": "{{texto}}",
"Reserve": "{{texto}}",
"ReserveEid": "{{texto}}"
}
}
]
}
}
| Tipo | Descrição |
|---|---|
| PaymentResult | Retorna os dados da tentativa de pagamento e as últimas atualizações das contas de consumo caso seja aprovado. |
PerformRecharge
Recarrega um valor em uma conta de consumo pré-paga.
Caso a transação de cartão de crédito seja aprovada pela adquirente, a inclusão do valor como recarga é realizado e as atualizações serão retornadas. Dentre as atualizações haverá o movimento de consumo de recarga.
Caso a transação de cartão de crédito seja negada pela adquirente, a inclusão do valor não será realizada e será retornada mensagem de erro contendo o motivo que deve ser exibido para o usuário.
POST {baseAddress}/performRecharge
{
"Recharges": [
{
"AccountNumber": 0,
"Value": 0.0
}
],
"AcquirerAuthenticationData": {
"AcquirerAuthenticationResponse": 0,
"Cavv": "{{texto}}",
"Xid": "{{texto}}",
"Eci": "{{texto}}",
"Version": "{{texto}}",
"ReferenceId": "{{texto}}",
"ReturnCode": "{{texto}}",
"ReturnMessage": "{{texto}}"
},
"CloudAccountEid": 0,
"Value": 0.0,
"Parcels": 0,
"ExistingCard": {
"Eid": 0,
"SecurityCode": "{{texto}}"
},
"NewCard": {
"CardType": 0,
"CardHolderName": "{{texto}}",
"CardNumber": "{{texto}}",
"ExpiryMonth": 0,
"ExpiryYear": 0,
"SecurityCode": "{{texto}}",
"StoreCard": false
}
}
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
| data | PerformRechargeData | Dados para recarga. Obrigatório. |
Retorno
{
"Approved": false,
"Message": "{{texto}}",
"Refresh": {
"AllowPosPaidRecharge": false,
"AllowLowCreditNotification": false,
"LowCreditNotificationValue": 0.0,
"LowCreditNotificationInterval": 0,
"Accounts": [
{
"AccountNumber": 0,
"MemberId": 0,
"Type": 0,
"CustomerType": {
"Id": 0,
"Name": "{{texto}}"
},
"Owner": "{{texto}}",
"Code": "{{texto}}",
"CreditLimit": 0.0,
"CurrentBalance": 0.0,
"AvailableCredit": 0.0,
"PayableValue": 0.0,
"Status": 0,
"HotelReserve": {
"HotelEid": "{{texto}}",
"RoomNumber": "{{texto}}",
"GuestEid": "{{texto}}",
"Reserve": "{{texto}}",
"ReserveEid": "{{texto}}"
}
}
]
}
}
| Tipo | Descrição |
|---|---|
| PaymentResult | Retorna os dados da tentativa de recarga e as últimas atualizações das contas de consumo caso seja aprovado. |
LoadLimit
Carrega os dados necessários para a alteração de limite crédito em contas de consumo pós-pagas.
O limite máximo de crédito pode ser distribuído entre todas as contas de consumo com limite de crédito, incluindo contas com limite nulos ou zerado.
Contas de consumo não retornadas por este método não podem ter seu limite de crédito alterado.
POST {baseAddress}/loadLimit
{
"CloudAccountEid": 0
}
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
| data | LoadLimitData | Dados para o carregamento. Obrigatório. |
Retorno
{
"Limits": [
{
"MaxCreditLimit": 0.0,
"Accounts": [
{
"AccountNumber": 0,
"MemberId": 0,
"Type": 0,
"CustomerType": {
"Id": 0,
"Name": "{{texto}}"
},
"Owner": "{{texto}}",
"Code": "{{texto}}",
"CreditLimit": 0.0,
"CurrentBalance": 0.0,
"AvailableCredit": 0.0,
"PayableValue": 0.0,
"Status": 0,
"HotelReserve": {
"HotelEid": "{{texto}}",
"RoomNumber": "{{texto}}",
"GuestEid": "{{texto}}",
"Reserve": "{{texto}}",
"ReserveEid": "{{texto}}"
}
}
]
}
]
}
| Tipo | Descrição |
|---|---|
| LoadLimitResult | Retorna os dados necessários para alteração do limite de crédito pós-pago. Obrigatório. |
EditLimit
Altera o limite de crédito em contas de consumo pós-pagas.
Retorna as atualizações acumuladas incluindo a alteração de limite realizada.
Somente contas de consumo retornadas por Consumption.LoadLimit podem ter seus limites de créditos alterados.
POST {baseAddress}/editLimit
{
"Changes": [
{
"AccountNumber": 0,
"CreditLimit": 0.0
}
],
"CloudAccountEid": 0
}
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
| data | EditLimitData | Dados para alteração de limite. Obrigatório. |
Retorno
{
"AllowPosPaidRecharge": false,
"AllowLowCreditNotification": false,
"LowCreditNotificationValue": 0.0,
"LowCreditNotificationInterval": 0,
"Accounts": [
{
"AccountNumber": 0,
"MemberId": 0,
"Type": 0,
"CustomerType": {
"Id": 0,
"Name": "{{texto}}"
},
"Owner": "{{texto}}",
"Code": "{{texto}}",
"CreditLimit": 0.0,
"CurrentBalance": 0.0,
"AvailableCredit": 0.0,
"PayableValue": 0.0,
"Status": 0,
"HotelReserve": {
"HotelEid": "{{texto}}",
"RoomNumber": "{{texto}}",
"GuestEid": "{{texto}}",
"Reserve": "{{texto}}",
"ReserveEid": "{{texto}}"
}
}
]
}
| Tipo | Descrição |
|---|---|
| RefreshResult | Retorna os dados atualizados das contas de consumo e configurações. Obrigatório. |
Transfer
Transfere saldo para contas de consumo.
Retorna os números de movimentos e a atualização de saldo.
POST {baseAddress}/transfer
{
"CloudAccountEid": 0,
"Transfers": [
{
"OriginAccountNumber": 0,
"DestinAccountNumber": 0,
"Value": 0.0
}
]
}
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
| data | PerformTransferData | Dados para transferência de saldo. Obrigatório. |
Retorno
{
"Approved": false,
"Message": "{{texto}}",
"TransferMovements": [
{
"OriginAccountNumber": 0,
"DestinAccountNumber": 0,
"MovementNumber": 0
}
],
"Refresh": {
"AllowPosPaidRecharge": false,
"AllowLowCreditNotification": false,
"LowCreditNotificationValue": 0.0,
"LowCreditNotificationInterval": 0,
"Accounts": [
{
"AccountNumber": 0,
"MemberId": 0,
"Type": 0,
"CustomerType": {
"Id": 0,
"Name": "{{texto}}"
},
"Owner": "{{texto}}",
"Code": "{{texto}}",
"CreditLimit": 0.0,
"CurrentBalance": 0.0,
"AvailableCredit": 0.0,
"PayableValue": 0.0,
"Status": 0,
"HotelReserve": {
"HotelEid": "{{texto}}",
"RoomNumber": "{{texto}}",
"GuestEid": "{{texto}}",
"Reserve": "{{texto}}",
"ReserveEid": "{{texto}}"
}
}
]
}
}
| Tipo | Descrição |
|---|---|
| TransferResult | Retorna os dados atualizados das contas de consumo e configurações, e os números de movimento. Obrigatório. |
ReverseTransfer
Reverte a transferência de saldo para contas de consumo.
POST {baseAddress}/reverseTransfer
{
"CloudAccountEid": 0,
"MovementNumbers": [
0
]
}
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
| data | ReverseTransferData | Dados para reverter transferência de saldo. Obrigatório. |
Retorno
{
"AllowPosPaidRecharge": false,
"AllowLowCreditNotification": false,
"LowCreditNotificationValue": 0.0,
"LowCreditNotificationInterval": 0,
"Accounts": [
{
"AccountNumber": 0,
"MemberId": 0,
"Type": 0,
"CustomerType": {
"Id": 0,
"Name": "{{texto}}"
},
"Owner": "{{texto}}",
"Code": "{{texto}}",
"CreditLimit": 0.0,
"CurrentBalance": 0.0,
"AvailableCredit": 0.0,
"PayableValue": 0.0,
"Status": 0,
"HotelReserve": {
"HotelEid": "{{texto}}",
"RoomNumber": "{{texto}}",
"GuestEid": "{{texto}}",
"Reserve": "{{texto}}",
"ReserveEid": "{{texto}}"
}
}
]
}
| Tipo | Descrição |
|---|---|
| RefreshResult | Retorna os dados atualizados das contas de consumo e configurações. Obrigatório. |
LoadVouchers
Carrega os dados dos vouchers de uma conta.
POST {baseAddress}/loadVouchers
{
"CloudAccountEid": 0
}
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
| data | LoadVoucherData | Dados para o carregamento dos vouchers. |
Retorno
[
{
"AccountNumber": 0,
"Vouchers": [
{
"VoucherNumber": 0,
"Product": "{{texto}}",
"Value": 0.0,
"Validity": "\/Date(1768791600000)\/",
"Description": "{{texto}}"
}
]
}
]
| Tipo | Descrição |
|---|---|
| LoadVoucherResult[] | Retorna os dados dos vouchers da conta. |
CreatePixPayment
Cria código para pagamento PIX do cartão de consumo
POST {baseAddress}/createPixPayment
{
"AccountNumbers": [
0
],
"CloudAccountEid": 0,
"Value": 0.0
}
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
| data | CreatePixPaymentData | Dados para a criação do pagamento PIX. |
Retorno
{
"CodeContent": "{{texto}}",
"PixCodeId": 0,
"TransactionId": 0,
"ExpirationSeconds": 0,
"HubEndpoint": "{{texto}}"
}
| Tipo | Descrição |
|---|---|
| CreatePixResult | Retorna os dados da transação PIX criada. |
CreatePixRecharge
Cria código para recarga PIX do cartão de consumo
POST {baseAddress}/createPixRecharge
{
"Recharges": [
{
"AccountNumber": 0,
"Value": 0.0
}
],
"CloudAccountEid": 0,
"Value": 0.0
}
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
| data | CreatePixRechargeData | Dados para a criação da recarga PIX. |
Retorno
{
"CodeContent": "{{texto}}",
"PixCodeId": 0,
"TransactionId": 0,
"ExpirationSeconds": 0,
"HubEndpoint": "{{texto}}"
}
| Tipo | Descrição |
|---|---|
| CreatePixResult | Retorna os dados da transação PIX criada. |
AbortPix
Cancela transação PIX criada para pagamento ou recarga do cartão de consumo
POST {baseAddress}/abortPix
{
"CloudAccountEid": 0,
"TransactionId": 0
}
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
| data | AbortPixData | Dados para o cancelamento da transação PIX. |
Retorno
{
"AbortAttemptSuccess": false,
"TransactionAborted": false
}
| Tipo | Descrição |
|---|---|
| AbortPixResult | Retorna o resultado da tentativa de cancelamento. |
ConfirmPixPayment
Confirma pagamento PIX realizando a integração com o sistema
POST {baseAddress}/confirmPixPayment
{
"AccountNumbers": [
0
],
"CloudAccountEid": 0,
"TransactionId": 0,
"Value": 0.0
}
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
| data | ConfirmPixPaymentData | Dados para a integração da transação PIX paga. |
Retorno
{
"Refresh": {
"AllowPosPaidRecharge": false,
"AllowLowCreditNotification": false,
"LowCreditNotificationValue": 0.0,
"LowCreditNotificationInterval": 0,
"Accounts": [
{
"AccountNumber": 0,
"MemberId": 0,
"Type": 0,
"CustomerType": {
"Id": 0,
"Name": "{{texto}}"
},
"Owner": "{{texto}}",
"Code": "{{texto}}",
"CreditLimit": 0.0,
"CurrentBalance": 0.0,
"AvailableCredit": 0.0,
"PayableValue": 0.0,
"Status": 0,
"HotelReserve": {
"HotelEid": "{{texto}}",
"RoomNumber": "{{texto}}",
"GuestEid": "{{texto}}",
"Reserve": "{{texto}}",
"ReserveEid": "{{texto}}"
}
}
]
}
}
| Tipo | Descrição |
|---|---|
| ConfirmPixResult | Retorna os dados da transação confirmada. |
ConfirmPixRecharge
Confirma recarga PIX realizando a integração com o sistema
POST {baseAddress}/confirmPixRecharge
{
"Recharges": [
{
"AccountNumber": 0,
"Value": 0.0
}
],
"CloudAccountEid": 0,
"TransactionId": 0,
"Value": 0.0
}
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
| data | ConfirmPixRechargeData | Dados para a integração da transação PIX paga. |
Retorno
{
"Refresh": {
"AllowPosPaidRecharge": false,
"AllowLowCreditNotification": false,
"LowCreditNotificationValue": 0.0,
"LowCreditNotificationInterval": 0,
"Accounts": [
{
"AccountNumber": 0,
"MemberId": 0,
"Type": 0,
"CustomerType": {
"Id": 0,
"Name": "{{texto}}"
},
"Owner": "{{texto}}",
"Code": "{{texto}}",
"CreditLimit": 0.0,
"CurrentBalance": 0.0,
"AvailableCredit": 0.0,
"PayableValue": 0.0,
"Status": 0,
"HotelReserve": {
"HotelEid": "{{texto}}",
"RoomNumber": "{{texto}}",
"GuestEid": "{{texto}}",
"Reserve": "{{texto}}",
"ReserveEid": "{{texto}}"
}
}
]
}
}
| Tipo | Descrição |
|---|---|
| ConfirmPixResult | Retorna os dados da transação confirmada. |