> This is Payabli documentation. For a complete page index, fetch https://docs.payabli.com/llms.txt — append .md to any page URL for lightweight markdown. For section-level indexes, query parameters, and other AI-optimized access methods, see https://docs.payabli.com/ai-agents.md

# Create a paypoint

POST https://api-sandbox.payabli.com/api/v2/paypoints
Content-Type: application/json

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


Reference: https://docs.payabli.com/developers/api-reference/paypoints/create-a-paypoint

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Servers

- `https://api-sandbox.payabli.com/api` (Sandbox, default)
- `https://api.payabli.com/api` (Production)

## Request

### Body (application/json)

This endpoint expects a paypoints_CreatePaypoint_Request.

- `paypoints_CreatePaypoint_Request`

## Response

### 201

Paypoint created.

- `success` (boolean, required) — Whether the request succeeded.
- `message` (string, required, nullable) — A human-readable result message.
- `traceId` (string, required, nullable) — The trace identifier for the request, useful for support.
- `data` (PaypointCreatedResponse, required, nullable) — The created paypoint.

## Errors

### 400 Bad Request Error

Bad request / invalid data.

- `isSuccess` (boolean, required) — Always `false` for error responses.
- `responseText` (string, required) — Error text describing what went wrong.
- `responseCode` (integer, optional) — Code for the response. Learn more in [API Response Codes](/developers/api-reference/api-responses).
- `responseData` (PayabliErrorBodyResponseData, optional) — Object with detailed error context.

### 401 Unauthorized Error

Unauthorized request.

- `isSuccess` (boolean, required) — Always `false` for error responses.
- `responseText` (string, required) — Error text describing what went wrong.
- `responseCode` (integer, optional) — Code for the response. Learn more in [API Response Codes](/developers/api-reference/api-responses).
- `responseData` (PayabliErrorBodyResponseData, optional) — Object with detailed error context.

### 500 Internal Server Error

Internal server error.

- `isSuccess` (boolean, required) — Always `false` for error responses.
- `responseText` (string, required) — Error text describing what went wrong.
- `responseCode` (integer, optional) — Code for the response. Learn more in [API Response Codes](/developers/api-reference/api-responses).
- `responseData` (PayabliErrorBodyResponseData, optional) — Object with detailed error context.

## Types

### CreatePaypointWithBusinessReference

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

- `doingBusinessAs` (string, required) — The name the paypoint does business as (DBA).
- `businessReference` (string, required) — The reference of the existing business the paypoint boards under.
- `parentPaypointReference` (string, optional) — The reference of the parent paypoint, for a paypoint that nests under another.
- `paypointType` (string, optional) — The paypoint type, for example `merchant`.
- `description` (string, optional) — A free-text description of the paypoint.
- `website` (string, optional) — The paypoint's website URL.
- `customerServicePhone` (string, optional) — The customer service phone number.
- `customerServiceEmail` (string, optional) — The customer service email address.
- `timezone` (string, optional) — The paypoint's time zone.
- `externalId` (string, optional) — Your own identifier for the paypoint.
- `customData` (map from string to any, optional) — Arbitrary key-value data you attach to the paypoint.

### CreatePaypointWithInlineBusiness

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

- `doingBusinessAs` (string, required) — The name the paypoint does business as (DBA).
- `business` (CreateBusinessRequest, required) — The business to create inline and back the paypoint with.
- `parentPaypointReference` (string, optional) — The reference of the parent paypoint, for a paypoint that nests under another.
- `paypointType` (string, optional) — The paypoint type, for example `merchant`.
- `description` (string, optional) — A free-text description of the paypoint.
- `website` (string, optional) — The paypoint's website URL.
- `customerServicePhone` (string, optional) — The customer service phone number.
- `customerServiceEmail` (string, optional) — The customer service email address.
- `timezone` (string, optional) — The paypoint's time zone.
- `externalId` (string, optional) — Your own identifier for the paypoint.
- `customData` (map from string to any, optional) — Arbitrary key-value data you attach to the paypoint.

### CreatePaypointAllFields

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

- `doingBusinessAs` (string, required) — The name the paypoint does business as (DBA).
- `parentPaypointReference` (string, optional) — The reference of the parent paypoint, for a paypoint that nests under another.
- `paypointType` (string, optional) — The paypoint type, for example `merchant`.
- `description` (string, optional) — A free-text description of the paypoint.
- `website` (string, optional) — The paypoint's website URL.
- `customerServicePhone` (string, optional) — The customer service phone number.
- `customerServiceEmail` (string, optional) — The customer service email address.
- `timezone` (string, optional) — The paypoint's time zone.
- `externalId` (string, optional) — Your own identifier for the paypoint.
- `customData` (map from string to any, optional) — Arbitrary key-value data you attach to the paypoint.
- `businessReference` (string, optional) — The reference of an existing business the paypoint boards under.
- `business` (CreateBusinessRequest, optional) — The business to create inline and back the paypoint with.

### PaypointCreatedResponse

The reference and initial status of a newly created paypoint.

- `paypointReference` (string, required) — The paypoint reference, used to read and manage the paypoint.
- `paypointStatus` (string, required) — The paypoint status. New paypoints start in `pending`.
- `createdAt` (datetime, required) — When the paypoint was created.
- `_links` (PaypointLinks, required) — Hypermedia links for the paypoint resource.
- `businessReference` (string, optional, nullable) — The reference of the business the paypoint belongs to.
- `doingBusinessAs` (string, optional, nullable) — The name the paypoint does business as (DBA).
- `timezone` (string, optional, nullable) — The paypoint's time zone.

### PayabliErrorBodyResponseData

Object with detailed error context.

- `explanation` (string, optional) — Human-readable explanation of what happened.
- `todoAction` (string, optional) — Suggested resolution.

### CreateBusinessRequest

Request body to create a business.

- `legalName` (string, required) — The registered legal name of the business.
- `externalId` (string, optional) — Your own identifier for the business.
- `description` (string, optional) — A free-text description of the business.
- `legalStructure` (enum, optional) — The business's legal structure. Case-insensitive, and several inputs normalize to the same canonical value on read (for example, `llc` and `limited-liability-company` both read back as `LimitedLiabilityCompany`).
  - Allowed values: `limited-liability-company`, `llc`, `corporation`, `partnership`, `sole-proprietorship`, `non-profit`, `nonprofit`, `government`, `s-corp`, `s-corporation`
- `stockSymbol` (string, optional) — The stock ticker symbol, if the business is publicly traded.
- `incorporationState` (string, optional) — The state where the business is incorporated.
- `taxIdCountry` (string, optional) — The country that issued the business's tax identifier.
- `establishedDate` (datetime, optional) — The date the business was established.
- `numberOfEmployees` (integer, optional) — The number of employees.
- `annualRevenue` (double, optional) — The business's annual revenue.
- `website` (string, optional) — The business's website URL.
- `merchantCatCode` (string, optional) — The merchant category code (MCC) that classifies the business.
- `timezone` (string, optional) — The business's time zone.
- `phone` (list of string, optional) — Phone numbers for the business.
- `emails` (list of string, optional) — Email addresses for the business.
- `operatingSeasons` (list of enum, optional) — The seasons the business operates in. Values are case-insensitive on input and returned capitalized.
  - Allowed values: `Spring`, `Summer`, `Fall`, `Winter`
- `addressDetails` (list of BusinessAddressCreate, optional) — The business's addresses.
- `paymentMethods` (list of BusinessPaymentMethod, optional) — The bank accounts and cards attached to the business.
- `customData` (map from string to any, optional) — Arbitrary key-value data you attach to the business. Payabli stores the applicant's answers to a boarding template's custom questions under the `templateAnswers` key.
- `isForeignOwned` (boolean, optional) — Whether the business is foreign-owned.
- `isTaxExempt` (boolean, optional) — Whether the business is tax-exempt.
- `taxExemptClassification` (string, optional) — The business's tax-exempt classification, such as `501(c)(3)`.
- `processingMetrics` (ProcessingMetrics, optional) — Expected Pay In processing profile for the business.
- `payoutMetrics` (PayoutMetrics, optional) — Expected Pay Out profile for the business.
- `license` (string, optional) — The business's license number.
- `licenseState` (string, optional) — The state that issued the business's license.
- `taxReference` (string, optional) — The business tax identifier, for example an EIN.
- `parentReference` (string, optional) — The organization entrypoint the business belongs to. Omit to use the organization your credential belongs to.

### PaypointLinks

Hypermedia links for a paypoint resource.

- `self` (string, optional) — Relative path to the paypoint resource.
- `business` (string, optional) — Relative path to the business the paypoint belongs to.

### BusinessAddressCreate

An address sent when creating a business. `country` is required.

- `country` (string, required) — The two-character ISO country code.
- `type` (enum, optional) — The address role.
  - Allowed values: `legal`, `billing`, `shipping`, `remittance`, `physical`, `mailing`
- `location` (enum, optional) — The physical use of the address. Defaults to `other`.
  - Allowed values: `office`, `warehouse`, `retail`, `home`, `other`
- `addressLine1` (string, optional) — The first line of the street address.
- `addressLine2` (string, optional) — The second line of the street address.
- `cityLocality` (string, optional) — The city or locality.
- `stateProvince` (string, optional) — The state or province.
- `postalCode` (string, optional) — The postal or ZIP code.
- `floor` (string, optional) — The floor, if applicable.
- `suiteApartNumber` (string, optional) — The suite or apartment number, if applicable.

### BusinessPaymentMethod

A bank account or card attached to a business.

- `type` (string, optional) — The payment method type, for example a bank account or card.
- `accountOwner` (string, optional) — The name of the account owner.
- `name` (string, optional) — An optional label for the payment method.
- `financialInstitution` (string, optional) — The bank or financial institution that holds the account.
- `ownerType` (string, optional) — Whether the owner is a business or an individual.
- `accountType` (string, optional) — The account type, for example checking or savings.
- `accountNumber` (string, optional) — The bank account number.
- `routingNumber` (string, optional) — The bank routing number.
- `cardNumber` (string, optional) — The card number, for card payment methods.
- `expirationDate` (string, optional) — The card expiration date, for card payment methods.
- `cvv` (string, optional) — The card verification value, for card payment methods.
- `cardType` (string, optional) — The card type, for card payment methods.
- `usage` (list of string, optional) — What the payment method is used for.
- `isDefault` (boolean, optional) — Whether this is the owner's default payment method. At most one payment method per owner can set `isDefault` to `true`; sending two `true` values in one request fails validation.

### ProcessingMetrics

Expected Pay In processing profile for the business.

- `monthlyReceivablesVolume` (double, optional) — Expected monthly Pay In volume.
- `averageReceivableSize` (double, optional) — Expected average transaction amount.
- `largestReceivableSize` (double, optional) — Expected largest transaction amount.
- `inboundPresentPercent` (integer, optional) — Percent of volume from card-present transactions.
- `inboundOnlinePercent` (integer, optional) — Percent of volume from online transactions.
- `inboundMotoPercent` (integer, optional) — Percent of volume from mail-order/telephone-order transactions.
- `refundPolicy` (string, optional) — The business's refund policy.
- `advancedDelivery` (boolean, optional) — Whether the business delivers goods or services before it's paid.
- `percentAdvancedDelivery` (integer, optional) — Percent of sales delivered before payment.
- `advancedDeliveryDays` (double, optional) — Average number of days between payment and delivery.
- `numberOfTransactions` (integer, optional) — Expected number of transactions per month.

### PayoutMetrics

Expected Pay Out profile for the business.

- `monthlyPayablesVolume` (double, optional) — Expected monthly Pay Out volume.
- `averagePayablesSize` (double, optional) — Expected average payout amount.
- `largestPayablesSize` (double, optional) — Expected largest payout amount.
- `numberOfTransactions` (integer, optional) — Expected number of payouts per month.

## Examples

### CreatePaypoint

**Request**

```json
{
  "businessReference": "019fed1a-3d6e-75d3-a81e-cba3874b0a55",
  "customerServiceEmail": "support@example.com",
  "customerServicePhone": "3055551212",
  "description": "Boutique flower shop",
  "doingBusinessAs": "Rose Gardens",
  "paypointType": "merchant",
  "timezone": "America/New_York",
  "website": "https://example.com"
}
```

**Response**

```json
{
  "success": true,
  "message": "Paypoint created successfully",
  "traceId": "0HNNN6HH5NDB3:00000001",
  "data": {
    "paypointReference": "019ff064-c690-7679-a73e-688418aadc7c",
    "paypointStatus": "pending",
    "createdAt": "2026-08-11T10:36:04.1157718Z",
    "_links": {
      "self": "/v2/paypoints/019ff064-c690-7679-a73e-688418aadc7c",
      "business": "/v2/businesses/019fed1a-3d6e-75d3-a81e-cba3874b0a55"
    },
    "businessReference": "019fed1a-3d6e-75d3-a81e-cba3874b0a55",
    "doingBusinessAs": "Rose Gardens",
    "timezone": "America/New_York"
  }
}
```

**SDK Code**

```python CreatePaypoint
import requests

url = "https://api-sandbox.payabli.com/api/v2/paypoints"

payload = {
    "businessReference": "019fed1a-3d6e-75d3-a81e-cba3874b0a55",
    "customerServiceEmail": "support@example.com",
    "customerServicePhone": "3055551212",
    "description": "Boutique flower shop",
    "doingBusinessAs": "Rose Gardens",
    "paypointType": "merchant",
    "timezone": "America/New_York",
    "website": "https://example.com"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript CreatePaypoint
const url = 'https://api-sandbox.payabli.com/api/v2/paypoints';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"businessReference":"019fed1a-3d6e-75d3-a81e-cba3874b0a55","customerServiceEmail":"support@example.com","customerServicePhone":"3055551212","description":"Boutique flower shop","doingBusinessAs":"Rose Gardens","paypointType":"merchant","timezone":"America/New_York","website":"https://example.com"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go CreatePaypoint
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api-sandbox.payabli.com/api/v2/paypoints"

	payload := strings.NewReader("{\n  \"businessReference\": \"019fed1a-3d6e-75d3-a81e-cba3874b0a55\",\n  \"customerServiceEmail\": \"support@example.com\",\n  \"customerServicePhone\": \"3055551212\",\n  \"description\": \"Boutique flower shop\",\n  \"doingBusinessAs\": \"Rose Gardens\",\n  \"paypointType\": \"merchant\",\n  \"timezone\": \"America/New_York\",\n  \"website\": \"https://example.com\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby CreatePaypoint
require 'uri'
require 'net/http'

url = URI("https://api-sandbox.payabli.com/api/v2/paypoints")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"businessReference\": \"019fed1a-3d6e-75d3-a81e-cba3874b0a55\",\n  \"customerServiceEmail\": \"support@example.com\",\n  \"customerServicePhone\": \"3055551212\",\n  \"description\": \"Boutique flower shop\",\n  \"doingBusinessAs\": \"Rose Gardens\",\n  \"paypointType\": \"merchant\",\n  \"timezone\": \"America/New_York\",\n  \"website\": \"https://example.com\"\n}"

response = http.request(request)
puts response.read_body
```

```java CreatePaypoint
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api-sandbox.payabli.com/api/v2/paypoints")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"businessReference\": \"019fed1a-3d6e-75d3-a81e-cba3874b0a55\",\n  \"customerServiceEmail\": \"support@example.com\",\n  \"customerServicePhone\": \"3055551212\",\n  \"description\": \"Boutique flower shop\",\n  \"doingBusinessAs\": \"Rose Gardens\",\n  \"paypointType\": \"merchant\",\n  \"timezone\": \"America/New_York\",\n  \"website\": \"https://example.com\"\n}")
  .asString();
```

```php CreatePaypoint
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api-sandbox.payabli.com/api/v2/paypoints', [
  'body' => '{
  "businessReference": "019fed1a-3d6e-75d3-a81e-cba3874b0a55",
  "customerServiceEmail": "support@example.com",
  "customerServicePhone": "3055551212",
  "description": "Boutique flower shop",
  "doingBusinessAs": "Rose Gardens",
  "paypointType": "merchant",
  "timezone": "America/New_York",
  "website": "https://example.com"
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp CreatePaypoint
using RestSharp;

var client = new RestClient("https://api-sandbox.payabli.com/api/v2/paypoints");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"businessReference\": \"019fed1a-3d6e-75d3-a81e-cba3874b0a55\",\n  \"customerServiceEmail\": \"support@example.com\",\n  \"customerServicePhone\": \"3055551212\",\n  \"description\": \"Boutique flower shop\",\n  \"doingBusinessAs\": \"Rose Gardens\",\n  \"paypointType\": \"merchant\",\n  \"timezone\": \"America/New_York\",\n  \"website\": \"https://example.com\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift CreatePaypoint
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "businessReference": "019fed1a-3d6e-75d3-a81e-cba3874b0a55",
  "customerServiceEmail": "support@example.com",
  "customerServicePhone": "3055551212",
  "description": "Boutique flower shop",
  "doingBusinessAs": "Rose Gardens",
  "paypointType": "merchant",
  "timezone": "America/New_York",
  "website": "https://example.com"
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api-sandbox.payabli.com/api/v2/paypoints")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```

### CreatePaypointNewLocation

**Request**

```json
{
  "businessReference": "019fed1a-3d6e-75d3-a81e-cba3874b0a55",
  "doingBusinessAs": "Rose Gardens Downtown",
  "paypointType": "merchant",
  "timezone": "America/New_York"
}
```

**Response**

```json
{
  "success": true,
  "message": "Paypoint created successfully",
  "traceId": "0HNP8M3LB1GJU:0000008B",
  "data": {
    "paypointReference": "019ff3a8-2c41-7b0e-9d52-6e1f0c84a7b3",
    "paypointStatus": "pending",
    "createdAt": "2026-10-13T14:38:25.9924683Z",
    "_links": {
      "self": "/v2/paypoints/019ff3a8-2c41-7b0e-9d52-6e1f0c84a7b3",
      "business": "/v2/businesses/019fed1a-3d6e-75d3-a81e-cba3874b0a55"
    },
    "businessReference": "019fed1a-3d6e-75d3-a81e-cba3874b0a55",
    "doingBusinessAs": "Rose Gardens Downtown",
    "timezone": "America/New_York"
  }
}
```

**SDK Code**

```python CreatePaypointNewLocation
import requests

url = "https://api-sandbox.payabli.com/api/v2/paypoints"

payload = {
    "businessReference": "019fed1a-3d6e-75d3-a81e-cba3874b0a55",
    "doingBusinessAs": "Rose Gardens Downtown",
    "paypointType": "merchant",
    "timezone": "America/New_York"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript CreatePaypointNewLocation
const url = 'https://api-sandbox.payabli.com/api/v2/paypoints';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"businessReference":"019fed1a-3d6e-75d3-a81e-cba3874b0a55","doingBusinessAs":"Rose Gardens Downtown","paypointType":"merchant","timezone":"America/New_York"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go CreatePaypointNewLocation
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api-sandbox.payabli.com/api/v2/paypoints"

	payload := strings.NewReader("{\n  \"businessReference\": \"019fed1a-3d6e-75d3-a81e-cba3874b0a55\",\n  \"doingBusinessAs\": \"Rose Gardens Downtown\",\n  \"paypointType\": \"merchant\",\n  \"timezone\": \"America/New_York\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby CreatePaypointNewLocation
require 'uri'
require 'net/http'

url = URI("https://api-sandbox.payabli.com/api/v2/paypoints")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"businessReference\": \"019fed1a-3d6e-75d3-a81e-cba3874b0a55\",\n  \"doingBusinessAs\": \"Rose Gardens Downtown\",\n  \"paypointType\": \"merchant\",\n  \"timezone\": \"America/New_York\"\n}"

response = http.request(request)
puts response.read_body
```

```java CreatePaypointNewLocation
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api-sandbox.payabli.com/api/v2/paypoints")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"businessReference\": \"019fed1a-3d6e-75d3-a81e-cba3874b0a55\",\n  \"doingBusinessAs\": \"Rose Gardens Downtown\",\n  \"paypointType\": \"merchant\",\n  \"timezone\": \"America/New_York\"\n}")
  .asString();
```

```php CreatePaypointNewLocation
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api-sandbox.payabli.com/api/v2/paypoints', [
  'body' => '{
  "businessReference": "019fed1a-3d6e-75d3-a81e-cba3874b0a55",
  "doingBusinessAs": "Rose Gardens Downtown",
  "paypointType": "merchant",
  "timezone": "America/New_York"
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp CreatePaypointNewLocation
using RestSharp;

var client = new RestClient("https://api-sandbox.payabli.com/api/v2/paypoints");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"businessReference\": \"019fed1a-3d6e-75d3-a81e-cba3874b0a55\",\n  \"doingBusinessAs\": \"Rose Gardens Downtown\",\n  \"paypointType\": \"merchant\",\n  \"timezone\": \"America/New_York\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift CreatePaypointNewLocation
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "businessReference": "019fed1a-3d6e-75d3-a81e-cba3874b0a55",
  "doingBusinessAs": "Rose Gardens Downtown",
  "paypointType": "merchant",
  "timezone": "America/New_York"
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api-sandbox.payabli.com/api/v2/paypoints")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```

### CreatePaypointInlineBusiness

**Request**

```json
{
  "business": {
    "emails": [
      "ops@example.com"
    ],
    "externalId": "rg-001",
    "legalName": "Rose Gardens LLC",
    "legalStructure": "llc",
    "merchantCatCode": "5814",
    "parentReference": "8cfec329267",
    "phone": [
      "3055551212"
    ],
    "taxReference": "477498993",
    "website": "https://example.com"
  },
  "customerServiceEmail": "support@example.com",
  "customerServicePhone": "3055551212",
  "description": "Boutique flower shop",
  "doingBusinessAs": "Rose Gardens",
  "paypointType": "merchant",
  "timezone": "America/New_York",
  "website": "https://example.com"
}
```

**Response**

```json
{
  "success": true,
  "message": "Paypoint created successfully",
  "traceId": "0HNNN6HH5NDOA:00000001",
  "data": {
    "paypointReference": "019ff064-c690-7679-a73e-688418aadc7c",
    "paypointStatus": "pending",
    "createdAt": "2026-08-11T13:09:48.9047501Z",
    "_links": {
      "self": "/v2/paypoints/019ff064-c690-7679-a73e-688418aadc7c",
      "business": "/v2/businesses/019fed1a-3d6e-75d3-a81e-cba3874b0a55"
    },
    "businessReference": "019fed1a-3d6e-75d3-a81e-cba3874b0a55",
    "doingBusinessAs": "Rose Gardens",
    "timezone": "America/New_York"
  }
}
```

**SDK Code**

```python CreatePaypointInlineBusiness
import requests

url = "https://api-sandbox.payabli.com/api/v2/paypoints"

payload = {
    "business": {
        "emails": ["ops@example.com"],
        "externalId": "rg-001",
        "legalName": "Rose Gardens LLC",
        "legalStructure": "llc",
        "merchantCatCode": "5814",
        "parentReference": "8cfec329267",
        "phone": ["3055551212"],
        "taxReference": "477498993",
        "website": "https://example.com"
    },
    "customerServiceEmail": "support@example.com",
    "customerServicePhone": "3055551212",
    "description": "Boutique flower shop",
    "doingBusinessAs": "Rose Gardens",
    "paypointType": "merchant",
    "timezone": "America/New_York",
    "website": "https://example.com"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript CreatePaypointInlineBusiness
const url = 'https://api-sandbox.payabli.com/api/v2/paypoints';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"business":{"emails":["ops@example.com"],"externalId":"rg-001","legalName":"Rose Gardens LLC","legalStructure":"llc","merchantCatCode":"5814","parentReference":"8cfec329267","phone":["3055551212"],"taxReference":"477498993","website":"https://example.com"},"customerServiceEmail":"support@example.com","customerServicePhone":"3055551212","description":"Boutique flower shop","doingBusinessAs":"Rose Gardens","paypointType":"merchant","timezone":"America/New_York","website":"https://example.com"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go CreatePaypointInlineBusiness
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api-sandbox.payabli.com/api/v2/paypoints"

	payload := strings.NewReader("{\n  \"business\": {\n    \"emails\": [\n      \"ops@example.com\"\n    ],\n    \"externalId\": \"rg-001\",\n    \"legalName\": \"Rose Gardens LLC\",\n    \"legalStructure\": \"llc\",\n    \"merchantCatCode\": \"5814\",\n    \"parentReference\": \"8cfec329267\",\n    \"phone\": [\n      \"3055551212\"\n    ],\n    \"taxReference\": \"477498993\",\n    \"website\": \"https://example.com\"\n  },\n  \"customerServiceEmail\": \"support@example.com\",\n  \"customerServicePhone\": \"3055551212\",\n  \"description\": \"Boutique flower shop\",\n  \"doingBusinessAs\": \"Rose Gardens\",\n  \"paypointType\": \"merchant\",\n  \"timezone\": \"America/New_York\",\n  \"website\": \"https://example.com\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby CreatePaypointInlineBusiness
require 'uri'
require 'net/http'

url = URI("https://api-sandbox.payabli.com/api/v2/paypoints")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"business\": {\n    \"emails\": [\n      \"ops@example.com\"\n    ],\n    \"externalId\": \"rg-001\",\n    \"legalName\": \"Rose Gardens LLC\",\n    \"legalStructure\": \"llc\",\n    \"merchantCatCode\": \"5814\",\n    \"parentReference\": \"8cfec329267\",\n    \"phone\": [\n      \"3055551212\"\n    ],\n    \"taxReference\": \"477498993\",\n    \"website\": \"https://example.com\"\n  },\n  \"customerServiceEmail\": \"support@example.com\",\n  \"customerServicePhone\": \"3055551212\",\n  \"description\": \"Boutique flower shop\",\n  \"doingBusinessAs\": \"Rose Gardens\",\n  \"paypointType\": \"merchant\",\n  \"timezone\": \"America/New_York\",\n  \"website\": \"https://example.com\"\n}"

response = http.request(request)
puts response.read_body
```

```java CreatePaypointInlineBusiness
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api-sandbox.payabli.com/api/v2/paypoints")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"business\": {\n    \"emails\": [\n      \"ops@example.com\"\n    ],\n    \"externalId\": \"rg-001\",\n    \"legalName\": \"Rose Gardens LLC\",\n    \"legalStructure\": \"llc\",\n    \"merchantCatCode\": \"5814\",\n    \"parentReference\": \"8cfec329267\",\n    \"phone\": [\n      \"3055551212\"\n    ],\n    \"taxReference\": \"477498993\",\n    \"website\": \"https://example.com\"\n  },\n  \"customerServiceEmail\": \"support@example.com\",\n  \"customerServicePhone\": \"3055551212\",\n  \"description\": \"Boutique flower shop\",\n  \"doingBusinessAs\": \"Rose Gardens\",\n  \"paypointType\": \"merchant\",\n  \"timezone\": \"America/New_York\",\n  \"website\": \"https://example.com\"\n}")
  .asString();
```

```php CreatePaypointInlineBusiness
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api-sandbox.payabli.com/api/v2/paypoints', [
  'body' => '{
  "business": {
    "emails": [
      "ops@example.com"
    ],
    "externalId": "rg-001",
    "legalName": "Rose Gardens LLC",
    "legalStructure": "llc",
    "merchantCatCode": "5814",
    "parentReference": "8cfec329267",
    "phone": [
      "3055551212"
    ],
    "taxReference": "477498993",
    "website": "https://example.com"
  },
  "customerServiceEmail": "support@example.com",
  "customerServicePhone": "3055551212",
  "description": "Boutique flower shop",
  "doingBusinessAs": "Rose Gardens",
  "paypointType": "merchant",
  "timezone": "America/New_York",
  "website": "https://example.com"
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp CreatePaypointInlineBusiness
using RestSharp;

var client = new RestClient("https://api-sandbox.payabli.com/api/v2/paypoints");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"business\": {\n    \"emails\": [\n      \"ops@example.com\"\n    ],\n    \"externalId\": \"rg-001\",\n    \"legalName\": \"Rose Gardens LLC\",\n    \"legalStructure\": \"llc\",\n    \"merchantCatCode\": \"5814\",\n    \"parentReference\": \"8cfec329267\",\n    \"phone\": [\n      \"3055551212\"\n    ],\n    \"taxReference\": \"477498993\",\n    \"website\": \"https://example.com\"\n  },\n  \"customerServiceEmail\": \"support@example.com\",\n  \"customerServicePhone\": \"3055551212\",\n  \"description\": \"Boutique flower shop\",\n  \"doingBusinessAs\": \"Rose Gardens\",\n  \"paypointType\": \"merchant\",\n  \"timezone\": \"America/New_York\",\n  \"website\": \"https://example.com\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift CreatePaypointInlineBusiness
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "business": [
    "emails": ["ops@example.com"],
    "externalId": "rg-001",
    "legalName": "Rose Gardens LLC",
    "legalStructure": "llc",
    "merchantCatCode": "5814",
    "parentReference": "8cfec329267",
    "phone": ["3055551212"],
    "taxReference": "477498993",
    "website": "https://example.com"
  ],
  "customerServiceEmail": "support@example.com",
  "customerServicePhone": "3055551212",
  "description": "Boutique flower shop",
  "doingBusinessAs": "Rose Gardens",
  "paypointType": "merchant",
  "timezone": "America/New_York",
  "website": "https://example.com"
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api-sandbox.payabli.com/api/v2/paypoints")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```