Sync Refund Status
Ask the processor whether this payment was refunded outside PaymentKit.
A payment refunded directly in the processor’s dashboard is invisible to PaymentKit until something asks. This checks, and records the refund when it finds one, so the payment’s status and refundable amount reflect what actually happened rather than only what was done through PaymentKit.
Idempotent: once reconciled the payment has no remaining refundable amount, so
calling again changes nothing. checked=false means the processor could not
be reached — treat it as “no new information”, never as “not refunded”.
Authentication
AuthorizationBearer
Bearer authentication of the form Bearer <token>, where token is your auth token.
Path parameters
payment_intent_id
account_id
Response
Successful Response
checked
Whether the processor was successfully asked about this payment
reconciled
Whether an out-of-band refund was discovered and recorded by this call
amount_atom_refunded
Total refunded amount PaymentKit now records for this payment
amount_atom_refundable
Amount still refundable through PaymentKit after this call
Errors
422
Unprocessable Entity Error