Skip to main content
POST
Stop payment on a check bill payment

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

billPaymentId
string
required

ID of the check bill payment to stop

Response

Successful operation

id
string
status
string | null
amountInCents
integer<int64> | null
createdAt
number | null
vendorDeliveryMethodId
string | null

ID of the vendor delivery method the funds were sent to.

vendorPayoutMethodId
string | null
deprecated

Deprecated alias of vendorDeliveryMethodId, retained for backwards compatibility.

billPayableId
string

Opaque ID grouping the payment attempts made against one bill. Not directly retrievable through the API; use the bill and bill payment endpoints instead.