Skip to main content
POST
/
billPayment
/
{billPaymentId}
/
cancel
Cancel a bill payment
curl --request POST \
  --url https://rest.staging.nickel.com/billPayment/{billPaymentId}/cancel \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "status": "<string>",
  "amountInCents": 123,
  "createdAt": 123,
  "vendorPayoutMethodId": "<string>",
  "billPayableId": "<string>"
}

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 bill payment to cancel

Response

Successful operation

​
id
string
​
status
string | null
​
amountInCents
integer<int64> | null
​
createdAt
number | null
​
vendorPayoutMethodId
string | null
​
billPayableId
string