Pular para o conteúdo principal

Criar Transação

Para iniciar o processo de uma cobrança com o Stars você deve utilizar essa rota e criar uma transação.

POSTv1/transactions

Parâmetros Request Body

AtributoTipoDescrição
request_idstringID relacionado ao request dos Stars.
gross_amoutint32Valor a ser cobrado. Deve ser passado em centavos.
payment_methodstringMétodo de pagamento. Valores Aceitos: credit, debit e pix.
customer_namestringNome do cliente.
customer_document_numberstringNúmero do documento do cliente. IMPORTANTE: Se o comprador for de nacionalidade Brasileira, deve ser passado o CPF do mesmo. Caso o cliente seja estrangeiro, deve ser passado o número identificador (NIN) - national identification number.
customer_document_typestringTipo do documento do cliente referente ao customer_document_number informado. Valores Aceitos: cpf, cnpj e passaporte.
customer_emailstringE-mail do cliente.
customer_phone_numberstringNúmero de telefone do cliente. IMPORTANTE: Se o comprador for de nacionalidade Brasileira, deve ser passado no formato +55DD9XXXXXXXX. Caso o cliente seja estrangeiro, deve ser passado no padrão regex /^+(?:[0-9] ?){6,14}[0-9]$/]].
wu_sale_me_quantityint32Valor em centavos da quantidade da moeda estrangeira. NOTA: Similar a chave DestinationAmt no WUPOS.
wu_sale_me_valueint32Valor em centavos da cobrança cambial da transação. NOTA: Similar a divisão dos valores das chaves LocalCurrencyAmt e DestinationAmt no WUPOS.
wu_sale_mn_valueint32Total em centavos em moeda nacional referente a moeda estrangeira. NOTA: Similar a chave LocalCurrencyAmt no WUPOS.
wu_sale_iofint32Valor em centavos do IOF cobrado na transação.
wu_agent_account_numberstringCódigo ARE da loja.
wu_agent_operator_idstringCódigo ID do usuário Stars.
wu_agent_terminal_idstringCódigo ID do terminal Marlim (PinPad).
wu_agent_pos_user_idstringCódigo ID do caixa Stars.
postback_urlstringURL de notificação (webhook) em que o sistema da WU deverá receber informações assíncronas sobre atualização de transações do tipo Pix.
pix_mock_paymentstringParâmetro opcional adicional para mocar o pagamento do Pix em ambiente Sandbox. Valores Aceitos: paid e refused.
Importante

O valor em gross_amout deve ser passado em centavos (Ex: BRL 10.00 = 1000) e deve ser maior ou igual a R$ 1,00 (100) e menor ou igual a R$ 10.000,00 (1000000) caso o parâmetro payment_method seja igual a credit.

Atenção

O parâmetro pix_mock_payment só será aceito com a API_KEY Sandbox.
Caso seja passado o valor no ambiente de Produção irá retornar um erro 400.

Response Object

Ao criar uma transação, este é o objeto que se recebe como resposta.

PropriedadeTipoDescrição
statusstringRepresenta o estado da transação. Valores possíveis: paid e refused.
authorization_codestringCódigo de autorização retornado pela bandeira.
nsustringCódigo que identifica a transação na adquirente.
acquirer_response_codestringMensagem de resposta da adquirente referente ao status da transação. Valores possíveis: 0000, 1000, 1011, 1016 e 5000.
marlim_transaction_idstringNúmero identificador da transação.
date_createdstringData de criação da transação no formato ISODate.
payment_methodstringMétodo de pagamento. Valores possíveis: credit, debit e pix.
installmentsstringNúmero de parcelas em que o cliente pagou.
authorized_amountint32Valor em centavos autorizado na transação.
paid_amountint32Valor em centavos capturado na transação.
paid_per_monthint32Valor em centavos do total mensal capturado na transação.
interest_ratefloat32Valor flutuante referente a porcentagem da taxa de adquirência.
interest_rate_per_monthint32Valor em centavos do total mensal da taxa de adquirência.
interest_rate_totalint32Valor em centavos do total da taxa de adquirência.
card_brandstringBandeira do cartão utilizado no pagamento. Valores possíveis: visa, mastercard, amex, hipercard e elo.
card_last_digitsstringÚltimos 4 dígitos do cartão utilizado no pagamento.
card_holder_namestringNome do portador do cartão utilizado no pagamento.
Importante

A propriedade acquirer_response_code, se constitue na seguinte tabela:

PrefixoSignificado
0000Transação paga ou estornada.
1000Transação não aprovada pelo banco.
1011Senha incorreta.
1016Cartão sem saldo.
5000Erro bancário genérico. O cliente deve entrar em contato com o Banco Emissor.

Exemplos

Request


  curl POST https://api.wu.marlim.co/v1/transactions
  --H "Content-Type": "application/json"
  --H "api_key": "api_key_value"
  --data-raw '{
    "request_id": "123456789",
    "gross_amout": 100000,
    "payment_method": "credit",
    "customer_name": "Luke Skywalker",
    "customer_document_type": "cpf",
    "customer_document_number": "12345678900",
    "customer_email": "luke@jedimaster.sw",
    "customer_phone_number": "+18007770133",
    "wu_sale_me_quantity": 30000,
    "wu_sale_me_value": 317,
    "wu_sale_mn_value": 95000,
    "wu_sale_iof": 180,
    "wu_agent_account_number": "EWOKS123",
    "wu_agent_operator_id": "001",
    "wu_agent_terminal_id": "A0BC",
    "wu_agent_pos_user_id": "123ABC"
  }'
Response
{
  "status": "paid",
  "authorization_code": "123456",
  "nsu": "11122233",
  "acquirer_response_code": "0000",
  "marlim_transaction_id": "11122233",
  "date_created": "2021-05-04T00:00:00.000Z",
  "payment_method": "credit",
  "installments": "3",
  "authorized_amount": 104221,
  "paid_amount": 104221,
  "paid_per_month": 26055,
  "interest_rate": 1.04,
  "interest_rate_per_month": 1407,
  "interest_rate_total": 4221,
  "card_brand": "visa",
  "card_last_digits": "4444",
  "card_holder_name": "Luke Skywalker"
}