Business

Connect a Payfast merchant (id only)

Step 7 (optional; South African businesses only, needed for card payments). Stores the business's Payfast merchant id for split payments, pending NogPets' verification. Never send a merchant key or passphrase; the schema refuses any field but the id. Elsewhere 409 PAYFAST_ZA_ONLY.

post/v1/business/applications/{applicationId}/payfast

Request

  • Base URL: https://api.nogpets.com
  • URL: https://api.nogpets.com/v1/business/applications/{applicationId}/payfast
  • 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:write)
    • HTTP bearer

Request body

merchantIdstring required

The Payfast merchant id, digits only. Never the merchant key or passphrase.

Response

The application, with payfastInfo to explain to the person

applicationIdstring required
status'DRAFT' | 'SUBMITTED' | 'APPROVED' | 'REJECTED' required

DRAFT while it's being filled in; SUBMITTED while NogPets reviews it; APPROVED (the business exists, bizId) or REJECTED (reviewNote says why; editing it makes it a DRAFT again).

businessobject required
servicesobject[]
areasobject[]

Proposed territories, PENDING until approved.

resourcesobject[]
invitesobject[]
whatsappOptInboolean
planunknown
readyToSubmitboolean required
reviewNotestring

Why NogPets asked for changes.

bizIdstring

The business, once approved.

possibleListingsobject[]

Directory listings that may be this business: offer to claim one.

payfastInfostring
summarystring
statusUrlstring uri nullable

A page the person can open to see the checklist and status.

welcomeUrlstring uri

What NogPets offers businesses, for the person to read.

nextstring required

What to do now.

Changes

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