Business API Reference

This is an object representing a business account. A business account can accept payments from customers and pay out to connected bank account.

A business can be a customer, vendor or both.

The Business model

The business model is the nucleus of operations, managing customers, estimates, and invoices.

Properties

Name
id
Type
string
Field Type
Description
Unique identifier for the business.
Name
name
Type
string
Field Type
Description
Name of the business.
Name
email
Type
string
Field Type
Description
Email of the business.
Name
contact_first_name
Type
string
Field Type
Description
First name of the business.
Name
contact_last_name
Type
string
Field Type
Description
Last name of the business.
Name
phone
Type
string
Field Type
Description
Phone number of the business.
Name
website
Type
string
Field Type
Description
Website of the business.
Name
is_customer
Type
boolean
Field Type
Description
Specify whether the given business can make payments and receive invoices as a customer.
Name
is_vendor
Type
boolean
Field Type
Description
Specify whether the given business can receive payments and send invoices as a vendor.
Name
logo_url
Type
string
Field Type
Description
Logo of the business.
Name
business_type
Type
string
Field Type
Description
Type of the business.
Name
created_at
Type
timestamp
Field Type
Description
Timestamp when the business was created.
Name
time_zone
Type
string
Field Type
Description
Timezone of the business.
Name
disabled
Type
boolean
Field Type
Description
Specify whether the given business is disabled.
Name
payouts_enabled
Type
boolean
Field Type
Description
Whether the business is enabled for payouts.
Name
billing_address
Type
object
Field Type
Description
Billing address of the business.
Name
shipping_address
Type
object
Field Type
Description
Shipping address of the business.
Name
creator_id
Type
string
Field Type
Description
ID of the user who created the business.

GETapi/v1/businesses

Get business stats

This endpoint allows you to get business stats.

Parameters

Name
type
Type
string
Field Type
required
Description
The type of stats to retrieve. (must be one of: total_purchases, invoice_count, estimate_count, customer_count, vendor_count, total_sales, total_amount_due, total_payments, total_receipts)

Request

GET

api/v1/business/stats

curl --request GET \
  "https://payments.your-domain.com/api/v1/business/stats" \
  --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
  --header "Content-Type: application/json" \
  --header "Accept: application/json" \
  --header "Business: 995c98ce-cdd9-4ef6-b018-9c696cb07e9d" \
  --data "{
    \"type\": \"invoice_count\"
  }"

Response

{
  "invoice_count": 8
}

The PaymentOnboardingLink model

Once generated, businesses need to visit the Payment Onboarding Link to set up their payment processes. During this visit, they can provide essential payout details, including information about their bank, enabling a seamless integration for receiving payments.

Properties

Name
id
Type
string
Field Type
Description
Unique identifier for the payment onboarding link.
Name
url
Type
string
Field Type
Description
The URL to redirect the business to after they have completed the onboarding process.
Name
return_url
Type
string
Field Type
Description
The URL to redirect after the business has completed the onboarding process.
Name
refresh_url
Type
string
Field Type
Description
The URL the user will be redirected to if the account link is expired, has been previously-visited, or is otherwise invalid. The URL you specify should attempt to generate a new onboarding link with the same parameters used to create the original account link, then redirect the user to the new account link’s URL so they can continue with Onboarding. If a new link cannot be generated or the redirect fails you should display a useful error to the user.
Name
business_id
Type
object
Field Type
Description
The ID of the business associated with the payment onboarding link.

GETapi/v1/payment-onboarding-links

List all payment onboarding links

This endpoint allows you to retrieve a paginated list of all your payment onboarding links.

Query Parameters

Name
limit
Type
integer
Field Type
optional
Description
Limit the number of onboarding links returned. (default is 5)
Name
page
Type
integer
Field Type
optional
Description
Page number for pagination. (default is 1)

Request

GET

api/v1/payment-onboarding-links

curl --request GET \
  --get "https://payments.your-domain.com/api/v1/payment-onboarding-links" \
  --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
  --header "Content-Type: application/json" \
  --header "Accept: application/json" \
  --header "Business: 995c98ce-cdd9-4ef6-b018-9c696cb07e9d" \

Response

{
  "data": [
    {
      "id": "9988df6b-a4ef-4678-b039-06a8a8337ccf",
      "url": "http://payments.your-domain.com/public/onboarding/9988df6b-a4ef-4678-b039-06a8a8337ccf?
        signature=0e3e3bf17128d83fbf6676aa9c4b916e4364179b651682f319e5a638220d73bf",
      "return_url": "http://payments.your-domain.com/return",
      "refresh_url": "http://payments.your-domain.com/dashboard",
      "business_id": "995c98ce-cdd9-4ef6-b018-9c696cb07e9d"
    },
    {
      "id": "9988de81-f5f3-476b-af77-0a0cfae3ded8",
      "url": "http://payments.your-domain.com/public/onboarding/9988de81-f5f3-476b-af77-0a0cfae3ded8?
        signature=2d8b35ec511bb059dd532d9fa7bce80f9f9fed9dbb6040e55aa9b003292f3438",
      "return_url": "http://payments.your-domain.com/return",
      "refresh_url": "http://payments.your-domain.com/dashboard",
      "business_id": "995c98ce-cdd9-4ef6-b018-9c696cb07e9d"
    }
  ]
}

POSTapi/v1/payment-onboarding-links

Create a payment onboarding link

This endpoint allows you to create a new payment onboarding link.

Body Parameters

Name
return_url
Type
string
Field Type
required
Description
The URL to redirect after the business has completed the onboarding process.
Name
refresh_url
Type
string
Field Type
optional
Description
The URL the user will be redirected to if the account link is expired, has been previously-visited, or is otherwise invalid. The URL you specify should attempt to generate a new onboarding link with the same parameters used to create the original account link, then redirect the user to the new account link’s URL so they can continue with Onboarding. If a new link cannot be generated or the redirect fails you should display a useful error to the user.

Request

POST

api/v1/payment-onboarding-links

curl --request POST \
  "https://payments.your-domain.com/api/v1/payment-onboarding-links" \
  --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
  --header "Content-Type: application/json" \
  --header "Accept: application/json" \
  --header "Business: 995c98ce-cdd9-4ef6-b018-9c696cb07e9d" \
  --data "{
    \"return_url\": \"http://payments.your-domain.com/dashboard\",
    \"refresh_url\": \"http://payments.your-domain.com/refresh\"
  }"

Response

{
  "data": {
    "id": "9988df6b-a4ef-4678-b039-06a8a8337ccf",
    "url": "http://payments.your-domain.com/public/onboarding/9988df6b-a4ef-4678-b039-06a8a8337ccf?
      signature=cf673747acb059a6357bd8ad4cc4ffb49f6b23344624ec36cbe4f64f5bad9fb5",
    "return_url": "http://payments.your-domain.com/dashboard",
    "refresh_url": "http://payments.your-domain.com/refresh",
    "business_id": "995c98ce-cdd9-4ef6-b018-9c696cb07e9d"
  }
}

GETapi/v1/payment-onboarding-links/{id}

Retrieve an payment onboarding link

This endpoint allows you to retrieve an onboarding link.

URL Parameters

Name
id
Type
string
Field Type
required
Description
ID of the onboarding link.

Request

GET

api/v1/payment-onboarding-links/{id}

curl --request GET \
  --get "https://payments.your-domain.com/api/v1/payment-onboarding-links/9988df6b-a4ef-4678-b039-06a8a8337ccf" \
  --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
  --header "Content-Type: application/json" \
  --header "Accept: application/json" \
  --header "Business: 995c98ce-cdd9-4ef6-b018-9c696cb07e9d" \

Response

{
  "data": {
    "id": "9988df6b-a4ef-4678-b039-06a8a8337ccf",
    "url": "http://payments.your-domain.com/public/onboarding/9988df6b-a4ef-4678-b039-06a8a8337ccf?
      signature=cf673747acb059a6357bd8ad4cc4ffb49f6b23344624ec36cbe4f64f5bad9fb5",
    "return_url": "http://payments.your-domain.com/dashboard",
    "refresh_url": "http://payments.your-domain.com/refresh",
    "business_id": "995c98ce-cdd9-4ef6-b018-9c696cb07e9d"
  }
}

DELETEapi/v1/payment-onboarding-links/{id}

Delete an payment onboarding link

This endpoint allows you to delete a specific onboarding link.

URL Parameters

Name
id
Type
string
Field Type
required
Description
The ID of the onboarding link.

Request

DELETE

api/v1/payment-onboarding-links/{id}

curl --request DELETE \
  "https://payments.your-domain.com/api/v1/payment-onboarding-links/9988df6b-a4ef-4678-b039-06a8a8337ccf" \
  --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
  --header "Content-Type: application/json" \
  --header "Accept: application/json" \
  --header "Business: 995c98ce-cdd9-4ef6-b018-9c696cb07e9d" \

Response

{
  "id": "9988df6b-a4ef-4678-b039-06a8a8337ccf",
  "object": "PaymentOnboardingLink",
  "deleted": true
}