Skip to main content
POST
Apply Transaction to a Bill

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

x-user-id
string | null

Optional external entity identifier that performed the action

Path Parameters

business_id
string<biz_string>
required

The id of the business

Example:

"biz_GA6EG2qFxA97NZHtxeLPUy"

Body

application/json
bill_id
string<bil_string>
required

The ID of the bill to apply payment to

Example:

"bil_Lq5AyApd4pdL1VvakpY5aJ"

transaction_id
string<txn_string> | null

The ID of the transaction to apply as payment. If null, the payment is drawn from the vendor's available credit pool and payment_amount is required.

Example:

"txn_oiL7THC5RDi2PVUbVyyoJ"

payment_amount

The amount to apply as payment. When transaction_id is provided, defaults to the transaction amount. When transaction_id is null, this is required and must be greater than zero.

Required range: x >= 0

Response

Successful Response

data
BillPublic · object
required