Update a payment

put

https://test-api.payology.io/api/v1/payment/{payment_token}

Update an X9 payment. A normal void uses payment_status=Voided; a processed payment cannot be voided through this operation. At least one of tracking_number, payment_status, receipt_email or receipt_phone is required. Rating-only updates fail the current required-field middleware.

Request examples

Void

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

Receipt

PUT /api/v1/payment/77777777-7777-4777-8777-777777777777?type=X9 HTTP/1.1
Authorization: <PAYOLOGY_API_KEY>
Accept: application/json
Content-Type: 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
200	R0000	Ok	The request was processed successfully
400	R0002	Error	Field is not properly formatted
400	R0162	Error	Tracking number cannot be updated for payments that do not have an associated shipping contact
400	R0163	Error	Only payments in pending status can be voided
401	R0003	Error	Authentication token is invalid
403	R0003	Error	Access not allowed
404	R0161	Error	Payment 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.

200Payment updated.

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.

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.