Retornar Transação

Endpoint dedicado para a Nomad retornar uma transação filtrada com base no parâmetro item_id. Caso haja mais de uma transação em nossos sistemas com o mesmo valor de item_id, será retornado sempre a transação com a data/hora mais recente.

Nota

No futuro podem ser adicionados novos parâmetro de busca de acordo com novas necessidades da Nomad.

GETv2/transactions/nomad

Request Query Params

Atributo	Tipo	Descrição
item_id	string	Filtro por ID da transação na sua plataforma.

Response Object

Ao buscar uma transação com um item_id, é retornado um objeto contendo as informações da transação. Caso o filtro utilizado não encontre nenhuma transação, é retornado um array vazio.

Propriedade	Tipo	Descrição
status	string	Representa o estado atual da transação. Valores possíveis: paid, review, refused, refunded e chargeback.
nsu	string	Código que identifica a transação na adquirente.
authorization_code	string	Código de autorização retornado pelo banco emissor.
date_created	dateTime	Data de criação da transação no formato ISODateTime.
date_updated	dateTime	Data de atualização do status da transação no formato ISODateTime.
net_value	int32	Valor em centavos a ser cobrado sem as taxas de adquirência.
amount	int32	Valor em centavos a ser cobrado na transação.
paid_amount	int32	Valor em centavos capturado na transação.
refunded_amount	int32	Valor em centavos estornado na transação.
installments	string	Número de parcelas em que o cliente pagou.
transaction_id	string	Número identificador da transação.
card_holder_name	string	Nome do portador do cartão utilizado no pagamento.
card_brand	string	Bandeira do cartão utilizado no pagamento. Valores possíveis: visa, mastercard, amex, hipercard e elo.
card_first_digits	string	Primeiros 6 dígitos do cartão utilizado no pagamento.
card_last_digits	string	Últimos 4 dígitos do cartão utilizado no pagamento.
acquirer_status_code	string	Código identificador da resposta do Banco Emissor. Valores possíveis: 0000, 1000, 1011, 1016 e 5000.
acquirer_status_message	string	Mensagem referente ao código da resposta do Banco Emissor.

Exemplos

Filtro por ITEM_ID

Request

curl -X GET -G "https://api.marlim.co/v2/transactions" \
-H "Content-Type: application/json" \
-H "api_key: api_key_value" \
-d item_id="123456789"

Response200

{
  "status": "paid",
  "nsu": "12344321",
  "authorization_code": "987654",
  "date_created": "2024-11-29T13:12:33.698Z",
  "date_updated": "2024-11-29T13:12:33.698Z",
  "net_value": 200000,
  "amount": 211305,
  "paid_amount": 211305,
  "installments": "2",
  "transaction_id": "12344321",
  "card_holder_name": "Leia Skywalker Organa Solo",
  "card_brand": "mastercard",
  "card_first_digits": "444455",
  "card_last_digits": "3333",
  "acquirer_status_code": "0000",
  "acquirer_status_message": "The bank has authorized this amount on the card."
}

Sem o parâmetro ITEM_ID

Request

curl -X GET -G "https://api.marlim.co/v2/transactions" \
-H "Content-Type: application/json" \
-H "api_key: api_key_value" \

Response400

{
  "errors": {
    "type": "parameter",
    "message": "The parameter [ item_id ] is missing."
  }
}