transaction

Download Transactions (Sync)

Get a URL to download transactions as a CSV/JSON file.

get/transactions/download

Request

  • Base URL: https://api.mercoa.com
  • URL: https://api.mercoa.com/transactions/download
  • Auth: HTTP bearer

Query parameters

format'CSV' | 'JSON'

Format of the file to download. Defaults to CSV.

entityIdstring

Filter transactions by the ID or foreign ID of the entity that created the transaction.

entityGroupIdstring

Filter transactions by the ID or foreign ID of the entity group that the entity belongs to.

startDatestring date-time

CREATED_AT Start date filter.

endDatestring date-time

CREATED_AT End date filter.

limitinteger

Number of transactions to return. Limit can range between 1 and 100, and the default is 10.

startingAfterstring

The ID of the transactions to start after. If not provided, the first page of transactions will be returned.

searchstring

Find transactions by vendor name, invoice number, check number, or amount. Partial matches are supported.

keystring required

Filter transactions by invoice metadata. Each filter will be applied as an AND condition. Duplicate keys will be ignored.

keystring required

Filter transactions by invoice line item metadata. Each filter will be applied as an AND condition. Duplicate keys will be ignored.

lineItemGlAccountIdstring

Filter transactions by invoice line item GL account ID. Each filter will be applied as an OR condition. Duplicate keys will be ignored.

payerIdstring

Filter transactions by payer ID or payer foreign ID.

vendorIdstring

Filter transactions by vendor ID or vendor foreign ID.

invoiceIdstring

Filter transactions by invoice ID or invoice foreign ID.

transactionIdstring

Filter transactions by transaction ID.

status'CREATED' | 'PENDING' | 'COMPLETED' | 'FAILED' | 'REVERSED' | 'QUEUED' | 'CANCELED' | 'RETURNED'

Transaction status to filter on

transactionType'bankAccountToBankAccount' | 'bankAccountToMailedCheck' | 'bankAccountToPrintedCheck' | 'bankAccountToWallet' | 'cardToBankAccount' | 'cardToWallet' | 'walletToBankAccount' | 'walletToWallet' | 'custom' | 'offPlatform'

Filter transactions by transaction type

creatorUserIdstring

Filter transactions by creator user ID. Does not work, do not use.

Response

Response with status 200

urlstring required
mimeTypestring required

Changes

No recorded changes to this operation across all 1 revision of this API.