Saltar al contenido principal

exportCharges

Exports charges to a CSV while the request waits, and returns a download URL valid for 15 minutes. The file has one row per charge.succeeded, charge.captured, charge.failed, charge.refunded, charge.partially_refunded, charge.canceled and charge.paid_out event that matches filter, newest first. The type column is charge, refund, payout or chargeback, and is empty for a canceled charge. amount is in major units (for example, 10.5), negative for a refund (the refunded amount), a payout and a chargeback. createdAt is the time of the event, as DD/MM/YYYY H:mm in timezone. Fails with code F001 when no row matches. A large export can hit the runtime timeout or the response-size limit: use startExportCharges for it. Arguments: - filter: Filter on charges, with the same fields as the charges filter. createdAt filters on the time of the event, not of the payment. status: {match: "CHARGEBACK"} selects one row per payment that received a chargeback (CSV type column chargeback), dated when the chargeback came in. A user restricted to a store or a point of sale gets only its rows. - columns: Columns of the CSV, with or without the object. prefix (paymentId and id mean objectId). Columns that cannot be exported are dropped, and none left is error F003. Omit for the default set: createdAt, type, status, amount, currency, orderId, paymentId, checkoutId, providerReferenceId, authorizationCode, customer email, name and phone, payment method, card brand, country, type, 3D Secure and its version, card last 4, statusCode and statusMessage. Other columns include refundedAmount, description, descriptor, paymentProcessor, subscriptionId, storeId, pointOfSaleId, and the billing, shipping, session, shop and trace details. - timezone: IANA time zone of the date columns (for example, Europe/Madrid). Defaults to UTC.

exportCharges(
filter: SearchableChargeFilterInput
columns: [String!]
timezone: String
): ExportCharges!

Arguments​

exportCharges.filter ● SearchableChargeFilterInput input​

exportCharges.columns ● [String!] list scalar​

exportCharges.timezone ● String scalar​

Type​

ExportCharges object​

Result of a synchronous charges export: a CSV file (MONEI_Payments.csv) made while the request waits.