Get payment file status

get

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

Retrieve file metadata using type=X9 and exactly one lookup token. file_token returns one object; file_payments_token returns an array for the export request. Download the returned file_payments_url to obtain the CSV. Processing, failed, expired and missing export requests currently use HTTP 400, distinguished by R-code.

This request has no JSON body. Use the path/query examples below.

Request examples

SingleFile

GET /api/v1/payment/file?type=X9&file_token=88888888-8888-4888-8888-888888888888 HTTP/1.1
Authorization: <PAYOLOGY_API_KEY>
Accept: application/json

ExportRequest

GET /api/v1/payment/file?type=X9&file_payments_token=aaaaaaaa-aaaa-4aaa-8aaa-aaaaaaaaaaaa HTTP/1.1
Authorization: <PAYOLOGY_API_KEY>
Accept: application/json

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
400	R0001	Error	field is required
400	R0002	Error	Field is not properly formatted
400	R0002	Error	payment_type must be ACH, X9, or CC
400	R0003	Error	You must provide either file_payments_token or file_token, but not both
400	R0333	Error	File is generating
400	R0334	Error	Request not found or has expired
400	R0335	Error	File generation failed. Please contact support
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.

200One file object or an array, according to the lookup parameter.

400Invalid selector or file request state. These states are HTTP 400 in the reviewed X9 service.

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.

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.