Get a bill payment by ID

curl --request GET \
  --url https://rest.staging.nickel.com/billPayment/{billPaymentId} \
  --header 'Authorization: Bearer <token>'

{
  "id": "<string>",
  "status": "<string>",
  "amountInCents": 123,
  "createdAt": 123,
  "vendorPayoutMethodId": "<string>",
  "billPayableId": "<string>"
}

GET

billPayment

{billPaymentId}

Get a bill payment by ID

curl --request GET \
  --url https://rest.staging.nickel.com/billPayment/{billPaymentId} \
  --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

Response

Successful operation

string

status

string | null

amountInCents

integer<int64> | null

createdAt

number | null

vendorPayoutMethodId

string | null

billPayableId

string

Pay bills Cancel a bill payment

⌘I