Skip to content
Reference
/
/
Add another payment to a...

Add another payment to a bill

Request

Security
oauth2ClientCredentials(Required scopes: bills:write)
Path
billIdstringrequired
Headers
org_wallet_refstring
business_idstringrequired
Idempotency-Keystring

Optional idempotency key (8–255 chars). Also accepted as body idempotency_key; header wins when both are present.

Bodyapplication/jsonrequired
amountnumber

Payment amount

statusstring
Enum:"draft""pending""outstanding"
is_tax_paymentboolean

Marks this as a tax remittance payment

withholding_taxesArray of objects

WithHoldingTax ObjectIds linked to this payment

payment_instructionobject

Selected payment instruction

sourcestring

Source wallet reference/id

source_namestring

Source wallet display name

budgetArray of strings

Budget ObjectId(s) funding this payment. Upstream links the budget to the payment (schema: budget: [ObjectId]).

send_onstring

Date the bill payment should be sent (YYYY-MM-DD)

idempotency_keystring

Idempotency key making this payment safe to retry. Also accepted as the Idempotency-Key header; forwarded upstream so a retry is deduped instead of double-charging.

curl -i -X POST \
  'https://developer.boyahq.com/_mock/v2/openapi/bills/{billId}/payments' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: string' \
  -H 'business_id: string' \
  -H 'org_wallet_ref: string' \
  -d '{
    "amount": 0,
    "status": "draft",
    "is_tax_payment": true,
    "withholding_taxes": [
      {}
    ],
    "payment_instruction": {},
    "source": "string",
    "source_name": "string",
    "budget": [
      "string"
    ],
    "send_on": "string",
    "idempotency_key": "string"
  }'

Responses