Skip to navigation
APIPay Ops endpointsPaypoints

Create a paypoint

Beta
View as MarkdownOpen in Claude

Creates a paypoint. New paypoints start in pending. Provide exactly one of businessReference (an existing business) or business (to create the business inline).

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
Use existing businessobjectRequired

Create a paypoint under an existing business. Provide businessReference plus doingBusinessAs; all other fields are optional.

OR
Create business inlineobjectRequired

Create a paypoint and its backing business together. Provide business plus doingBusinessAs; all other fields are optional.

OR
All fieldsobjectRequired

All fields accepted when creating a paypoint. Provide exactly one of businessReference or business.

Response

Paypoint created.
successboolean
Whether the request succeeded.
messagestring or null

A human-readable result message.

traceIdstring or null
The trace identifier for the request, useful for support.
dataobject or null
The created paypoint.

Errors

400
Bad Request Error
401
Unauthorized Error
500
Internal Server Error