GuidesAPI Reference
API Reference

/v1/order/{key}/payment/{id}

Update an existing payment.

Payment status lifecycle is as follows: PENDING: The initial status of an ACH payment put towards a Credit Key order. CANCELED: Cancels an order installment payment that's currently in PENDING status. RETURNED: This means the ACH payment was returned in some kind of failure state. i.e. NSF, Unauthorized Bank Account. PAID: The ACH payment completed successfully. REFUNDED: The funds for a PAID payment were sent back to the payer.

Path Params
string
required

The idempotency_key used in the original POST payment request, or the unique payment id generated by Credit Key.

string
required

The unique order key generated by Credit Key.

Body Params
string
enum
required

The new status for the payment.

Allowed:
string

The return reason for returned payments.

Responses

Language
Credentials
Bearer
JWT
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json