Run

An invoice link with a QR code, to take a Payfast payment

A Payfast payment link and a QR code for any amount the business wants paid (a walk-in, a nail clip at the door, something sold on the day), not tied to a booking. The client pays on Payfast themselves (card, Instant EFT, SnapScan, Zapper); NogPets' card fee is added on top as on a card booking. With a Payfast split the amount goes to the business's own Payfast account, else NogPets pays it over. South African businesses only (409 PAYFAST_ZA_ONLY). Without confirm: 409 CONFIRM_REQUIRED with the summary. Needs business:manage; owners and managers (bizId only if they run more than one).

post/v1/business/invoices

Request

  • Base URL: https://api.nogpets.com
  • URL: https://api.nogpets.com/v1/business/invoices
  • Auth: one of:
    • OAuth 2 (authorization code, authorization URL https://api.nogpets.com/oauth/authorize, token URL https://api.nogpets.com/oauth/token, scopes: business:manage)
    • HTTP bearer

Request body

bizIdstring
amountCentsinteger required

The amount in the business's currency, minor units (R350 = 35000). NogPets' card fee is added on top for the client.

descriptionstring required

What it's for, shown to the client on the pay page, e.g. "Nail clip for Max".

clientNamestring
clientIdstring

A client of the business (find_client), for the name and the record.

bookingIdstring

A booking of the business this payment goes with, as a reference only (an unpaid card booking has its own link, send_payment_link).

expiresInDaysinteger

How long the link works (default 7).

confirmboolean

true only after the person saw the summary from the first call and said yes.

Response

Created

invoiceIdstring required
descriptionstring
amountstring
amountCentsinteger
cardFeestring
totalstring

What the client pays (the amount + NogPets' card fee).

totalCentsinteger
clientNamestring nullable
payUrlstring required

The page the client opens to pay on Payfast (https://api.nogpets.com/pay/i/{id}?t=…).

qrUrlstring required

A PNG QR code of payUrl, to show or print for the client to scan.

expiresAtstring
summarystring
nextstring

Changes

No recorded changes to this operation across all 1 revision of this API.