Request a payment file

post

https://test-api.payology.io/api/v1/payment/file

Supporting operation for GET Files: request a CSV export of payments belonging to existing settlement files in a date range. It does not create a raw X9 settlement file. Dates cannot be in the future; end_date must be on/after start_date and the difference must not exceed 31 days. payment_type is the selector here, unlike type for ordinary payments. Existing requests can return HTTP 201 with Error/R0333 or Error/R0335.

Result codes in the response examples

HTTP status and result code are operation-specific. Field-validation messages can include the affected field name.

HTTP	Code	Result	Meaning
201	R0330	Ok	The request has been accepted and is pending generation
201	R0333	Error	File is generating
201	R0335	Error	File generation failed. Please contact support
201	R0336	Ok	There is already a completed request for this date range within the last 12 hours. Send <remake_file=true> to re-generate the file.
400	R0002	Error	Field is not properly formatted
400	R0002	Error	payment_type must be ACH, X9, or CC
400	R0331	Error	You cannot select a period greater than 31 days
400	R0332	Error	Date cannot be in the future
400	R0337	Error	End date must be after start date
400	R0340	Error	Nothing to generate for the specified date range
401	R0003	Error	Authentication token is invalid
403	R0003	Error	Access not allowed
500	R0999	Error	Something went wrong

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Responses

default

Other infrastructure or forwarded downstream response. HTTP status and body must be preserved; do not assume every error has a Payology R-code. No fixed payload is guaranteed.

201Export request created or existing request state returned.

400Invalid fields, selector, or business rule. Consult the individual example code.

401Authentication failed. Some services also use 401 for organization access denial. Gateway bodies can differ.

403Permission or organization access denied; the gateway can reject the request before it reaches the service.

413Proxy JSON body exceeds the configured 1 MiB limit; base64 images count toward that limit.

429Gateway throttling or quota. Exact quota, retry headers and deployed body were not verified. This is a platform possibility, not an observed Payology response.

500Unhandled service failure. Gateway configuration/authorizer failures can also return 500.

502Proxy could not obtain an HTTP response from the selected payment service.

504Gateway integration timeout or failure. The service may still have committed a create request. This is a platform possibility, not an observed Payology response.