Get a payment

get

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

Retrieve one X9 payment using payment_token, or the pair reference_id + oba_token. GET has no request body. The current implementation does not return payment_amount here; use the submitted amount and the file CSV for reconciliation. payment_status is used on GET, while POST uses status.

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

Request examples

ByToken

GET /api/v1/payment?type=X9&payment_token=77777777-7777-4777-8777-777777777777 HTTP/1.1
Authorization: <PAYOLOGY_API_KEY>
Accept: application/json

ByReferenceAndBank

GET /api/v1/payment?type=X9&reference_id=check-1001&oba_token=33333333-3333-4333-8333-333333333333 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	payment_token or reference_id and oba_token is required
400	R0002	Error	Field is not properly formatted
401	R0003	Error	Authentication token is invalid
403	R0003	Error	Access not allowed
404	R0161	Error	Payment token is invalid
404	R0180	Error	reference_id or oba_token is invalid
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 payment, with optional return and adjustment information.

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.

404Requested resource or lookup reference was not found.

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.