Retornar Transações

Retorna um array contendo objetos de transações, ordenadas a partir da transação realizada mais recentemente.
Caso não seja passado nenhum filtro, retona um array de objetos contendo as últimas 10 transações da Western Union realizadas com a Marlim, sejam elas Money Transfer (MT) ou Stars (FX).

GETv1/transactions

Query Params

Propriedade	Tipo	Descrição
date_created	date-time	Filtro para Data de Criação.
date_updated	date-time	Filtro para Data de Atualização.
wu_agent_account_number	string	Filtro por Loja.
wu_agent_operator_id	string	Filtro por Atendente.
wu_payment_type	string	Filtro pela modalidade WU de Pagamento. Valores aceitos: `MT` e `FX`.
status	string	Filtro por Status da Transação: Valores aceitos: `paid`, `refused`, `refunded` e `chargeback`.
payment_method	string	Filtro por Método de Pagamento: Valores aceitos: `credit` e `debit`.
request_id	string	Filtro pelo ID da Request Stars.
count	int32	Retorna n objetos de transação. Máximo de 1.000 e default de 10.
page	int32	Útil para implementação de uma paginação de resultados.

Tip

A propriedade date_created no endpoint transactions pode ser usada para filtrar buscas em ranges de data utilizando os prefixos:

Prefixo	Significado
<	menor que
>	maior que
<=	menor ou igual a
>=	maior ou igual a

Por exemplo, para buscar em um range de date_created:

Status Paid

Request

Atenção

A filtragem por data utiliza unixTimeStamp em milissegundos para representá-la. Para gerar o unixTimeStamp de uma data, é possível utilizar o console do Google Chrome com o seguinte código em Javascript: new Date("2021-05-04T00:00:00.000Z").getTime() que retornará 1620086400000.

Response Object

Ao buscar transações, retorna um objeto com 4 propriedades: total, page, offset e transactions.

Propriedade	Tipo	Descrição
total	int32	Total de transações que atende ao filtro passado na query.
page	int32	Página atual referente ao `offset` de páginas.
offset	int32	Total de páginas referente ao `count` dividido pelo `total` de transações atendidas nas query.
transactions	array	Array de objetos contendo os dados das transações.

Transactions Array

Se a resposta da query for maior ou igual a 1, dentro da propriedade transactions, este é o array de objetos que você recebe como resposta. Caso o filtro utilizando não encontre nenhuma transação, é retornado um array vazio.

Propriedade	Tipo	Descrição
status	string	Representa o estado da transação. Valores possíveis: `paid`, `refused`, `refunded` e `chargeback`.
authorization_code	string	Código de autorização retornado pela bandeira.
nsu	string	Código que identifica a transação na adquirente.
acquirer_response_code	string	Mensagem de resposta da adquirente referente ao status da transação. Valores possíveis: `0000`, `1000`, `1011`, `1016` e `5000`.
marlim_transaction_id	string	Número identificador da transação.
date_created	string	Data de criação da transação no formato ISODate.
date_updated	string	Data de atualização da transação no formato ISODate.
payment_method	string	Método de pagamento. Valores possíveis: `credit` e `debit`.
installments	string	Número de parcelas em que o cliente pagou.
gross_amout	int32	Valor a ser cobrado, sem a taxa de adquirência.
authorized_amount	int32	Valor em centavos autorizado na transação.
paid_amount	int32	Valor em centavos capturado na transação.
paid_per_month	int32	Valor em centavos do total mensal capturado na transação.
interest_rate	float32	Valor flutuante referente a porcentagem da taxa de adquirência.
interest_rate_per_month	int32	Valor em centavos do total mensal da taxa de adquirência.
interest_rate_total	int32	Valor em centavos do total da taxa de adquirência.
customer_name	string	Nome do cliente.
customer_document_number	string	Número do documento do cliente.
customer_email	string	E-mail do cliente.
customer_phone_number	string	Número de telefone do cliente.
card_brand	string	Bandeira do cartão utilizado no pagamento. Valores possíveis: `visa`, `mastercard`, `amex`, `hipercard` e `elo`.
card_last_digits	string	Últimos 4 dígitos do cartão utilizado no pagamento.
card_holder_name	string	Nome do portador do cartão utilizado no pagamento.
wu_payment_type	string	Modalidade WU de Pagamento. Valores possíveis: `MT` e `FX`.
wu_agent_account_number	string	Código ARE da loja.
wu_agent_operator_id	string	Código identificador do usuário Stars.
wu_agent_terminal_id	string	Código identificador do terminal Marlim (PinPad).
wu_agent_pos_user_id	string	Código identificador do caixa Stars.
wu_mt_transaction_id	string	Código identificador da transação Money Transfer (MTCN).

Exemplo

10 últimas transações

Request


  curl POST https://api.wu.marlim.co/v1/transactions
  --H "Content-Type": "application/json"
  --H "api_key": "api_key_value"
  --data-raw '{}'

Response

{
  "total": 150,
  "page": 1,
  "offset": 15,
  "transactions": [
    {
      "status": "paid",
      "authorization_code": "123456",
      "nsu": "111222333",
      "acquirer_response_code": "0000",
      "marlim_transaction_id": "111222333",
      "date_created": "2021-05-04T00:00:00.000Z",
      "date_updated": "2021-05-04T00:00:00.000Z",
      "payment_method": "credit",
      "installments": "3",
      "gross_amout": 100000,
      "authorized_amount": 104221,
      "paid_amount": 104221,
      "paid_per_month": 26055,
      "interest_rate": 1.04,
      "interest_rate_per_month": 1407,
      "interest_rate_total": 4221,
      "customer_name": "Luke Skywalker",
      "customer_document_number": "12345678900",
      "customer_email": "luke@jedimaster.sw",
      "customer_phone_number": "+18007770133",
      "card_brand": "visa",
      "card_last_digits": "4444",
      "card_holder_name": "Luke Skywalker",
      "wu_payment_type": "FX",
      "wu_agent_account_number": "EWOKS123",
      "wu_agent_operator_id": "001",
      "wu_agent_terminal_id": "A0BC",
      "wu_agent_pos_user_id": "123ABC"
    },
    {
      "status": "refused",
      "authorization_code": null,
      "nsu": "111222444",
      "acquirer_response_code": "1016",
      "marlim_transaction_id": "111222444",
      "date_created": "2021-05-04T01:00:00.000Z",
      "date_updated": "2021-05-04T01:00:00.000Z",
      "payment_method": "credit",
      "installments": "1",
      "gross_amout": 200000,
      "authorized_amount": 0,
      "paid_amount": 0,
      "paid_per_month": 0,
      "interest_rate": 1.18,
      "interest_rate_per_month": 0,
      "interest_rate_total": 0,
      "customer_name": "Leia Skywalker Organa Solo",
      "customer_document_number": "12345678999",
      "customer_email": "leia@jedimaster.sw",
      "customer_phone_number": "+18007770144",
      "card_brand": "mastercard",
      "card_last_digits": "5555",
      "card_holder_name": "Leia S. O. Solo",
      "wu_payment_type": "MT",
      "wu_agent_account_number": "NABOO123",
      "wu_agent_operator_id": "002",
      "wu_agent_terminal_id": "B1CD",
      "wu_mt_transaction_id": "1234567890"
    },
    {
      "status": "refunded",
      "authorization_code": "456789",
      "nsu": "111222555",
      "acquirer_response_code": "0000",
      "marlim_transaction_id": "111222555",
      "date_created": "2021-05-03T02:00:00.000Z",
      "date_updated": "2021-05-04T02:00:00.000Z",
      "payment_method": "credit",
      "installments": "8",
      "gross_amout": 500000,
      "authorized_amount": 544959,
      "paid_amount": 0,
      "paid_per_month": 0,
      "interest_rate": 0.96,
      "interest_rate_per_month": 0,
      "interest_rate_total": 0,
      "customer_name": "Lord Darth Vader",
      "customer_document_number": "1111222888",
      "customer_email": "vader@darklordofthesith.sw",
      "customer_phone_number": "+18007770555",
      "card_brand": "amex",
      "card_last_digits": "777",
      "card_holder_name": "Lord D. Vader",
      "wu_payment_type": "FX",
      "wu_agent_account_number": "IAMYOURFATHER999",
      "wu_agent_operator_id": "003",
      "wu_agent_terminal_id": "C2DE",
      "wu_agent_pos_user_id": "345DEF"
    },
    {
      "+7n": "..."
    }
  ]
}

Query Params​

Tip

Atenção

Response Object​

Transactions Array​

Exemplo​

Query Params

Response Object

Transactions Array

Exemplo