Orders Report

This document describes the expected format for uploading merchant orders via the FileUpload API. Order files enrich reconciliation by linking provider transactions back to merchant order references.

File Format

  • Format: Only CSV files are currently supported.

Required Fields

Field NameTypeDescriptionExample
providerstringPayment provider name (must be supported)stripe
provider_accountstringProvider account identifieracct_12345
provider_referencestringProvider reference for the transactionref_67890
acquirerstringAcquirer nameacquirerX
typestringTransaction type: capture, refund, or chargebackcapture
currencystring3-letter ISO 4217 currency codeUSD
amountfloatTransaction amount (must be > 0)100.50
created_atstringRFC3339 timestamp2025-12-03T10:15:30Z
order_referencestringMerchant order referenceorder_001

Optional Fields

Field NameTypeDescriptionExample
timezonestringIANA timezone nameEurope/Berlin
transaction_referencestringMerchant transaction referencetxn_002
holder_referencestringMerchant holder referenceholder_003
auth_codestring6-digit authorization code123456
arnstring23-digit Acquirer Reference Number12345678901234567890123
rrnstring12-digit Retrieval Reference Number123456789012

Value References

type allowed values: capture, refund, chargeback

Validation Rules

  • All required fields must be present and non-empty.
  • currency must be a valid 3-letter ISO 4217 code.
  • amount must be a positive number.
  • created_at must be a valid RFC3339 timestamp.
  • auth_code, arn, and rrn must match their respective digit lengths if provided.
  • timezone must be a valid IANA timezone name if provided.

Example CSV

provider,provider_account,acquirer,provider_reference,type,created_at,timezone,currency,amount,order_reference,transaction_reference,holder_reference,auth_code,arn,rrn
stripe,acct_123,stripe,pi_123,capture,2024-09-12T10:15:30Z,Europe/London,USD,123.45,order-001,txn-001,holder-001,123456,12345678901234567890123,123456789012
adyen,acct_456,adyen,psp_456,refund,2024-10-01T08:00:00Z,,EUR,10.00,order-002,,,,,