Testing checklist

Before you go live, we recommend that you complete the following testing checklist.

Sandbox testing

Test Endpoint What to verify
Generate a transaction activity CSV POST /v2/activity/download Send a valid request with accountId, name, startDate, and endDate. Confirm you receive a 202 response with {"message": "accepted"}.
Generate a statement CSV POST /v2/statement/download Send a valid request with fileFormat set to csv. Confirm you receive a 202 response. Requires a person-level API key.
Generate a statement PDF POST /v2/statement/download Send a valid request with fileFormat set to pdf. Confirm you receive a 202 response. Requires a person-level API key.
Download a payment confirmation GET /v2/payments/{paymentId}/confirmation Send a valid request with a paymentId and accountId. Confirm you receive a 200 response with a PDF file.
Test with filters POST /v2/activity/download Add optional filters such as currencyCodes, budgetIds, or type to your transaction activity request. Confirm the request is accepted.
Test date validation POST /v2/statement/download Verify that setting endDate to today's date returns an error (statements require endDate to be at least one day before today).

Integration

Check What to verify
Async response handling Your system correctly handles 202 responses for transaction activity and statement requests, and does not wait for a file in the response body.
Sync response handling Your system correctly handles the 200 response for payment confirmations, which includes the PDF file directly in the response body.
Error handling Your system handles errors gracefully, including missing required fields, invalid date formats, and invalid account or budget IDs.
Authorization header Your requests use the format Authorization: ApiKey YOUR_API_KEY_HERE consistently.
CSV data handling Your system can correctly parse the CSV output, which contains at least 36 columns (UTF-8 encoding).

Go-live preparation

Check What to verify
Production API key Your production API key is set up and working.
IP whitelisting Your production IP address is whitelisted.
Base URL Your base URL has been updated from api-sandbox.equalsmoney.com to api.equalsmoney.com.
Email delivery You have confirmed that reports are received at the expected email address in production.
Person-level API key (if applicable) If using statements, you have confirmed your person-level API key works in production.