Skip to main content

Return Transactions

Attention

Cross Border routes are not enabled by default. Before integrating, prior alignment with Marlim's Risk and Development teams is required.

This route will be used to search for transactions of credit card type, this endpoint returns an array containing transaction objects, sorted from the most recently performed transaction.

If no filter is passed, an array of objects containing your last 10 operations performed with Marlim will be returned.

GETv3/crossborder/transactions

Request Query Params​

AttributeTypeDescription
transaction_idstringFilter by a specific Marlim transaction ID.
statusstringFilter by status.

Accepted values: paid, authorized, review, rejected, refused, expired, failed, refunded, canceled and chargeback
payment_methodstringFilter by payment method.

Accepted value: credit_card
sub_seller_idstringFilter by a partner ID.
external_sub_seller_idstringFilter by an ID from your platform of your sales partner.
external_sub_seller_document_numberstringFilter by a CNPJ of your sales partner.
date_createddateTimeFilter by creation date.
date_updateddateTimeFilter by update date.
item_idstringFilter by a specific charge/order ID.
countint32Returns n transaction objects. Maximum of 1,000 and default of 10.
pageint32Useful for implementing result pagination.
Tip

The properties date_created and date_updated can be used to filter date range searches using the following attributes:

AttributeDescription
<less than
>greater than
<=less than or equal to
>=greater than or equal to
Request
curl -X GET -G "https://api.marlim.co/v3/crossborder/transactions" \
-H "Content-Type: application/json" \
-H "api_key: api_key_value" \
-d date_created=">=1620086400000" \ 
-d date_created="<=1620172799000"
Important

Date filtering uses unixTimeStamp in milliseconds to represent it. To generate the unixTimeStamp of a date, you can use the Google Chrome console with the following JavaScript code: new Date("2023-01-01T00:00:00.000Z").getTime() which will return 1672531200000.

Response Object​

When searching for transactions, returns an object with 4 properties: total, page, offset and transactions.

AttributeTypeDescription
totalint32Total number of transactions that meet the filter passed in the query.
pageint32Current page related to the offset of pages.
offsetint32Total number of pages for count divided by total of transactions returned in the query.
transactionsarrayArray of objects containing the transactions.

Array Transactions​

If the query response is greater than or equal to 1, the transactions property will bring an array of transaction objects. If the filter used does not find any transaction, an empty array will be returned.

Credit Card​

PropertyTypeDescription
statusstringRepresents the current state of the transaction. Possible values: paid, authorized, review, rejected, refused, refunded, canceled and chargeback.
nsustringCode that identifies the transaction in the Acquirer.
date_createddateTimeTransaction creation date in ISODateTime format.
date_updateddateTimeTransaction status update date in ISODateTime format.
authorized_amountint32Amount in cents authorized in the transaction.
paid_amountint32Amount in cents captured in the transaction.
refunded_amountint32Amount in cents refunded in the transaction.
installmentsstringNumber of installments the customer paid in.
transaction_idstringTransaction identifier number in Marlim.
item_idstringTransaction ID in your platform.
payment_methodstringPayment method used in the transaction. Possible values: credit_card.
card_holder_namestringName of the cardholder used in payment.
card_brandstringCard brand used in payment. Possible values: visa, mastercard, amex, hipercard and elo.
card_first_digitsstringFirst 6 digits of the card used in payment.
card_last_digitsstringLast 4 digits of the card used in payment.
sub_seller_idstringOptional parameter that identifies a sub_seller previously registered at Marlim, responsible for the transaction.
acquirer_status_codestringResponse identifier code from the Issuing Bank. Possible values: 0000, 1000, 1011, 1016 and 5000.
acquirer_status_messagestringMessage regarding the Issuing Bank's response code.
crossborder_liquidationbooleanCross Border only. Indicates whether the transaction has already been settled. Starts as false and becomes true once settlement happens. Settled transactions can no longer be refunded.
crossborder_liquidation_datedateTime | nullCross Border only. Settlement date in ISODateTime format. null while the transaction has not been settled.
exchangeobjectCross Border only. Exchange applied to the remittance operation. Absent on transactions that are not remittances.
exchange[indicative]booleanfalse when the quote is the one locked for the operation. true means an indicative quote only. It is the preview, when the lock has not happened yet.
exchange[currency]stringDestination currency of the remittance, the currency of amount. E.g.: USD.
exchange[pay_currency]stringCurrency the payer pays in. Applies to price, amount_converted, spread_amount and operation_fees. E.g.: BRL.
exchange[amount]double | nullAmount the seller receives in the destination currency, already net of exchange costs.
exchange[price]double | nullExchange base in the payment currency. It is the upfront amount, without card interest. It closes the math: price = amount_converted + spread_amount + operation_fees.
exchange[amount_converted]double | nullThe amount converted at the market rate, before spread and operating costs. Serves as a comparison reference.
exchange[spot_rate]double | nullMarket exchange rate at the time of the operation.
exchange[vet]double | nullTotal Effective Value. The rate that actually applies to the receivable, including spread and costs. Equals price ÷ amount.
exchange[spread_rate]double | nullSpread applied over the market rate, as a decimal fraction.
exchange[spread_amount]double | nullAbsolute value of the applied spread.
exchange[operation_fees]double | nullOperating costs of the remittance: IOF and provider fees, aggregated into a single value.

Examples​

Request
curl -X GET -G "https://api.marlim.co/v3/crossborder/transactions" \
-H "Content-Type: application/json" \
-H "api_key: api_key_value" \
-d transaction_id="k4m6Rw5rlQszEY7fiuRe"
Response200
{
  "total": 1,
  "page": 1,
  "offset": 1,
  "transactions": [
    {
      "status": "paid",
      "nsu": "032416400102",
      "authorization_code": "112233",
      "date_created": "2026-10-30T18:58:53.391Z",
      "date_updated": "2026-10-30T19:58:53.391Z",
      "net_value": 100000,
      "authorized_amount": 100000,
      "paid_amount": 100000,
      "refunded_amount": 0,
      "installments": "1",
      "transaction_id": "k4m6Rw5rlQszEY7fiuRe",
      "item_id": "ABC987654321",
      "payment_method": "credit_card",
      "card_holder_name": "Luke Skywalker",
      "card_brand": "visa",
      "card_first_digits": "555544",
      "card_last_digits": "2222",
      "acquirer_status_code": "0000",
      "acquirer_status_message": "The acquirer captured the amount on the card.",
      "crossborder_liquidation": true,
      "crossborder_liquidation_date": "2026-09-22T10:00:00.000Z",
      "exchange": {
        "indicative": false,
        "currency": "USD",
        "pay_currency": "BRL",
        "amount": 187.4,
        "price": 1000.03,
        "amount_converted": 957.88,
        "spot_rate": 5.1114,
        "vet": 5.3363,
        "spread_rate": 0.009,
        "spread_amount": 8.6209,
        "operation_fees": 33.5258
      }
    }
  ]
}