Credit a facility

POST
/facilities/:facility_id/credit

Credit a facility

Path parameters

facility_idstringRequired

Request

This endpoint expects an object.
amountintegerRequired

The amount to credit the facility, in cents (e.g. 1000 = $10.00)

memostringOptional

A memo to attach to the credit

original_disbursement_idstringOptional

Disbursement ID associated with the credit action (if applicable)

original_payment_idstringOptional

Payment ID associated with the credit action (if applicable)

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_autopaybooleanOptional

If the payment was a result of an autopay

Errors