Create an application

Beta

POST

/v2/requests

POST

/api/v2/requests

curl -X POST https://api-sandbox.payabli.com/api/v2/requests \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "businessReference": "019fed1a-3d6e-75d3-a81e-cba3874b0a55",
  "externalId": "APP-2025-0417",
  "tags": [
    "priority"
  ]
}'

{
  "success": true,
  "message": "Application created successfully",
  "traceId": "0HNNNPRPLVN40:00000012",
  "data": {
    "requestsReference": "3f3caa7b-bdfe-4bf1-814b-30d54859247c",
    "businessReference": "019fed1a-3d6e-75d3-a81e-cba3874b0a55",
    "applicationStatus": "draft",
    "applicationStatusCode": 1,
    "allowedActions": [
      "submit",
      "withdraw",
      "abandon"
    ],
    "createdAt": "2026-07-01T15:00:01.734346",
    "_links": {
      "self": "/v2/requests/3f3caa7b-bdfe-4bf1-814b-30d54859247c",
      "business": "/v2/businesses/019fed1a-3d6e-75d3-a81e-cba3874b0a55"
    },
    "paypointReference": "019ff064-c690-7679-a73e-688418aadc7c",
    "paypointStatus": "pending",
    "externalId": "APP-2025-0417",
    "tags": [
      "priority"
    ]
  }
}

Creates a boarding application for a business. The business must already have a paypoint. New applications start in draft.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

businessReferencestringRequired

The reference of the business to board. The business must have a paypoint.

paypointReferencestringOptional

The reference of the paypoint to board. Defaults to the business's paypoint when omitted.

externalIdstringOptional

An optional identifier from your own system.

entityTypestringOptional

The type of entity being boarded.

requestTemplatestringOptional

The reference of the boarding template to apply. Send one on every application. Payabli assigns the underwriting policy from the template, so a submitted application without one fails in review.

tagslist of stringsOptional

Optional labels for the application.

representativeslist of objectsOptional

The sales or service representatives assigned to the application.

configurationsobject or nullOptional

Opaque application-level configuration. Null when not supplied.

servicesobjectOptional

The services to request on the application.

Response

The application was 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 application.

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

500

Internal Server Error