Refund a payment
Refunds a specified payment in full. This endpoint is intended for correcting erroneous transactions. Only payments in the settled state can be refunded. This includes customers with ACH disabled because payments go straight to settled.
Path parameters
payment_id
Headers
Authorization
Bearer authentication of the form Bearer <token>, where token is your auth token.
Response
This endpoint returns an object.
amount
The amount of the payment, in cents
created_on
Timestamp the payment is created on
facility_id
The facility_id of the credit facility to make a payment for
id
refund_metadata
Metadata about the original transaction being refunded
status
The status of the payment
transfer_type
The type of ACH transfer
failure_reason
A reason for the failure if one exists
is_autopay
If the payment was a result of an autopay