NAV

Introdução

A API da HubMoney permite que você receba pagamentos em seu E-Commerce, M-Commerce e Marketplace de forma simples, rápida e segura.​

É possível executar pagamentos das seguintes formas:

As próximas seções apresentam uma visão geral de como consumir nossa API e a aplicação de cada uma das soluções.

Abrangência das Nossas Soluções

E-COMMERCE E M-COMMERCE​

A HubMoney é utilizada por diversas lojas online para a captura de pagamentos via cartão de crédito, cartão de débito e boleto de cobrança. Nossas APIs de Pagamentos permitem que as lojas virtuais tenham um checkout personalizado com sua identidade visual sem a necessidade de abrir uma nova página.​

MARKETPLACE

Temos uma solução moderna e completa para atender as necessidades de seus compradores e vendedores. Nossas APIs de Pagamentos permitem um conjunto de funcionalidades que facilitam a realização de qualquer transação financeira e realização de comissionamentos.​

APPS MOBILE PARA PAGAMENTOS

Nossas APIs de Pagamentos permitem a gestão de todos os usuários, desde os que efetuam o pagamento, aos que receberão os pagamentos realizados. Capturamos a transação no APP do usuário comprador e repassamos o valor ao APP do usuário vendedor em uma conta corrente ou um cartão pré-pago HubMoney. Além disso, realizamos o split de pagamento separando as taxas, tarifas e comissionamentos.

PAGAMENTOS RECORRENTES VIA CARTÃO DE CRÉDITO E BOLETO​

Após se integrar as nossas APIs de Pagamentos, seus sistema poderá capturar transações recorrentes ou de assinaturas para que possamos realizar o controle das transações mensalmente com o valor capturado e a data programada.​

Segurança

O HubMoney utiliza soluções tecnológicas que permitem a segurança das informações seguindo as práticas do PCI.

API De Autenticação

Para uso dos serviços disponibilizados será necessário realizar em primeiro lugar a autenticação na plataforma. Para isso, será necessário você nos enviar os dados para nossa API REST.

Header

Parâmetro Descrição
unique-trx-id (obrigatório)​
Identificador único da transação. Este código identificador único é enviado pela aplicação estiver consumindo nossas APIs.
Long
working-operation-uuid (obrigatório)​
Identificador da Operação fornecido pela equipe Comercial do HubMoney​.
String
gateway-uuid (opcional)​
Será um código fornecido pela equipe comercial da HubMoney. Esse código é obrigatório apenas para execução da API de pagamentos. Esse código está associado ao serviço contratado e também ao Working-Operation-UUID.​
String​

Essa autenticação devolverá um TOKEN temporário, o qual deverá ser utilizado em todos os serviços disponibilizados enquanto for válido.​

A aplicação que está utilizando nossos serviços deverá solicitar um novo TOKEN após encerramento da validade do TOKEN.


Criar Pedido

URL REQUEST:
https://gateway.prod.HubMoney.co/api/acquire/auth

JSON REQUEST:

{
"requesterId": "HubMoney_pagamentos",
"requesterPassword": "12345678901234567890",
"tokenExpirationPeriod": 60
}

Parâmetro Descrição
RequesterId (obrigatório)​
Usuário criado pela plataforma HubMoney e fornecido por e-mail após cadastramento no HubMoney.​
String
RequesterPassword ​ (obrigatório)​
Senha e a chave de acesso fornecidas por e-mail após cadastramento no HubMoney. Ambas devem ser devidamente encriptadas utilizando o padrão de criptografia AES 128b.
String
TokenExpirationPeriod (obrigatório)
Campo onde será determinado o tempo de validade do Token que será gerado. O limite máximo de minutos é 9999. Se o campo estiver com 0, a plataforma aplicará automaticamente 20 minutos.​​
Integer​

Resposta

JSON REQUEST:

{
"responseCode": "0",
"responseMessage": "",
"expireDate": "2017-01-15 22:12:55""
}

Parâmetro Descrição
ResponseCode​ (opcional)​​
Código de retorno ao pedido solicitado​​
String
ResponseMessage ​ (opcional)​
Mensagem descritiva do retorno​.
String
Token (opcional)​
Token gerado para utilização nos serviços considerando que a autenticação seja válida​.
String
ExpireDate ​ (opcional)​
Data e Hora da expiração do Token​
String

HTTP Response Codes

Response Codes Descrição
200 Pedido processado com sucesso. Verifique os códigos de retorno.
400 O Formato do pedido está incorreto, Verifique os Parâmetros.
401 Autenticação inválida. Por favor, verifique o código de retorno.
500 ​ Erro geral. Por favor, entre em contato com o suporte HubMoney no suporte@HubMoney.co

API De Pagamentos / Authorize

Essa API será utilizada para Pré-Autorizar transações (Reserva do valor), Capturar Transações (Solicitar Efetivação do Pagamento diretamente ou de uma transação Pré-Autorizada) e Estornar Transações.
Além disso, será possível realizar o pedido de transações de pagamentos recorrentes e o cancelamento dessa modalidade de pagamento.
Para uso dos serviços disponibilizados nessa API será necessário obter o Requester-Token gerado na API de Autenticação. Considerando que o Request-Token esteja em tempo de uso, basta enviá-lo juntamente com as informações solicitadas abaixo para nossa API REST.

Header

Parâmetros - Header Descrição
requester-id (obrigatório)
Usuário criado pela plataforma HubMoney e fornecido por e-mail após cadastramento no HubMoney.
String
requester-token (obrigatório)
Token obtido na chamada da API de Autenticação.
String
unique-trx-id (obrigatório)
Identificador único da transação. Este código identificador único é enviado pela aplicação estiver consumindo nossas APIs.
Long
gateway-uuid (obrigatório)
Identificador do serviço contratado que deverá ser fornecido pela equipe Comercial do HubMoney ás Lojas.
String

No corpo da requisição JSON você poderá enviar um pedido utilizando o método POST. Esse pedido raiz contempla informações que estão contempladas nos seguintes objetos: Dados do Cartão, Titular do Cartão, Endereço de Entrega, Endereço de Cobrança, Dados Bancários, Recorrência e ID de Pedido Merchant.

Criar Pedido / Authorize

CRIAR PEDIDO / ORDER

A raiz do objeto contempla os dados básicos do pedido.

URL REQUEST:
https://gateway.prod.HubMoney.co/api/acquire/card/authorize

JSON REQUEST:

{
"amount": 0,
"currency": 0,
"installments": 0,
"capture": true,
"transactionUUID": "string",
"transactionType": 1,
"merchantOrderId": "string",
"callBackPaymentInfoURL": "string",
"softDescriptor": "string",
}

Parâmetros Descrição
Amount (obrigatório)
Valor total do pedido a ser submetido ao emissor do cartão. Esse valor é o valor que será debitado do cartão do cliente.
Number
Currency (opcional)
Código numérico da moeda na norma ISO 4217. Para o Real, o código é 986.
Integer
Installments (obrigatório)
Campo para inclusão da quantidade de parcelas. Para pagamentos a vista ou débito, deverá ser utilizado ”1”.
Integer
Capture (obrigatório)
Caso seja autorizada, define se a transação automaticamente autorizada. Use [True] para capturar automaticamente e [False] para aguardar nova chamada para captura.
Boolean
TransactionUUID (opcional)
Tipo de transação a ser registrado pelo sistema de cobrança. Se nenhum billing esse campo poderá vir vazio.
String
TransactionType (obrigatório)
Define-se a transação é Crédito [1] ou Débito [2].
Integer
MerchantOrderID (obrigatório)
Código utilizado pelo Lojista na realização da compra.
String
CallBackPaymentInfoURL (opcional)
URL incluída pela aplicação que está consumindo a API. A HubMoney devolverá informações sobre alteração da transação solicitada.
String
SoftDescriptor (opcional)
Descrição do Lojista a ser demonstrada na fatura do comprador quando utilizarem visa e master. As demais bandeiras não possuem habilitação processadora.
String

DADOS DO CARTÃO / CARD

Este objeto deve ser usado para enviar informações sobre o cartão que está sendo utilizado na compra, que na maioria dos casos é aquele que está logado na loja Web.

URL REQUEST:
https://gateway.prod.HubMoney.co/api/acquire/card/authorize

JSON REQUEST - CONTINUATION:

"card": {
"cardUUID": "string",
"pan": "string",
"cardScheme": "string",
"cardBrand": "string",
"securityCode": "string",
"expirationMonth": 0,
"expirationYear": 0,
"name": "string"
},

Parâmetros Descrição
CardUUID (opcional)
Token que deve ser utilizado em substituição aos dados do cartão para uma autorização direta ou uma transação recorrente. Quando este campo estiver preenchido, nenhum dado do cartão deve ser preenchido.
String
Pan (opcional)
Número do cartão de débito ou crédito.
String
CardScheme (opcional)
Código da adquirente/processadora. Não é necessário preencher esse campo, pois será retornado pelo HubMoney.
String
CardBrand (opcional)
Código da bandeira (Mastercard, Visa, Amex e entre outras). Não é necessário preencher esse campo, pois será retornado pelo HubMoney.
String
SecurityCode (opcional)
Código de Segurança do Cartão.
String
ExpirationMonth (opcional)
Mês de validade do cartão.
Integer
ExpirationYear (opcional)
Ano de validade do Cartão.
Integer
Name (opcional)
Nome do portador impresso no cartão.
String

TITULAR DO CARTÃO / CARDHOLDER

Este objeto deve ser usado para enviar informações sobre o cartão que está sendo utilizado na compra, que na maioria dos casos é aquele que está logado na loja Web.

URL REQUEST:
https://gateway.prod.HubMoney.co/api/acquire/card/authorize

JSON REQUEST - CONTINUATION:

"cardHolder": {
"entity": {
"idUUID": "string",
"name": "string",
"namePrefix": "string",
"phoneCelular": "string",
"phoneHome": "string",
"phoneOther": "string",
"phoneJob": "string",
"phoneExtension": "string",
"fax": "string",
"email": "string",
"erpUniqueId": "string",
"vatNumber": "string",
"identificationNumber": "string",
"identificationIssuer": "string",
"identificationTypeId": 0,
"entityRelationshipId": 0,
"jobDescription": "string",
"genderId": 0,
"entityTypeId": 0,
"accountingNumber": "string",
"obs": "string",
"birthDate": "string",
"disabilityId": 0,
"maritalId": 0
},

Parâmetros Descrição
IdUUID (opcional)
Código único do comprador junto a HubMoney. No primeiro cadastro do cartão do comprador para compras com um clique ou recorrência, retornaremos um uiUUID junto com o CardUUID. Quando o comprador cadastrar um novo cartão, basta nos enviar os dados do cartão junto com o IdUUID.
String
Name (opcional)
Nome completo do comprador quando for PF (Pessoa Física);
Razão social da empresa quando for PF (Pessoa Jurídica)
String
NamePrefix (opcional)
Campo para texto livre.
Forma de tratamento da pessoa física, tais como: Sr. Sra. Doutor, Doutora e outras formas de tratamento.
Nome Fantasia da Empresa quando for pessoa jurídica.
String
PhoneCelular (opcional)
Número do telefone celular.
String
PhoneHome (opcional)
Número do telefone residencial.
String
PhoneOther (opcional)
Número de telefone adicional.
String
PhoneJob (opcional)
Número do telefone do trabalho.
String
PhoneExtension (opcional)
Número do Ramal.
String
Fax (opcional)
Número do Fax.
String
Email (opcional)
E-mail do comprador.
String
ErpUniqueID (opcional)
Código único no sistema da aplicação que está utilizando a API.
String
VatNumber (opcional)
Número do CPF
String
IdentificationNumber (opcional)
Número de um documento definido por que utiliza a API, por exemplo RG.
String
IdentificationIssuer (opcional)
Orgão emissor do documento fornecido no IdentificationNumber, por exemplo RG.
String
IdentificationTypeID (opcional)
Tipo de documento fornecido no IdentificationNumber, por exemplo RG, CPF, Passaporte e etc.
String
JobDescription (opcional)
Profissão do Comprador.
String
GenderID (opcional)
Genero [M] Masculino e [F] Feminino.
String
EntityTypeID (opcional)
Tipo de Pessoa Física [CPF] e Pessoa Jurídica [CNPJ].
String
AccountingNumber (opcional)
Conta Contábil utilizada pelo financeiro se existir.
String
Obs (opcional)
Texto livre associado ao comprador.
String
BirthDate (opcional)
Data de Nascimento do Comprador.
String
DisabilityID (opcional)
Definir se o comprador possui alguma deficiência.
String
MaritalID (opcional)
Definir o estado civil do comprador.
String

ENDEREÇO DE ENTREGA / MAINADDRESS

URL REQUEST:
https://gateway.prod.HubMoney.co/api/acquire/card/authorize

JSON REQUEST - CONTINUATION:

},
"mainAddress": {
"street": "string",
"portNumber": "string",
"portLetter": "string",
"complement": "string",
"city": "string",
"state": "string",
”zipCode": "string",
"country": "string"
}

Parâmetros Descrição
Street (opcional)
Endereço de entrega do pedido.
String
PortNumber (opcional)
Número da residência/apartamento.
String
PortLetter (opcional)
Número do Apartamento se houver.
String
Complement (opcional)
Complemento do endereço.
String
City (opcional)
Cidade em que deverá entregue o pedido.
String
State (opcional)
Estado em que deverá entregue o pedido.
String
ZipCode (opcional)
CEP do endereço em que o pedido será entregue.
String
Country (opcional)
País do endereço em que o pedido será entregue.
String

ENDEREÇO DE ENTREGA / BILLINGADDRESS

URL REQUEST:
https://gateway.prod.HubMoney.co/api/acquire/card/authorize

JSON REQUEST - CONTINUATION:

},
"billingAddress": {
"street": "string",
"portNumber": "string",
"portLetter": "string",
"complement": "string",
"city": "string",
"state": "string",
”zipCode": "string",
"country": "string"
}

Parâmetros Descrição
Street (opcional)
Endereço de entrega do pedido.
String
PortNumber (opcional)
Número da residência/apartamento.
String
PortLetter (opcional)
Número do Apartamento se houver.
String
Complement (opcional)
Complemento do endereço.
String
City (opcional)
Cidade em que deverá entregue o pedido.
String
State (opcional)
Estado em que deverá entregue o pedido.
String
ZipCode (opcional)
CEP do endereço em que o pedido será entregue.
String
Country (opcional)
País do endereço em que o pedido será entregue.
String

DADOS BANCÁRIOS / BANKACCOUNTS

URL REQUEST:
https://gateway.prod.HubMoney.co/api/acquire/card/authorize

JSON REQUEST - CONTINUATION:

{
"bankAccounts": [
{
"branchNumber": "string",
"branchDigit": "string",
"accountNumber": "string",
"accountNumberDigit": "string",
"bankErpId": "string",
"accountType": 0
}
]
}

Parâmetros Descrição
BranchNumber (opcional)
Número da Agência.
String
BranchDigit (opcional)
Dígito da agência.
String
AccountNumber (opcional)
Número da Conta Corrente.
String
AccountNumberDigit (opcional)
Dígito da Conta Corrente.
String
BankErpID (opcional)
Código do Banco.
String
AccountType (opcional)
Tipo de Conta.
Integer

RECORRÊNCIA / RECURRENCE

URL REQUEST:
https://gateway.prod.HubMoney.co/api/acquire/card/authorize

JSON REQUEST - CONTINUATION:

},
"recurrence": {
"startDate": "string",
"endDate": "string",
"interval": 0,
"applyDay": 0,
"applyImediatly": true
}

Parâmetros Descrição
StartDate (opcional)
Início da Recorrência.
String
EndDate (opcional)
Fim da recorrência.
String
Interval (opcional)
Definir se a recorrência será semanal, mensal, quinzenal, trimestral, semestral ou anual.
Integer
ApplyDay (opcional)
Dia da semana específico em que a cobrança deverá ocorrer no cartão do comprador (Segunda, Terça, Quarta, Quinta, Sexta, Sábado e Domingo).
Integer
ApplyMediatly (opcional)
[True] quando a cobrança deve ser efetuada imediatamente e [False] quando não deve ser de imediato.
Boolean

3D Secure / ThreeDS

URL REQUEST:
https://gateway.prod.HubMoney.co/api/acquire/card/authorize

JSON REQUEST - CONTINUATION:

},
"threeDS": {
"mode": "string",
}
}

Parâmetros Descrição
Mode (opcional)
Para usar 3DS (3D Secure), basta utilizar o código [1] nesse campo. Se não quiser utilizar, não enviar nenhuma informação.
String

RESPOSTA / HTTP RESPONSE CODES

Response Codes Descrição
200 Pedido processado com sucesso. Verifique os códigos de retorno.
201 Pedido criado com sucesso, mas ainda não foi processado. Enviar uma solicitação utilizando {PaymentInfo}.
400 O Formato do pedido está incorreto, Verifique os Parâmetros.
401 Autenticação inválida. Por favor, verifique o código de retorno.
500 Erro geral. Por favor, entre em contato com o suporte HubMoney no suporte@HubMoney.co

Quando retornar 200, o JSON deverá retornar os seguinte JSON contemplando as informações de acordo com o pedido solicitado.

RESPOSTA – 200 / RESPONSE CLASS (200)

JSON RESPONSE CODES:

{
"responseCode": "string",
"responseMessage": "string",
"paymentToken": "string",
"status": 0,
"transactionType": 0,
"cardDisplayNumber": "string",
"cardDisplayNumber": "string",
"cardScheme": "string",
"cardBrand": "string",
"amount": 0,
"merchantOrderId": "string",
"captures": [
{
"amount": 0,
"status_code": "string",
"proofOfSale": "string",
"authorizationCode": "string",
"nsu": "string",
"scheduledDate": "string",
"executionDate": "string"
}
],
"reversals": [
{
"amount": 0,
"status_code": "string",
"proofOfSale": "string",
"authorizationCode": "string",
"nsu": "string",
"scheduledDate": "string",
"executionDate": "string",
"reason": "string"
}
],
"threeDS": {
"mode": "string",
"authenticationURL": "string",
"cardScheme": "string",
"enrolled": "string",
"status": "string",
"threeDSTransactionNumber": "string",
"cardHolderAuthVerificationValue": "string",
"cavvalgorithm": "string",
"ecomerceIndicator": "string"
}
}

Response Descrição
ResponseCode (opcional)
Código de resposta do pedido.
String
ResponseMessage (opcional)
Descritivo associado ao código da resposta.
String
PaymentToken (opcional)
Token retornado pela HubMoney na resposta à API de criação do pedido.
String
Status (opcional)
QUEUED(0), PROCESSED_SUCCESS(1), RETRY_MODE(2), PROCESSED_ERROR(3), TIMED_OUT(4), FATAL(5), PROCESSED IN 3DS (7), PROCESSED ON ACQUIRE AND WAINTING(100), PROCESSED SUCCESS IN RECORRENCE MODE(101).
Integer
TransactionType (opcional)
Se Crédito [1], se Débito [2].
Integer
CardDisplayNumber (opcional)
Código de resposta do pedido.
String
CardSheme (opcional)
Código da adquirente/processadora que efetuou o processamento do pedido.
String
CardBrand (opcional)
Código da bandeira do cartão utilizada no pedido.
String
Amount (opcional)
Valor da Transação.
Integer
MerchantOrderId (opcional)
Código utilizado pelo Lojista na realização da compra.
String
Response Captures Descrição
Amount (opcional)
Valor da Transação.
Integer
StatusCode (obrigatório)
AUTHORISED(0),
PAYMENT_PROCESSED(1),
AUTHORISED_TO_VALIDATE(2),
WAITING_AUTHORISATION(4),
WAITING_AUTHORISATION_TO_VALIDATE(6),
NOT_CREATED(8),
REFUSED(9).
String
ProofOfSale (opcional)
Código de validação da compra enviado pela processadora.
String
AuthorizationCode (opcional)
Código de autorização da processadora.
String
NSU (opcional)
Número sequencial único da transação.
Integer
ScheduleDate (opcional)
Data em que o pagamento foi programado para executar.
String
ExecutiveDate (opcional)
Data em que o pagamento foi executado.
String
Response Reversals Descrição
Amount (opcional)
Valor da Transação.
Integer
StatusCode (obrigatório)
AUTHORISED(0),
PAYMENT_PROCESSED(1),
AUTHORISED_TO_VALIDATE(2),
WAITING_AUTHORISATION(4),
WAITING_AUTHORISATION_TO_VALIDATE(6),
NOT_CREATED(8),
REFUSED(9).
String
ProofOfSale (opcional)
Código de validação da compra enviado pela processadora.
String
AuthorizationCode (opcional)
Código de autorização da processadora.
String
NSU (opcional)
Número sequencial único da transação.
Integer
ScheduleDate (opcional)
Data em que o pagamento foi programado para executar.
String
ExecutiveDate (opcional)
Data em que o pagamento foi executado.
String
Reason (opcional)
Motivo do pedido de estorno da transação.
String
Response ThreeDS Descrição
Mode (opcional)
Será alimentado pela HubMoney quando a função 3DS for utilizada.
Integer
AuthenticationURL (obrigatório)
URL retornada pelo HubMoney.
String
Enrolled (opcional)
Campo alimentado pelo HubMoney no retorno da transação quando #DS for utilizada. Depende também da processadora que efetivou a transação.
String
Status (opcional)
Campo alimentado pelo HubMoney no retorno da transação quando #DS for utilizada. Depende também da processadora que efetivou a transação.
String
ThreeDSTransactionNumber (opcional)
Campo alimentado pelo HubMoney no retorno da transação quando #DS for utilizada. Depende também da processadora que efetivou a transação.
String
CardHolderAuthVerificationValue (opcional)
Campo alimentado pelo HubMoney no retorno da transação quando #DS for utilizada. Depende também da processadora que efetivou a transação.
String
CavvAlgotithm (opcional)
Campo alimentado pelo HubMoney no retorno da transação quando #DS for utilizada. Depende também da processadora que efetivou a transação.
String
EcomerceIndicator (opcional)
Campo alimentado pelo HubMoney no retorno da transação quando #DS for utilizada. Depende também da processadora que efetivou a transação.
String

Capturar / Capture

SOLICITAR CAPTURA / CAPTURE

Essa API é utilizada para efetivação do pagamento em dois passos. Quando na API de criação do Pedido o campo ”Capture” contemplar FALSE, significa que o pedido foi Pré-Autorizado (Reserva do Valor). Dessa forma, haverá necessidade de consumir a API de Captura para efetivar o pagamento.

No corpo da requisição JSON você poderá enviar um pedido utilizando o método PUT.

URL REQUEST:
https://gateway.prod.HubMoney.co/api/acquire/card/capture

JSON REQUEST:

{
"paymentToken": "string",
"amount": 0,
"captureDate": "string”
}

Parâmetros Descrição
PaymentToken (obrigatório)
Token retornado pela HubMoney na resposta à API de criação do pedido.
String
Amount (opcional)
Valor da transação enviada na API de criação do pedido.
Integer
CaptureDate (obrigatório)
Campo para inclusão da data em que o pedido deve ser confirmado. Essa data pode ser posterior da data de pedido. Caso o cartão não esteja válido na data agendada, a transação não será efetiva.
Integer

RESPOSTA / HTTP RESPONSE CODES

Response Codes Descrição
200 Pedido processado com sucesso. Verifique os códigos de retorno.
201 Pedido criado com sucesso, mas ainda não foi processado. Enviar uma solicitação utilizando {PaymentInfo}.
400 O Formato do pedido está incorreto, Verifique os Parâmetros.
401 Autenticação inválida. Por favor, verifique o código de retorno.
500 Erro geral. Por favor, entre em contato com o suporte HubMoney no suporte@HubMoney.co

Quando retornar 200, o JSON deverá retornar os seguinte JSON contemplando as informações de acordo com o pedido solicitado.

RESPOSTA – 200 / RESPONSE CLASS (200)

JSON RESPONSE CODES:

{
"responseCode": "string",
"responseMessage": "string",
"paymentToken": "string",
"status": 0,
"transactionType": 0,
"cardDisplayNumber": "string",
"cardDisplayNumber": "string",
"cardScheme": "string",
"cardBrand": "string",
"amount": 0,
"merchantOrderId": "string",
"captures": [
{
"amount": 0,
"status_code": "string",
"proofOfSale": "string",
"authorizationCode": "string",
"nsu": "string",
"scheduledDate": "string",
"executionDate": "string"
}
],
"reversals": [
{
"amount": 0,
"status_code": "string",
"proofOfSale": "string",
"authorizationCode": "string",
"nsu": "string",
"scheduledDate": "string",
"executionDate": "string",
"reason": "string"
}
],
"threeDS": {
"mode": "string",
"authenticationURL": "string",
"cardScheme": "string",
"enrolled": "string",
"status": "string",
"threeDSTransactionNumber": "string",
"cardHolderAuthVerificationValue": "string",
"cavvalgorithm": "string",
"ecomerceIndicator": "string"
}
}

Response Descrição
ResponseCode (opcional)
Código de resposta do pedido.
String
ResponseMessage (opcional)
Descritivo associado ao código da resposta.
String
PaymentToken (opcional)
Token retornado pela HubMoney na resposta à API de criação do pedido.
String
Status (opcional)
QUEUED(0), PROCESSED_SUCCESS(1), RETRY_MODE(2), PROCESSED_ERROR(3), TIMED_OUT(4), FATAL(5), PROCESSED IN 3DS (7), PROCESSED ON ACQUIRE AND WAINTING(100), PROCESSED SUCCESS IN RECORRENCE MODE(101).
Integer
TransactionType (opcional)
Se Crédito [1], se Débito [2].
Integer
CardDisplayNumber (opcional)
Código de resposta do pedido.
String
CardSheme (opcional)
Código da adquirente/processadora que efetuou o processamento do pedido.
String
CardBrand (opcional)
Código da bandeira do cartão utilizada no pedido.
String
Amount (opcional)
Valor da Transação.
Integer
MerchantOrderId (opcional)
Código utilizado pelo Lojista na realização da compra.
String
Response Captures Descrição
Amount (opcional)
Valor da Transação.
Integer
StatusCode (obrigatório)
AUTHORISED(0),
PAYMENT_PROCESSED(1),
AUTHORISED_TO_VALIDATE(2),
WAITING_AUTHORISATION(4),
WAITING_AUTHORISATION_TO_VALIDATE(6),
NOT_CREATED(8),
REFUSED(9).
String
ProofOfSale (opcional)
Código de validação da compra enviado pela processadora.
String
AuthorizationCode (opcional)
Código de autorização da processadora.
String
NSU (opcional)
Número sequencial único da transação.
Integer
ScheduleDate (opcional)
Data em que o pagamento foi programado para executar.
String
ExecutiveDate (opcional)
Data em que o pagamento foi executado.
String
Response Reversals Descrição
Amount (opcional)
Valor da Transação.
Integer
StatusCode (obrigatório)
AUTHORISED(0),
PAYMENT_PROCESSED(1),
AUTHORISED_TO_VALIDATE(2),
WAITING_AUTHORISATION(4),
WAITING_AUTHORISATION_TO_VALIDATE(6),
NOT_CREATED(8),
REFUSED(9).
String
ProofOfSale (opcional)
Código de validação da compra enviado pela processadora.
String
AuthorizationCode (opcional)
Código de autorização da processadora.
String
NSU (opcional)
Número sequencial único da transação.
Integer
ScheduleDate (opcional)
Data em que o pagamento foi programado para executar.
String
ExecutiveDate (opcional)
Data em que o pagamento foi executado.
String
Reason (opcional)
Motivo do pedido de estorno da transação.
String
Response ThreeDS Descrição
Mode (opcional)
Será alimentado pela HubMoney quando a função 3DS for utilizada.
Integer
AuthenticationURL (obrigatório)
URL retornada pelo HubMoney.
String
Enrolled (opcional)
Campo alimentado pelo HubMoney no retorno da transação quando #DS for utilizada. Depende também da processadora que efetivou a transação.
String
Status (opcional)
Campo alimentado pelo HubMoney no retorno da transação quando #DS for utilizada. Depende também da processadora que efetivou a transação.
String
ThreeDSTransactionNumber (opcional)
Campo alimentado pelo HubMoney no retorno da transação quando #DS for utilizada. Depende também da processadora que efetivou a transação.
String
CardHolderAuthVerificationValue (opcional)
Campo alimentado pelo HubMoney no retorno da transação quando #DS for utilizada. Depende também da processadora que efetivou a transação.
String
CavvAlgotithm (opcional)
Campo alimentado pelo HubMoney no retorno da transação quando #DS for utilizada. Depende também da processadora que efetivou a transação.
String
EcomerceIndicator (opcional)
Campo alimentado pelo HubMoney no retorno da transação quando #DS for utilizada. Depende também da processadora que efetivou a transação.
String

Estornar / Reverse

SOLICITAR ESTORNO / REVERSE

Essa API é utilizada para estornar uma transação já autorizada ou uma transação pré-autorizada.

No corpo da requisição JSON você poderá enviar um pedido utilizando o método PUT.

URL REQUEST:
https://gateway.prod.HubMoney.co/api/acquire/card/reverse

JSON REQUEST:

{
"paymentToken": "string",
"amount": 0
}

Parâmetros Descrição
PaymentToken (obrigatório)
Token retornado pela HubMoney na resposta à API de criação do pedido.
String
Amount (opcional)
Valor da transação enviada na API de criação do pedido.
Integer

RESPOSTA / HTTP RESPONSE CODES

Response Codes Descrição
200 Pedido processado com sucesso. Verifique os códigos de retorno.
201 Pedido criado com sucesso, mas ainda não foi processado. Enviar uma solicitação utilizando {PaymentInfo}.
400 O Formato do pedido está incorreto, Verifique os Parâmetros.
401 Autenticação inválida. Por favor, verifique o código de retorno.
500 Erro geral. Por favor, entre em contato com o suporte HubMoney no suporte@HubMoney.co

Quando retornar 200, o JSON deverá retornar os seguinte JSON contemplando as informações de acordo com o pedido solicitado.

RESPOSTA – 200 / RESPONSE CLASS (200)

JSON RESPONSE CODES:

{
"responseCode": "string",
"responseMessage": "string",
"paymentToken": "string",
"status": 0,
"transactionType": 0,
"cardDisplayNumber": "string",
"cardDisplayNumber": "string",
"cardScheme": "string",
"cardBrand": "string",
"amount": 0,
"merchantOrderId": "string",
"captures": [
{
"amount": 0,
"status_code": "string",
"proofOfSale": "string",
"authorizationCode": "string",
"nsu": "string",
"scheduledDate": "string",
"executionDate": "string"
}
],
"reversals": [
{
"amount": 0,
"status_code": "string",
"proofOfSale": "string",
"authorizationCode": "string",
"nsu": "string",
"scheduledDate": "string",
"executionDate": "string",
"reason": "string"
}
],
"threeDS": {
"mode": "string",
"authenticationURL": "string",
"cardScheme": "string",
"enrolled": "string",
"status": "string",
"threeDSTransactionNumber": "string",
"cardHolderAuthVerificationValue": "string",
"cavvalgorithm": "string",
"ecomerceIndicator": "string"
}
}

Response Descrição
ResponseCode (opcional)
Código de resposta do pedido.
String
ResponseMessage (opcional)
Descritivo associado ao código da resposta.
String
PaymentToken (opcional)
Token retornado pela HubMoney na resposta à API de criação do pedido.
String
Status (opcional)
QUEUED(0), PROCESSED_SUCCESS(1), RETRY_MODE(2), PROCESSED_ERROR(3), TIMED_OUT(4), FATAL(5), PROCESSED IN 3DS (7), PROCESSED ON ACQUIRE AND WAINTING(100), PROCESSED SUCCESS IN RECORRENCE MODE(101).
Integer
TransactionType (opcional)
Se Crédito [1], se Débito [2].
Integer
CardDisplayNumber (opcional)
Código de resposta do pedido.
String
CardSheme (opcional)
Código da adquirente/processadora que efetuou o processamento do pedido.
String
CardBrand (opcional)
Código da bandeira do cartão utilizada no pedido.
String
Amount (opcional)
Valor da Transação.
Integer
MerchantOrderId (opcional)
Código utilizado pelo Lojista na realização da compra.
String
Response Captures Descrição
Amount (opcional)
Valor da Transação.
Integer
StatusCode (obrigatório)
AUTHORISED(0),
PAYMENT_PROCESSED(1),
AUTHORISED_TO_VALIDATE(2),
WAITING_AUTHORISATION(4),
WAITING_AUTHORISATION_TO_VALIDATE(6),
NOT_CREATED(8),
REFUSED(9).
String
ProofOfSale (opcional)
Código de validação da compra enviado pela processadora.
String
AuthorizationCode (opcional)
Código de autorização da processadora.
String
NSU (opcional)
Número sequencial único da transação.
Integer
ScheduleDate (opcional)
Data em que o pagamento foi programado para executar.
String
ExecutiveDate (opcional)
Data em que o pagamento foi executado.
String
Response Reversals Descrição
Amount (opcional)
Valor da Transação.
Integer
StatusCode (obrigatório)
AUTHORISED(0),
PAYMENT_PROCESSED(1),
AUTHORISED_TO_VALIDATE(2),
WAITING_AUTHORISATION(4),
WAITING_AUTHORISATION_TO_VALIDATE(6),
NOT_CREATED(8),
REFUSED(9).
String
ProofOfSale (opcional)
Código de validação da compra enviado pela processadora.
String
AuthorizationCode (opcional)
Código de autorização da processadora.
String
NSU (opcional)
Número sequencial único da transação.
Integer
ScheduleDate (opcional)
Data em que o pagamento foi programado para executar.
String
ExecutiveDate (opcional)
Data em que o pagamento foi executado.
String
Reason (opcional)
Motivo do pedido de estorno da transação.
String
Response ThreeDS Descrição
Mode (opcional)
Será alimentado pela HubMoney quando a função 3DS for utilizada.
Integer
AuthenticationURL (obrigatório)
URL retornada pelo HubMoney.
String
Enrolled (opcional)
Campo alimentado pelo HubMoney no retorno da transação quando #DS for utilizada. Depende também da processadora que efetivou a transação.
String
Status (opcional)
Campo alimentado pelo HubMoney no retorno da transação quando #DS for utilizada. Depende também da processadora que efetivou a transação.
String
ThreeDSTransactionNumber (opcional)
Campo alimentado pelo HubMoney no retorno da transação quando #DS for utilizada. Depende também da processadora que efetivou a transação.
String
CardHolderAuthVerificationValue (opcional)
Campo alimentado pelo HubMoney no retorno da transação quando #DS for utilizada. Depende também da processadora que efetivou a transação.
String
CavvAlgotithm (opcional)
Campo alimentado pelo HubMoney no retorno da transação quando #DS for utilizada. Depende também da processadora que efetivou a transação.
String
EcomerceIndicator (opcional)
Campo alimentado pelo HubMoney no retorno da transação quando #DS for utilizada. Depende também da processadora que efetivou a transação.
String

Consultar Pedido / Payment Info

CONSULTAR PEDIDO / PAYMENT INFO

Basta enviar na PATH o parâmetro PaymentToken.

Parâmetros Descrição
PaymentToken (obrigatório)
Token retornado pela HubMoney na resposta à API de criação do pedido.
String

RESPOSTA / HTTP RESPONSE CODES

Response Codes Descrição
200 Pedido processado com sucesso. Verifique os códigos de retorno.
201 Pedido criado com sucesso, mas ainda não foi processado. Enviar uma solicitação utilizando {PaymentInfo}.
400 O Formato do pedido está incorreto, Verifique os Parâmetros.
401 Autenticação inválida. Por favor, verifique o código de retorno.
500 Erro geral. Por favor, entre em contato com o suporte HubMoney no suporte@HubMoney.co

Quando retornar 200, o JSON deverá retornar os seguinte JSON contemplando as informações de acordo com o pedido solicitado.

RESPOSTA – 200 / RESPONSE CLASS (200)

JSON RESPONSE CODES:

{
"responseCode": "string",
"responseMessage": "string",
"paymentToken": "string",
"status": 0,
"transactionType": 0,
"cardDisplayNumber": "string",
"cardDisplayNumber": "string",
"cardScheme": "string",
"cardBrand": "string",
"amount": 0,
"merchantOrderId": "string",
"captures": [
{
"amount": 0,
"status_code": "string",
"proofOfSale": "string",
"authorizationCode": "string",
"nsu": "string",
"scheduledDate": "string",
"executionDate": "string"
}
],
"reversals": [
{
"amount": 0,
"status_code": "string",
"proofOfSale": "string",
"authorizationCode": "string",
"nsu": "string",
"scheduledDate": "string",
"executionDate": "string",
"reason": "string"
}
],
"threeDS": {
"mode": "string",
"authenticationURL": "string",
"cardScheme": "string",
"enrolled": "string",
"status": "string",
"threeDSTransactionNumber": "string",
"cardHolderAuthVerificationValue": "string",
"cavvalgorithm": "string",
"ecomerceIndicator": "string"
}
}

Response Descrição
ResponseCode (opcional)
Código de resposta do pedido.
String
ResponseMessage (opcional)
Descritivo associado ao código da resposta.
String
PaymentToken (opcional)
Token retornado pela HubMoney na resposta à API de criação do pedido.
String
Status (opcional)
QUEUED(0), PROCESSED_SUCCESS(1), RETRY_MODE(2), PROCESSED_ERROR(3), TIMED_OUT(4), FATAL(5), PROCESSED IN 3DS (7), PROCESSED ON ACQUIRE AND WAINTING(100), PROCESSED SUCCESS IN RECORRENCE MODE(101).
Integer
TransactionType (opcional)
Se Crédito [1], se Débito [2].
Integer
CardDisplayNumber (opcional)
Código de resposta do pedido.
String
CardSheme (opcional)
Código da adquirente/processadora que efetuou o processamento do pedido.
String
CardBrand (opcional)
Código da bandeira do cartão utilizada no pedido.
String
Amount (opcional)
Valor da Transação.
Integer
MerchantOrderId (opcional)
Código utilizado pelo Lojista na realização da compra.
String
Response Captures Descrição
Amount (opcional)
Valor da Transação.
Integer
StatusCode (obrigatório)
AUTHORISED(0),
PAYMENT_PROCESSED(1),
AUTHORISED_TO_VALIDATE(2),
WAITING_AUTHORISATION(4),
WAITING_AUTHORISATION_TO_VALIDATE(6),
NOT_CREATED(8),
REFUSED(9).
String
ProofOfSale (opcional)
Código de validação da compra enviado pela processadora.
String
AuthorizationCode (opcional)
Código de autorização da processadora.
String
NSU (opcional)
Número sequencial único da transação.
Integer
ScheduleDate (opcional)
Data em que o pagamento foi programado para executar.
String
ExecutiveDate (opcional)
Data em que o pagamento foi executado.
String
Response Reversals Descrição
Amount (opcional)
Valor da Transação.
Integer
StatusCode (obrigatório)
AUTHORISED(0),
PAYMENT_PROCESSED(1),
AUTHORISED_TO_VALIDATE(2),
WAITING_AUTHORISATION(4),
WAITING_AUTHORISATION_TO_VALIDATE(6),
NOT_CREATED(8),
REFUSED(9).
String
ProofOfSale (opcional)
Código de validação da compra enviado pela processadora.
String
AuthorizationCode (opcional)
Código de autorização da processadora.
String
NSU (opcional)
Número sequencial único da transação.
Integer
ScheduleDate (opcional)
Data em que o pagamento foi programado para executar.
String
ExecutiveDate (opcional)
Data em que o pagamento foi executado.
String
Reason (opcional)
Motivo do pedido de estorno da transação.
String
Response ThreeDS Descrição
Mode (opcional)
Será alimentado pela HubMoney quando a função 3DS for utilizada.
Integer
AuthenticationURL (obrigatório)
URL retornada pelo HubMoney.
String
Enrolled (opcional)
Campo alimentado pelo HubMoney no retorno da transação quando #DS for utilizada. Depende também da processadora que efetivou a transação.
String
Status (opcional)
Campo alimentado pelo HubMoney no retorno da transação quando #DS for utilizada. Depende também da processadora que efetivou a transação.
String
ThreeDSTransactionNumber (opcional)
Campo alimentado pelo HubMoney no retorno da transação quando #DS for utilizada. Depende também da processadora que efetivou a transação.
String
CardHolderAuthVerificationValue (opcional)
Campo alimentado pelo HubMoney no retorno da transação quando #DS for utilizada. Depende também da processadora que efetivou a transação.
String
CavvAlgotithm (opcional)
Campo alimentado pelo HubMoney no retorno da transação quando #DS for utilizada. Depende também da processadora que efetivou a transação.
String
EcomerceIndicator (opcional)
Campo alimentado pelo HubMoney no retorno da transação quando #DS for utilizada. Depende também da processadora que efetivou a transação.
String

API Gestão De Cartões

Essa API será utilizada para cadastrar os dados do cartão e os dados do comprador, seja ele uma entidade pessoa física (CPF) ou pessoa jurídica (CNPJ).

Para adicionar um cartão há um comprador pela primeira vez, todos os dados são necessários. Quando o comprador existir e houver a necessidade de cadastro de um novo cartão associado ao comprador, basta enviar na API o IdUUID existe junto com os dados do cartão.

Será necessário realizar a Autenticação e obter o Requester-Token para uso desse serviço.

HEADER

Parâmetros - Header Descrição
requester-id (obrigatório)
Usuário criado pela plataforma HubMoney e fornecido por e-mail após cadastramento no HubMoney.
String
requester-token (obrigatório)
Token obtido na chamada da API de Autenticação.
String
unique-trx-id (obrigatório)
Identificador único da transação (Enviado pela aplicação que está utilizando a API).
Long

No corpo da requisição JSON você poderá enviar um pedido utilizando o método POST. Esse pedido raiz contempla informações que estão contempladas nos seguintes objetos: Dados do Cartão, Titular do Cartão, Endereço de Entrega, Endereço de Cobrança e Dados Bancários.

Criar Pedido

A raiz do objeto contempla os dados básicos do pedido

URL REQUEST:
https://gateway.prod.HubMoney.co/api/acquire/cardManager/add

JSON REQUEST:

{
"cardTypeUUID": "string",
"cardERPUniqueID": "string",
"card":
{
"cardUUID": "string",
"pan": "string",
"cardScheme": "string",
"cardBrand": "string",
"securityCode": "string",
"expirationMonth": 0,
"expirationYear": 0,
"name": "string"
}

Parâmetros Descrição
RequesterId (obrigatório)
Usuário criado pela plataforma HubMoney e fornecido por e-mail após cadastramento no HubMoney.
String
CardTypeUUID

CardERPUniqueID

CardUUID (opcional)
Token que deve ser utilizado em substituição aos dados do cartão para uma autorização direta ou uma transação recorrente. Quando este campo estiver preenchido, nenhum dado do cartão deve ser preenchido.
String
Pan (opcional)
Número do cartão de débito ou crédito.
String
CardScheme (opcional)
Código da adquirente/processadora que efetuou o processamento do pedido.
String
CardBrand (opcional)
Código da bandeira do cartão utilizada no pedido.
String
SecurityCode (opcional)
Código de Segurança do Cartão.
String
ExpirationMonth (opcional)
Mês de validade do cartão.
Integer
ExpirationYear (opcional)
Ano de validade do Cartão.
Integer
Name (opcional)
Nome do portador impresso no cartão.
String

TITULAR DO CARTÃO / CARDHOLDER

Este objeto deve ser usado para enviar informações sobre o cartão que está sendo utilizado na compra, que na maioria dos casos é aquele que está logado na loja Web.

URL REQUEST:
https://gateway.prod.HubMoney.co/api/acquire/cardManager/add

JSON REQUEST - CONTINUATION:

"cardHolder": {
"entity": {
"idUUID": "string",
"name": "string",
"namePrefix": "string",
"phoneCelular": "string",
"phoneHome": "string",
"phoneOther": "string",
"phoneJob": "string",
"phoneExtension": "string",
"fax": "string",
"email": "string",
"erpUniqueId": "string",
"vatNumber": "string",
"identificationNumber": "string",
"identificationIssuer": "string",
"identificationTypeId": 0,
"entityRelationshipId": 0,
"jobDescription": "string",
"genderId": 0,
"entityTypeId": 0,
"accountingNumber": "string",
"obs": "string",
"birthDate": "string",
"disabilityId": 0,
"maritalId": 0
},

Parâmetros Descrição
IdUUID (opcional)
Código único do comprador junto a HubMoney. No primeiro cadastro do cartão do comprador para compras com um clique ou recorrência, retornaremos um uiUUID junto com o CardUUID. Quando o comprador cadastrar um novo cartão, basta nos enviar os dados do cartão junto com o IdUUID.
String
Name (opcional)
Nome completo do comprador quando for PF (Pessoa Física);
Razão social da empresa quando for PF (Pessoa Jurídica)
String
NamePrefix (opcional)
Campo para texto livre.
Forma de tratamento da pessoa física, tais como: Sr. Sra. Doutor, Doutora e outras formas de tratamento.
Nome Fantasia da Empresa quando for pessoa jurídica.
String
PhoneCelular (opcional)
Número do telefone celular.
String
PhoneHome (opcional)
Número do telefone residencial.
String
PhoneOther (opcional)
Número de telefone adicional.
String
PhoneJob (opcional)
Número do telefone do trabalho.
String
PhoneExtension (opcional)
Número do Ramal.
String
Fax (opcional)
Número do Fax.
String
Email (opcional)
E-mail do comprador.
String
ErpUniqueID (opcional)
Código único no sistema da aplicação que está utilizando a API.
String
VatNumber (opcional)
Número do CPF
String
IdentificationNumber (opcional)
Número de um documento definido por que utiliza a API, por exemplo RG.
String
IdentificationIssuer (opcional)
Orgão emissor do documento fornecido no IdentificationNumber, por exemplo RG.
String
IdentificationTypeID (opcional)
Tipo de documento fornecido no IdentificationNumber, por exemplo RG, CPF, Passaporte e etc.
String
JobDescription (opcional)
Profissão do Comprador.
String
GenderID (opcional)
Genero [M] Masculino e [F] Feminino.
String
EntityTypeID (opcional)
Tipo de Pessoa Física [CPF] e Pessoa Jurídica [CNPJ].
String
AccountingNumber (opcional)
Conta Contábil utilizada pelo financeiro se existir.
String
Obs (opcional)
Texto livre associado ao comprador.
String
BirthDate (opcional)
Data de Nascimento do Comprador.
String
DisabilityID (opcional)
Definir se o comprador possui alguma deficiência.
String
MaritalID (opcional)
Definir o estado civil do comprador.
String

ENDEREÇO DE ENTREGA / MAINADDRESS

URL REQUEST:
https://gateway.prod.HubMoney.co/api/acquire/cardManager/add

JSON REQUEST - CONTINUATION:

},
"mainAddress": {
"street": "string",
"portNumber": "string",
"portLetter": "string",
"complement": "string",
"city": "string",
"state": "string",
”zipCode": "string",
"country": "string"
}

Parâmetros Descrição
Street (opcional)
Endereço de entrega do pedido.
String
PortNumber (opcional)
Número da residência/apartamento.
String
PortLetter (opcional)
Número do Apartamento se houver.
String
Complement (opcional)
Complemento do endereço.
String
City (opcional)
Cidade em que deverá entregue o pedido.
String
State (opcional)
Estado em que deverá entregue o pedido.
String
ZipCode (opcional)
CEP do endereço em que o pedido será entregue.
String
Country (opcional)
País do endereço em que o pedido será entregue.
String

ENDEREÇO DE ENTREGA / BILLINGADDRESS

URL REQUEST:
https://gateway.prod.HubMoney.co/api/acquire/card/authorize

JSON REQUEST - CONTINUATION:

},
"billingAddress": {
"street": "string",
"portNumber": "string",
"portLetter": "string",
"complement": "string",
"city": "string",
"state": "string",
”zipCode": "string",
"country": "string"
}

Parâmetros Descrição
Street (opcional)
Endereço de entrega do pedido.
String
PortNumber (opcional)
Número da residência/apartamento.
String
PortLetter (opcional)
Número do Apartamento se houver.
String
Complement (opcional)
Complemento do endereço.
String
City (opcional)
Cidade em que deverá entregue o pedido.
String
State (opcional)
Estado em que deverá entregue o pedido.
String
ZipCode (opcional)
CEP do endereço em que o pedido será entregue.
String
Country (opcional)
País do endereço em que o pedido será entregue.
String

DADOS BANCÁRIOS / BANKACCOUNTS

URL REQUEST:
https://gateway.prod.HubMoney.co/api/acquire/cardManager/add

JSON REQUEST - CONTINUATION:

{
"bankAccounts": [
{
"branchNumber": "string",
"branchDigit": "string",
"accountNumber": "string",
"accountNumberDigit": "string",
"bankErpId": "string",
"accountType": 0
}
]
}

Parâmetros Descrição
BranchNumber (opcional)
Número da Agência.
String
BranchDigit (opcional)
Dígito da agência.
String
AccountNumber (opcional)
Número da Conta Corrente.
String
AccountNumberDigit (opcional)
Dígito da Conta Corrente.
String
BankErpID (opcional)
Código do Banco.
String
AccountType (opcional)
Tipo de Conta.
Integer

RESPOSTA / HTTP RESPONSE CODES

Response Codes Descrição
200 Pedido processado com sucesso. Verifique os códigos de retorno.
201 Pedido criado com sucesso, mas ainda não foi processado. Enviar uma solicitação utilizando {PaymentInfo}.
400 O Formato do pedido está incorreto, Verifique os Parâmetros.
401 Autenticação inválida. Por favor, verifique o código de retorno.
500 Erro geral. Por favor, entre em contato com o suporte HubMoney no suporte@HubMoney.co

Quando retornar 200, o JSON deverá retornar os seguinte JSON contemplando as informações de acordo com o pedido solicitado.

RESPOSTA – 200 / RESPONSE CLASS (200)

JSON RESPONSE CODES:

{
"responseCode": "string",
"responseMessage": "string",
"code": "string",
"description": "string",
"cardUUID": "string",
"cardStatus": 0,
"cardHolderUUID": "string",
"cardHolderStatus": 0
}

Response Descrição
ResponseCode (opcional)
Código de resposta do pedido.
String
ResponseMessage (opcional)
Descritivo associado ao código da resposta.
String
Code (opcional)
NNNNNNNNNNNNN
String
Description (opcional)
NNNNNNNNNNNNN
String
CardUUID (opcional)
Token que deve ser utilizado em substituição aos dados do cartão para uma autorização direta ou uma transação recorrente. Quando este campo estiver preenchido, nenhum dado do cartão deve ser preenchido.
String
CardStatus (opcional)
NNNNNNNNNNNNN
Integer
CardHolderUUID (opcional)
NNNNNNNNNNNNN
Integer
CardHolderStatus (opcional)
NNNNNNNNNNNNN
Integer

Consultar Cartão

CONSULTAR CARTÃO / CARDINFO

Basta enviar na PATH o parâmetro CardUUID.

URL REQUEST – COMANDO GET:
https://gateway.prod.HubMoney.co/api/acquire/cardManager/cardInfo/k

Parâmetros Descrição
CardUUID (opcional)
Token que deve ser utilizado em substituição aos dados do cartão para uma autorização direta ou uma transação recorrente. Quando este campo estiver preenchido, nenhum dado do cartão deve ser preenchido.
String

RESPOSTA / HTTP RESPONSE CODES

Response Codes Descrição
200 Pedido processado com sucesso. Verifique os códigos de retorno.
400 O Formato do pedido está incorreto, Verifique os Parâmetros.
401 Autenticação inválida. Por favor, verifique o código de retorno.
500 Erro geral. Por favor, entre em contato com o suporte HubMoney no suporte@HubMoney.co

Quando retornar 200, o JSON deverá retornar os seguinte JSON contemplando as informações de acordo com o pedido solicitado.

RESPOSTA – 200 / RESPONSE CLASS (200)

JSON RESPONSE CODES:

{
"responseCode": "string",
"responseMessage": "string",
"card": {
"cardUUID": "string",
"pan": "string",
"cardScheme": "string",
"cardBrand": "string",
"securityCode": "string",
"expirationMonth": 0,
"expirationYear": 0,
"name": "string"
}
}

Response Descrição
ResponseCode (opcional)
Código de resposta do pedido.
String
ResponseMessage (opcional)
Descritivo associado ao código da resposta.
String
CardUUID (opcional)
Token que deve ser utilizado em substituição aos dados do cartão para uma autorização direta ou uma transação recorrente. Quando este campo estiver preenchido, nenhum dado do cartão deve ser preenchido.
String
Pan (opcional)
Número do cartão de débito ou crédito mascarados.
String
CardScheme (opcional)
Código da adquirente/processadora que efetuou o processamento do pedido.
String
CardBrand (opcional)
Código da bandeira do cartão utilizada no pedido.
Integer
SecurityCode (opcional)
Código de Segurança do Cartão mascarado.
Integer
ExpirationMonth (opcional)
Mês de validade do cartão.
Integer
ExpirationYear (opcional)
Ano de validade do Cartão.
Integer
Name (opcional)
Nome do portador impresso no cartão.
String

Desativar Cartão

DESATIVAR CARTÃO / DEACTIVATE

Basta enviar na PATH o parâmetro CardUUID.

URL REQUEST – COMANDO PUT:
https://gateway.prod.HubMoney.co/api/acquire/cardManager/deactivate/ss

Parâmetros Descrição
CardUUID (opcional)
Token que deve ser utilizado em substituição aos dados do cartão para uma autorização direta ou uma transação recorrente. Quando este campo estiver preenchido, nenhum dado do cartão deve ser preenchido.
String

RESPOSTA / HTTP RESPONSE CODES

Response Codes Descrição
200 Pedido processado com sucesso. Verifique os códigos de retorno.
201 Pedido criado com sucesso, mas ainda não foi processado. Enviar uma solicitação utilizando {PaymentInfo}.
400 O Formato do pedido está incorreto, Verifique os Parâmetros.
401 Autenticação inválida. Por favor, verifique o código de retorno.
500 Erro geral. Por favor, entre em contato com o suporte HubMoney no suporte@HubMoney.co

Quando retornar 200, o JSON deverá retornar os seguinte JSON contemplando as informações de acordo com o pedido solicitado.

RESPOSTA – 200 / RESPONSE CLASS (200)

JSON RESPONSE CODES:

{
"responseCode": "string",
"responseMessage": "string",
}

Response Descrição
ResponseCode (opcional)
Código de resposta do pedido.
String
ResponseMessage (opcional)
Descritivo associado ao código da resposta.
String

Ativar Cartão

ATIVAR CARTÃO / ACTIVATE

Basta enviar na PATH o parâmetro CardUUID.

URL REQUEST – COMANDO PUT:
https://gateway.prod.HubMoney.co/api/acquire/cardManager/activate/T

Parâmetros Descrição
CardUUID (opcional)
Token que deve ser utilizado em substituição aos dados do cartão para uma autorização direta ou uma transação recorrente. Quando este campo estiver preenchido, nenhum dado do cartão deve ser preenchido.
String

RESPOSTA / HTTP RESPONSE CODES

Response Codes Descrição
200 Pedido processado com sucesso. Verifique os códigos de retorno.
201 Pedido criado com sucesso, mas ainda não foi processado. Enviar uma solicitação utilizando {PaymentInfo}.
400 O Formato do pedido está incorreto, Verifique os Parâmetros.
401 Autenticação inválida. Por favor, verifique o código de retorno.
500 Erro geral. Por favor, entre em contato com o suporte HubMoney no suporte@HubMoney.co

Quando retornar 200, o JSON deverá retornar os seguinte JSON contemplando as informações de acordo com o pedido solicitado.

RESPOSTA – 200 / RESPONSE CLASS (200)

JSON RESPONSE CODES:

{
"responseCode": "string",
"responseMessage": "string",
}

Response Descrição
ResponseCode (opcional)
Código de resposta do pedido.
String
ResponseMessage (opcional)
Descritivo associado ao código da resposta.
String

Remover Cartão

REMOVER CARTÃO / REMOVE

Basta enviar na PATH o parâmetro CardUUID.

URL REQUEST – COMANDO PUT:
https://gateway.prod.HubMoney.co/api/acquire/cardManager/remove/UU

Parâmetros Descrição
CardUUID (opcional)
Token que deve ser utilizado em substituição aos dados do cartão para uma autorização direta ou uma transação recorrente. Quando este campo estiver preenchido, nenhum dado do cartão deve ser preenchido.
String

RESPOSTA / HTTP RESPONSE CODES

Response Codes Descrição
200 Pedido processado com sucesso. Verifique os códigos de retorno.
201 Pedido criado com sucesso, mas ainda não foi processado. Enviar uma solicitação utilizando {PaymentInfo}.
400 O Formato do pedido está incorreto, Verifique os Parâmetros.
401 Autenticação inválida. Por favor, verifique o código de retorno.
500 Erro geral. Por favor, entre em contato com o suporte HubMoney no suporte@HubMoney.co

Quando retornar 200, o JSON deverá retornar os seguinte JSON contemplando as informações de acordo com o pedido solicitado.

RESPOSTA – 200 / RESPONSE CLASS (200)

JSON RESPONSE CODES:

{
"responseCode": "string",
"responseMessage": "string",
}

Response Descrição
ResponseCode (opcional)
Código de resposta do pedido.
String
ResponseMessage (opcional)
Descritivo associado ao código da resposta.
String

API Gestão De Lojistas

Essa API será utilizada para cadastrar os dados dos estabelecimentos comerciais que comercializam produtos ou prestam algum tipo de serviço. Qualificamos eles em nossa plataforma como LOJISTAS. Os dados dos Lojistas podem estar associados a uma entidade pessoa física (CPF) ou pessoa jurídica (CNPJ).

Considerando que o negócio seja um E-Commerce, M-Commerce ou Recorrência, os dados poderão ser cadastrados diretamente pela área comercial da HubMoney. No entanto, Caso seja necessário um conceito de Marketplace para Web ou Mobile, todos os LOJISTAS deverão ser cadastrados por meio da API, pois serão associados a serviços específicos contratados.

Será necessário realizar a Autenticação e obter o Requester-Token para uso desse serviço.

HEADER

Parâmetros - Header Descrição
requester-id (obrigatório)
Usuário criado pela plataforma HubMoney e fornecido por e-mail após cadastramento no HubMoney.
String
requester-token (obrigatório)
Token obtido na chamada da API de Autenticação.
String
unique-trx-id (obrigatório)
Identificador único da transação (Enviado pela aplicação que está utilizando a API).
Long

No corpo da requisição JSON você poderá enviar um pedido utilizando o método POST. Esse pedido raiz contempla informações que estão contempladas nos seguintes objetos: Dados do Cartão, Titular do Cartão, Endereço de Entrega, Endereço de Cobrança e Dados Bancários.

Criar Lojista

CRIAR PEDIDO / ORDER

A raiz do objeto contempla os dados básicos do pedido

URL REQUEST:
https://gateway.prod.HubMoney.co/api/acquire/merchant/add

JSON REQUEST - CONTINUATION:

"cardHolder": {
"entity": {
"idUUID": "string",
"name": "string",
"namePrefix": "string",
"phoneCelular": "string",
"phoneHome": "string",
"phoneOther": "string",
"phoneJob": "string",
"phoneExtension": "string",
"fax": "string",
"email": "string",
"erpUniqueId": "string",
"vatNumber": "string",
"identificationNumber": "string",
"identificationIssuer": "string",
"identificationTypeId": 0,
"entityRelationshipId": 0,
"jobDescription": "string",
"genderId": 0,
"entityTypeId": 0,
"accountingNumber": "string",
"obs": "string",
"birthDate": "string",
"disabilityId": 0,
"maritalId": 0
},

Parâmetros Descrição
Name (opcional)
Nome completo do comprador quando for PF (Pessoa Física);
Razão social da empresa quando for PF (Pessoa Jurídica)
String
NamePrefix (opcional)
Campo para texto livre.
Forma de tratamento da pessoa física, tais como: Sr. Sra. Doutor, Doutora e outras formas de tratamento.
Nome Fantasia da Empresa quando for pessoa jurídica.
String
PhoneCelular (opcional)
Número do telefone celular.
String
PhoneHome (opcional)
Número do telefone residencial.
String
PhoneOther (opcional)
Número de telefone adicional.
String
PhoneJob (opcional)
Número do telefone do trabalho.
String
PhoneExtension (opcional)
Número do Ramal.
String
Fax (opcional)
Número do Fax.
String
Email (opcional)
E-mail do comprador.
String
ErpUniqueID (opcional)
Código único no sistema da aplicação que está utilizando a API.
String
VatNumber (opcional)
Número do CPF
String
IdentificationNumber (opcional)
Número de um documento definido por que utiliza a API, por exemplo RG.
String
IdentificationIssuer (opcional)
Orgão emissor do documento fornecido no IdentificationNumber, por exemplo RG.
String
IdentificationTypeID (opcional)
Tipo de documento fornecido no IdentificationNumber, por exemplo RG, CPF, Passaporte e etc.
String
JobDescription (opcional)
Profissão do Comprador.
String
GenderID (opcional)
Genero [M] Masculino e [F] Feminino.
String
EntityTypeID (opcional)
Tipo de Pessoa Física [CPF] e Pessoa Jurídica [CNPJ].
String
AccountingNumber (opcional)
Conta Contábil utilizada pelo financeiro se existir.
String
Obs (opcional)
Texto livre associado ao comprador.
String
BirthDate (opcional)
Data de Nascimento do Comprador.
String
DisabilityID (opcional)
Definir se o comprador possui alguma deficiência.
String
MaritalID (opcional)
Definir o estado civil do comprador.
String

ENDEREÇO DE ENTREGA / MAINADDRESS

URL REQUEST:
https://gateway.prod.HubMoney.co/api/acquire/merchant/add

JSON REQUEST - CONTINUATION:

},
"mainAddress": {
"street": "string",
"portNumber": "string",
"portLetter": "string",
"complement": "string",
"city": "string",
"state": "string",
”zipCode": "string",
"country": "string"
}

Parâmetros Descrição
Street (opcional)
Endereço de entrega do pedido.
String
PortNumber (opcional)
Número da residência/apartamento.
String
PortLetter (opcional)
Número do Apartamento se houver.
String
Complement (opcional)
Complemento do endereço.
String
City (opcional)
Cidade em que deverá entregue o pedido.
String
State (opcional)
Estado em que deverá entregue o pedido.
String
ZipCode (opcional)
CEP do endereço em que o pedido será entregue.
String
Country (opcional)
País do endereço em que o pedido será entregue.
String

ENDEREÇO DE ENTREGA / BILLINGADDRESS

URL REQUEST:
https://gateway.prod.HubMoney.co/api/acquire/merchant/add

JSON REQUEST - CONTINUATION:

},
"billingAddress": {
"street": "string",
"portNumber": "string",
"portLetter": "string",
"complement": "string",
"city": "string",
"state": "string",
”zipCode": "string",
"country": "string"
}

Parâmetros Descrição
Street (opcional)
Endereço de entrega do pedido.
String
PortNumber (opcional)
Número da residência/apartamento.
String
PortLetter (opcional)
Número do Apartamento se houver.
String
Complement (opcional)
Complemento do endereço.
String
City (opcional)
Cidade em que deverá entregue o pedido.
String
State (opcional)
Estado em que deverá entregue o pedido.
String
ZipCode (opcional)
CEP do endereço em que o pedido será entregue.
String
Country (opcional)
País do endereço em que o pedido será entregue.
String

DADOS BANCÁRIOS / BANKACCOUNTS

URL REQUEST:
https://gateway.prod.HubMoney.co/api/acquire/cardManager/add

JSON REQUEST - CONTINUATION:

{
"bankAccounts": [
{
"branchNumber": "string",
"branchDigit": "string",
"accountNumber": "string",
"accountNumberDigit": "string",
"bankErpId": "string",
"accountType": 0
}
]
}

Parâmetros Descrição
BranchNumber (opcional)
Número da Agência.
String
BranchDigit (opcional)
Dígito da agência.
String
AccountNumber (opcional)
Número da Conta Corrente.
String
AccountNumberDigit (opcional)
Dígito da Conta Corrente.
String
BankErpID (opcional)
Código do Banco.
String
AccountType (opcional)
Tipo de Conta.
Integer

DADOS DE CRIAÇÃO / DATACREATION

URL REQUEST:
https://gateway.prod.HubMoney.co/api/acquire/cardManager/add

JSON REQUEST - CONTINUATION:

],
"dateCreation": "2017-05-08T22:55:59.824Z",
"statualSubscription": "string",
"stateCityCreation": "string",
"nameRepresentant": "string",
"vatRepresentant": "string",
"emailRepresentant": "string",
"birthdateRepresentant": "2017-05-08T22:55:59.824Z"
},
"portalPassword": "string",
"productAcquireTemplateUUID": [
"string"
],
"cardTemplateUUID": [
"string"
]},
"portalPassword": "string",
"productAcquireTemplateUUID": [
"string"
],
"cardTemplateUUID": [
"string"
]

Parâmetros Descrição
DataCreation (opcional)
Data de registro do Lojista (EC).
String
StatualSubscription (opcional)
NNNNNNNNN
String
StateCityCreation (opcional)
NNNNNNNNN
String
VatRepresentant (opcional)
CPF do representante legal da empresa.
String
EmailRepresentante (opcional)
E-mail do representante legal da empresa.
String
BirthdateRepresentant (opcional)
Data de Nascimento do Representante legal da Empresa.
Integer
PortalPassword (opcional)
NNNNNNN
String
ProductAcquireTemplateUUID (opcional)
NNNNNNN
String
CardTemplateUUID (opcional)
NNNNNNN
String

Desativar Lojista

DESATIVAR LOJISTA / DEACTIVATE

Basta enviar na PATH o parâmetro MerchantUUID.

URL REQUEST – COMANDO PUT:
https://gateway.prod.HubMoney.co/api/acquire/merchant/deactivate/oo

Parâmetros Descrição
MerchantUUID (opcional)
Token gerado para identificação do estabelecimento comercial que está executando o pedido de pagamento. Quando este campo estiver preenchido, nenhum outro dado precisa ser preenchido.
String

RESPOSTA / HTTP RESPONSE CODES

Response Codes Descrição
200 Pedido processado com sucesso. Verifique os códigos de retorno.
400 O Formato do pedido está incorreto, Verifique os Parâmetros.
401 Autenticação inválida. Por favor, verifique o código de retorno.
500 Erro geral. Por favor, entre em contato com o suporte HubMoney no suporte@HubMoney.co

Quando retornar 200, o JSON deverá retornar os seguinte JSON contemplando as informações de acordo com o pedido solicitado.

RESPOSTA – 200 / RESPONSE CLASS (200)

JSON RESPONSE CODES:

{
"responseCode": "string",
"responseMessage": "string",
}

Response Descrição
ResponseCode (opcional)
Código de resposta do pedido.
String
ResponseMessage (opcional)
Descritivo associado ao código da resposta.
String

Ativar Lojista

ATIVAR LOJISTA / ACTIVATE

Basta enviar na PATH o parâmetro MerchantUUID.

URL REQUEST – COMANDO PUT:
https://gateway.prod.HubMoney.co/api/acquire/merchant/activate/ll

Parâmetros Descrição
MerchantUUID (opcional)
Token gerado para identificação do estabelecimento comercial que está executando o pedido de pagamento. Quando este campo estiver preenchido, nenhum outro dado precisa ser preenchido.
String

RESPOSTA / HTTP RESPONSE CODES

Response Codes Descrição
200 Pedido processado com sucesso. Verifique os códigos de retorno.
400 O Formato do pedido está incorreto, Verifique os Parâmetros.
401 Autenticação inválida. Por favor, verifique o código de retorno.
500 Erro geral. Por favor, entre em contato com o suporte HubMoney no suporte@HubMoney.co

Quando retornar 200, o JSON deverá retornar os seguinte JSON contemplando as informações de acordo com o pedido solicitado.

RESPOSTA – 200 / RESPONSE CLASS (200)

JSON RESPONSE CODES:

{
"responseCode": "string",
"responseMessage": "string",
}

Response Descrição
ResponseCode (opcional)
Código de resposta do pedido.
String
ResponseMessage (opcional)
Descritivo associado ao código da resposta.
String

Remover Lojista

REMOVER LOJISTA / REMOVE

Basta enviar na PATH o parâmetro MerchantUUID.

URL REQUEST – COMANDO DELETE:
https://gateway.prod.HubMoney.co/api/acquire/merchant/remove/u

Parâmetros Descrição
MerchantUUID (opcional)
Token gerado para identificação do estabelecimento comercial que está executando o pedido de pagamento. Quando este campo estiver preenchido, nenhum outro dado precisa ser preenchido.
String

RESPOSTA / HTTP RESPONSE CODES

Response Codes Descrição
200 Pedido processado com sucesso. Verifique os códigos de retorno.
400 O Formato do pedido está incorreto, Verifique os Parâmetros.
401 Autenticação inválida. Por favor, verifique o código de retorno.
500 Erro geral. Por favor, entre em contato com o suporte HubMoney no suporte@HubMoney.co

Quando retornar 200, o JSON deverá retornar os seguinte JSON contemplando as informações de acordo com o pedido solicitado.

RESPOSTA – 200 / RESPONSE CLASS (200)

JSON RESPONSE CODES:

{
"responseCode": "string",
"responseMessage": "string",
}

Response Descrição
ResponseCode (opcional)
Código de resposta do pedido.
String
ResponseMessage (opcional)
Descritivo associado ao código da resposta.
String

Atualizar Lojista

API GESTÃO DE LOJISTAS

Essa API será utilizada para ATUALIZAR os dados dos estabelecimentos comerciais que já estão cadastrados na plataforma de meios de pagamentos do HubMoney.

Será necessário realizar a Autenticação e obter o Requester-Token para uso desse serviço.

HEADER

Parâmetros - Header Descrição
requester-id (obrigatório)
Usuário criado pela plataforma HubMoney e fornecido por e-mail após cadastramento no HubMoney.
String
requester-token (obrigatório)
Token obtido na chamada da API de Autenticação.
String
unique-trx-id (obrigatório)
Identificador único da transação. Este código identificador único é enviado pela aplicação estiver consumindo nossas APIs.
Long

No corpo da requisição JSON você poderá enviar um pedido utilizando o método PUT. Esse pedido raiz contempla informações que estão contempladas nos seguintes objetos: Endereço de Fiscal, Endereço de Cobrança, Dados Bancários e Dados de Criação.

CRIAR PEDIDO / ORDER

A raiz do objeto contempla os dados básicos do pedido

URL REQUEST:
https://gateway.prod.HubMoney.co/api/acquire/merchant/add

JSON REQUEST - CONTINUATION:

"cardHolder": {
"entity": {
"idUUID": "string",
"name": "string",
"namePrefix": "string",
"phoneCelular": "string",
"phoneHome": "string",
"phoneOther": "string",
"phoneJob": "string",
"phoneExtension": "string",
"fax": "string",
"email": "string",
"erpUniqueId": "string",
"vatNumber": "string",
"identificationNumber": "string",
"identificationIssuer": "string",
"identificationTypeId": 0,
"entityRelationshipId": 0,
"jobDescription": "string",
"genderId": 0,
"entityTypeId": 0,
"accountingNumber": "string",
"obs": "string",
"birthDate": "string",
"disabilityId": 0,
"maritalId": 0
},

Parâmetros Descrição
Name (opcional)
Nome completo do comprador quando for PF (Pessoa Física);
Razão social da empresa quando for PF (Pessoa Jurídica)
String
NamePrefix (opcional)
Campo para texto livre.
Forma de tratamento da pessoa física, tais como: Sr. Sra. Doutor, Doutora e outras formas de tratamento.
Nome Fantasia da Empresa quando for pessoa jurídica.
String
PhoneCelular (opcional)
Número do telefone celular.
String
PhoneHome (opcional)
Número do telefone residencial.
String
PhoneOther (opcional)
Número de telefone adicional.
String
PhoneJob (opcional)
Número do telefone do trabalho.
String
PhoneExtension (opcional)
Número do Ramal.
String
Fax (opcional)
Número do Fax.
String
Email (opcional)
E-mail do comprador.
String
ErpUniqueID (opcional)
Código único no sistema da aplicação que está utilizando a API.
String
VatNumber (opcional)
Número do CPF
String
IdentificationNumber (opcional)
Número de um documento definido por que utiliza a API, por exemplo RG.
String
IdentificationIssuer (opcional)
Orgão emissor do documento fornecido no IdentificationNumber, por exemplo RG.
String
IdentificationTypeID (opcional)
Tipo de documento fornecido no IdentificationNumber, por exemplo RG, CPF, Passaporte e etc.
String
JobDescription (opcional)
Profissão do Comprador.
String
GenderID (opcional)
Genero [M] Masculino e [F] Feminino.
String
EntityTypeID (opcional)
Tipo de Pessoa Física [CPF] e Pessoa Jurídica [CNPJ].
String
AccountingNumber (opcional)
Conta Contábil utilizada pelo financeiro se existir.
String
Obs (opcional)
Texto livre associado ao comprador.
String
BirthDate (opcional)
Data de Nascimento do Comprador.
String
DisabilityID (opcional)
Definir se o comprador possui alguma deficiência.
String
MaritalID (opcional)
Definir o estado civil do comprador.
String

ENDEREÇO DE ENTREGA / MAINADDRESS

URL REQUEST:
https://gateway.prod.HubMoney.co/api/acquire/merchant/add

JSON REQUEST - CONTINUATION:

},
"mainAddress": {
"street": "string",
"portNumber": "string",
"portLetter": "string",
"complement": "string",
"city": "string",
"state": "string",
”zipCode": "string",
"country": "string"
}

Parâmetros Descrição
Street (opcional)
Endereço de entrega do pedido.
String
PortNumber (opcional)
Número da residência/apartamento.
String
PortLetter (opcional)
Número do Apartamento se houver.
String
Complement (opcional)
Complemento do endereço.
String
City (opcional)
Cidade em que deverá entregue o pedido.
String
State (opcional)
Estado em que deverá entregue o pedido.
String
ZipCode (opcional)
CEP do endereço em que o pedido será entregue.
String
Country (opcional)
País do endereço em que o pedido será entregue.
String

ENDEREÇO DE ENTREGA / BILLINGADDRESS

URL REQUEST:
https://gateway.prod.HubMoney.co/api/acquire/cardManager/add

JSON REQUEST - CONTINUATION:

},
"billingAddress": {
"street": "string",
"portNumber": "string",
"portLetter": "string",
"complement": "string",
"city": "string",
"state": "string",
”zipCode": "string",
"country": "string"
}

Parâmetros Descrição
Street (opcional)
Endereço de entrega do pedido.
String
PortNumber (opcional)
Número da residência/apartamento.
String
PortLetter (opcional)
Número do Apartamento se houver.
String
Complement (opcional)
Complemento do endereço.
String
City (opcional)
Cidade em que deverá entregue o pedido.
String
State (opcional)
Estado em que deverá entregue o pedido.
String
ZipCode (opcional)
CEP do endereço em que o pedido será entregue.
String
Country (opcional)
País do endereço em que o pedido será entregue.
String

DADOS BANCÁRIOS / BANKACCOUNTS

URL REQUEST:
https://gateway.prod.HubMoney.co/api/acquire/cardManager/add

JSON REQUEST - CONTINUATION:

{
"bankAccounts": [
{
"branchNumber": "string",
"branchDigit": "string",
"accountNumber": "string",
"accountNumberDigit": "string",
"bankErpId": "string",
"accountType": 0
}
]
}

Parâmetros Descrição
BranchNumber (opcional)
Número da Agência.
String
BranchDigit (opcional)
Dígito da agência.
String
AccountNumber (opcional)
Número da Conta Corrente.
String
AccountNumberDigit (opcional)
Dígito da Conta Corrente.
String
BankErpID (opcional)
Código do Banco.
String
AccountType (opcional)
Tipo de Conta.
Integer

DADOS DE CRIAÇÃO / DATACREATION

URL REQUEST:
https://gateway.prod.HubMoney.co/api/acquire/cardManager/add

JSON REQUEST - CONTINUATION:

],
"dateCreation": "2017-05-08T22:55:59.824Z",
"statualSubscription": "string",
"stateCityCreation": "string",
"nameRepresentant": "string",
"vatRepresentant": "string",
"emailRepresentant": "string",
"birthdateRepresentant": "2017-05-08T22:55:59.824Z"
},
"portalPassword": "string",
"productAcquireTemplateUUID": [
"string"
],
"cardTemplateUUID": [
"string"
]},
"portalPassword": "string",
"productAcquireTemplateUUID": [
"string"
],
"cardTemplateUUID": [
"string"
]

Parâmetros Descrição
DataCreation (opcional)
Data de registro do Lojista (EC).
String
StatualSubscription (opcional)
NNNNNNNNN
String
StateCityCreation (opcional)
NNNNNNNNN
String
VatRepresentant (opcional)
CPF do representante legal da empresa.
String
EmailRepresentante (opcional)
E-mail do representante legal da empresa.
String
BirthdateRepresentant (opcional)
Data de Nascimento do Representante legal da Empresa.
Integer
PortalPassword (opcional)
NNNNNNN
String
ProductAcquireTemplateUUID (opcional)
NNNNNNN
String
CardTemplateUUID (opcional)
NNNNNNN
String

Test Seabox

Para facilitar o desenvolvimento disponibilizamos a os dados abaixo para testes.

Parâmetros Descrição
unique-trx-id 123456
working-operation-uuid 10c7bbc2-6f19-4033-8d73-cff3ab946fd6
gateway-uuid 385115d0-dc76-4deb-acb2-6342cfa1a13e
requesterId op_HubMoney_online
requesterPassword sOAvIQTHweD9XgLQnnFB93PLKu9WiP1V uK8ymnzgGvo=ix

1 - Unique-trx-id: Este código identificador único enviado pela aplicação estiver consumindo nossas APIs.

2 - Working-operation-uuid: Identificador da Operação fornecido pela equipe Comercial do HubMoney.

3 - Gateway-uuid: Esse código é obrigatório apenas para execução da API de pagamentos. Esse código está associado ao serviço contratado e também ao Working-Operation-UUID. No momento do cadastro, será fornecido pela equipe comercial.

4 - Requesterid: Usuário criado pela plataforma HubMoney para realização de testes. No momento do cadastro no HubMoney será enviado por email.

5 - RequesterPassword: Este dado está encriptado. Nessa encriptação contempla a SENHA e a CHAVE geradas para teste. Para produção, serão fornecidas por e-mail. As SENHA e a CHAVE encriptadas são:
- SENHA:
- CHAVE:

Para encriptação disponibilizamos alguns modelos de implementação no modelo AES 128 ao lado.

Cartões Para Teste

BANDEIRA Nº do Cartão validade Código de Segurança
Visa 4012001037141110 05/2018 123
Mastercard 5453010000066160 05/2018 123

EXEMPLO DE CÓDIGOS DE RETORNO DAS TRANSAÇÕES

EXEMPLO DE CÓDIGOS DE RETORNO DAS TRANSAÇÕES

Glossário

Glossário De Códigos

Segue abaixo tabela com os códigos de retorno e seus significados.

HTTP STATUS

Código de retorno da transação.

Response Codes Descrição
200 Pedido processado com sucesso. Verifique os códigos de retorno.
201 Pedido criado com sucesso, mas ainda não foi processado. Enviar uma solicitação utilizando {PaymentInfo}.
400 O Formato do pedido está incorreto, Verifique os Parâmetros.
401 Autenticação inválida. Por favor, verifique o código de retorno.
500 Erro geral. Por favor, entre em contato com o suporte HubMoney no suporte@HubMoney.co

RETURN CODE

Código de retorno da HubMoney.

EXEMPLO DE ENCRIPTAÇÃO – JAVA :

}
NNNNNN
NNNNNNN
NNNNNNN
NNNNNN
NNNNN
NNNNNNN
}

+EXEMPLO DE ENCRIPTAÇÃO – PHP:

+EXEMPLO DE ENCRIPTAÇÃO – .NET:

Response Codes Descrição
1 e 100 Processado com sucesso.
3, 5 O Formato do pedido está incorreto, Verifique os Parâmetros.
4 Autenticação inválida. Por favor, verifique o código de retorno.
100* Erro geral. Por favor, entre em contato com o suporte HubMoney no suporte@HubMoney.co

*Depois de 35 segundos (6 tentativas), recomenda-se que utilize o método de Call Back.

CALL BACK = Método que envia uma notificação quando há uma atualização de status da transação.

EXEMPLO DE CÓDIGOS DE RETORNO DAS TRANSAÇÕES

PAYMENT INFO

Código de retorno da Adquirente.

Response Codes Descrição
0 Autorizado.
1 Pagamento processado.
2 Autorizado para validação.
4 Aguardando autorização.
6 Aguardando autorização para validar.
8 Não criado.
9 Recusado.