CHcheckhq

Reverse a payment

Changed on

Reverses a paid ACH credit for an employee net pay or contractor payment. Available to partners enrolled in the Corrections API preview. Requires the payment:reverse OAuth scope and an X-Idempotency-Key header.

post/payments/{payment}/reverse

Request

Path parameters

paymentstring required

ID of the payment to reverse.

Headers

X-Idempotency-Keystring required

Idempotency key. Replays the first response when the same key is reused.

Request body

reason'duplicate' | 'incorrect_amount' | 'incorrect_receiving_account' required

Why the payment is being reversed.

Response

200

Changes