Refund a payment

POST
/payments/:payment_id/refund

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_idstringRequired

Response

This endpoint returns an object.
amountinteger

The amount of the payment, in cents

created_ondatetime

Timestamp the payment is created on

facility_idstring

The facility_id of the credit facility to make a payment for

idstring
refund_metadataobject

Metadata about the original transaction being refunded

statusenum

The status of the payment

transfer_typeenum

The type of ACH transfer

failure_reasonstringOptional

A reason for the failure if one exists

is_autopaybooleanOptionalDefaults to false

If the payment was a result of an autopay

Errors

Built with