Strictly / PayWithZero Public API

Payment Links

Endpointhttps://api.paywithzero.net/v1

Download schema

API get list of PaymentLink

GET

https://api.paywithzero.net/v1

/v1/public/202104/payment-link

Returns a paginated list of payment links for the authenticated merchant.

API get list of PaymentLink › query Parameters

page

number

Page number for paginating

limit

number

Limit items per page

API get list of PaymentLink › Headers

authorization

string · required

API get list of PaymentLink › Responses

200

Paginated payment links.

object[]

total

integer

page

integer

limit

integer

Create payment link

POST

https://api.paywithzero.net/v1

/v1/public/202104/payment-link

Create a shareable payment link that allows customers to pay a specific amount.

amount — required.

customValues — optional array of { key, label, value } objects shown on the payment form. Important: All custom value keys must be pre-configured in the merchant setup. Any key not defined in the merchant configuration will result in an error.

taxes — optional array of tax IDs to apply.

showBilling/showShipping — whether to request billing/shipping addresses on the payment form.

attachments — optional file path objects from the /upload-attachments endpoint.

Create payment link › Headers

authorization

string · required

Create payment link › Request Body

amount

number · required

Pay amount

taxes

string[]

Taxes amount or list of taxes

showBilling

boolean

Show Billing

showShipping

boolean

Show Shipping

object[]

custom values data

attachments

string[]

Attachments

applyDiscount

boolean

A discount may be applied to this payment link. If applicable, a discount of {%} will be deducted from credit card payments.

Create payment link › Responses

Payment link created.

No data returned

POST/v1/public/202104/payment-link

curl --request POST \
  --url https://api.paywithzero.net/v1/v1/public/202104/payment-link \
  --header 'Content-Type: application/json' \
  --header 'authorization: <string>' \
  --data '
{
  "amount": 100,
  "taxes": 0,
  "showBilling": true,
  "showShipping": true
}
'

shell

Example Request Body

{
  "amount": 100,
  "taxes": 0,
  "showBilling": true,
  "showShipping": true
}

json

application/json

Example Responses

{
  "id": "694ea6e3fff33e2b60346c57",
  "amount": 100,
  "taxes": 0,
  "totalAmount": 100,
  "paidAmount": 0,
  "surcharge": 0,
  "showBilling": true,
  "showShipping": true,
  "customValues": [],
  "attachments": [],
  "paid": false,
  "paidAt": null,
  "createdBy": "[email protected]",
  "updatedBy": "[email protected]",
  "createdAt": "2025-12-26T15:16:51.987Z",
  "updatedAt": "2025-12-26T15:16:52.167Z",
  "deletedAt": null,
  "paymentLink": "https://merchant.zerospay.com/zpay/payment-request/694ea6e4fff33e2b60346c59",
  "reference": "STR-CYT-251226-22885",
  "applyDiscount": false
}

json

application/json

API view paymentLink by id

GET

https://api.paywithzero.net/v1

/v1/public/202104/payment-link/{id}

Retrieve a single payment link by ID.

API view paymentLink by id › path Parameters

id

string · required

Payment link ID

API view paymentLink by id › Headers

authorization

string · required

API view paymentLink by id › Responses

Payment link returned.

No data returned

GET/v1/public/202104/payment-link/{id}

curl --request GET \
  --url https://api.paywithzero.net/v1/v1/public/202104/payment-link/:id \
  --header 'authorization: <string>'

shell

Example Responses

{
  "data": {
    "id": "694ebfe2fff33e2b6034718d",
    "amount": 3,
    "taxes": 0,
    "totalAmount": 3,
    "paidAmount": 2,
    "surcharge": 0.06,
    "showBilling": true,
    "showShipping": true,
    "customValues": [
      {
        "key": "customer_id",
        "label": "Customer ID",
        "value": "Ramdom123",
        "valueLabel": ""
      },
      {
        "key": "Test1",
        "label": "Test1",
        "value": "Ramdom123",
        "valueLabel": ""
      }
    ],
    "attachments": [],
    "paid": false,
    "paidAt": "2025-12-26T17:04:02.537Z",
    "createdBy": "[email protected]",
    "updatedBy": "online",
    "createdAt": "2025-12-26T17:03:30.057Z",
    "updatedAt": "2025-12-26T17:04:02.599Z",
    "deletedAt": null,
    "paymentLink": "https://merchant.zerospay.com/zpay/payment-request/694ebfe2fff33e2b6034718f",
    "reference": "STR-CYT-251226-22911",
    "applyDiscount": false
  }
}

json

application/json

API delete paymentLink by id

DELETE

https://api.paywithzero.net/v1

/v1/public/202104/payment-link/{id}

Permanently delete a payment link.

API delete paymentLink by id › path Parameters

id

string · required

Payment link ID

API delete paymentLink by id › Headers

authorization

string · required

API delete paymentLink by id › Responses

Payment link deleted.

No data returned

DELETE/v1/public/202104/payment-link/{id}

curl --request DELETE \
  --url https://api.paywithzero.net/v1/v1/public/202104/payment-link/:id \
  --header 'authorization: <string>'

shell

Example Responses

{
  "data": {
    "clientId": "60e856cce2819f4a3cfa4294",
    "order": {
      "currency": "USD",
      "amount": 100,
      "shipping": 0,
      "discount": 0,
      "tax": 0,
      "poNumber": "47498",
      "products": [],
      "customValues": [
        {
          "key": "external-identifier",
          "label": "External Identifier",
          "value": "356",
          "valueLabel": ""
        },
        {
          "key": "location",
          "label": "Location",
          "value": "florida",
          "valueLabel": "Florida"
        }
      ],
      "totalAmount": 100
    },
    "active": false,
    "from": "paymentLink",
    "fromId": "678a673d510ae75f40a1a0fc",
    "showBilling": true,
    "showShipping": true,
    "signedOrder": false,
    "deletedAt": "2025-02-21T02:02:16.298Z",
    "createdBy": "[email protected]",
    "updatedBy": "[email protected]",
    "owner": "[email protected]",
    "ownerGroup": null,
    "attachments": [],
    "createdAt": "2025-01-17T14:20:45.422Z",
    "updatedAt": "2025-02-21T02:02:16.302Z",
    "id": "678a673d510ae75f40a1a0fe"
  }
}

json

application/json

POST

https://api.paywithzero.net/v1

/v1/public/202104/payment-link/send-by-email

Send a payment link to a customer via email. Provide paymentLinkId and email in the request body.

authorization

string · required

email

string · required

Email to send the payment link or Invoice

paymentLinkId

string

PaymentLink Id to send by email

Email sent.

No data returned

POST

https://api.paywithzero.net/v1

/v1/public/202104/payment-link/send-by-sms

Send a payment link to a customer via SMS. Provide paymentLinkId and phoneNumber (any valid US number including area code, e.g. 786 322 0000) in the request body.

authorization

string · required

phoneNumber

string · required

Phone to send the payment link or Invoice

paymentLinkId

string

Payment Link Id

invoiceId

string

Invoice Id

createdBy

string

Name of the user who created the payment link or Invoice

SMS sent.

No data returned

Upload payment link attachments

POST

https://api.paywithzero.net/v1

/v1/public/202104/payment-link/upload-attachments

Upload files to attach to a payment link. Returns file path objects to use in the attachments field when creating a payment link.

File limits: Up to 10 files per request, max 25 MB total size.

Supported formats: JPG, PNG, PDF.

Upload payment link attachments › Request Body

file

string[] · application/octet-stream · required

Upload payment link attachments › Responses

Files uploaded.

message

string

object[]

Payments Payment Links (Deprecated)

Strictly / PayWithZero Public API

Payment Links

Endpointhttps://api.paywithzero.net/v1

Download schema

API get list of PaymentLink

GET

https://api.paywithzero.net/v1

/v1/public/202104/payment-link

Returns a paginated list of payment links for the authenticated merchant.

API get list of PaymentLink › query Parameters

page

number

Page number for paginating

limit

number

Limit items per page

API get list of PaymentLink › Headers

authorization

string · required

API get list of PaymentLink › Responses

200

Paginated payment links.

object[]

total

integer

page

integer

limit

integer

Create payment link

POST

https://api.paywithzero.net/v1

/v1/public/202104/payment-link

Create a shareable payment link that allows customers to pay a specific amount.

amount — required.

taxes — optional array of tax IDs to apply.

showBilling/showShipping — whether to request billing/shipping addresses on the payment form.

attachments — optional file path objects from the /upload-attachments endpoint.

Create payment link › Headers

authorization

string · required

Create payment link › Request Body

amount

number · required

Pay amount

taxes

string[]

Taxes amount or list of taxes

showBilling

boolean

Show Billing

showShipping

boolean

Show Shipping

object[]

custom values data

attachments

string[]

Attachments

applyDiscount

boolean

A discount may be applied to this payment link. If applicable, a discount of {%} will be deducted from credit card payments.

Create payment link › Responses

Payment link created.

No data returned

POST/v1/public/202104/payment-link

curl --request POST \
  --url https://api.paywithzero.net/v1/v1/public/202104/payment-link \
  --header 'Content-Type: application/json' \
  --header 'authorization: <string>' \
  --data '
{
  "amount": 100,
  "taxes": 0,
  "showBilling": true,
  "showShipping": true
}
'

shell

Example Request Body

{
  "amount": 100,
  "taxes": 0,
  "showBilling": true,
  "showShipping": true
}

json

application/json

Example Responses

{
  "id": "694ea6e3fff33e2b60346c57",
  "amount": 100,
  "taxes": 0,
  "totalAmount": 100,
  "paidAmount": 0,
  "surcharge": 0,
  "showBilling": true,
  "showShipping": true,
  "customValues": [],
  "attachments": [],
  "paid": false,
  "paidAt": null,
  "createdBy": "[email protected]",
  "updatedBy": "[email protected]",
  "createdAt": "2025-12-26T15:16:51.987Z",
  "updatedAt": "2025-12-26T15:16:52.167Z",
  "deletedAt": null,
  "paymentLink": "https://merchant.zerospay.com/zpay/payment-request/694ea6e4fff33e2b60346c59",
  "reference": "STR-CYT-251226-22885",
  "applyDiscount": false
}

json

application/json

API view paymentLink by id

GET

https://api.paywithzero.net/v1

/v1/public/202104/payment-link/{id}

Retrieve a single payment link by ID.

API view paymentLink by id › path Parameters

id

string · required

Payment link ID

API view paymentLink by id › Headers

authorization

string · required

API view paymentLink by id › Responses

Payment link returned.

No data returned

GET/v1/public/202104/payment-link/{id}

curl --request GET \
  --url https://api.paywithzero.net/v1/v1/public/202104/payment-link/:id \
  --header 'authorization: <string>'

shell

Example Responses

{
  "data": {
    "id": "694ebfe2fff33e2b6034718d",
    "amount": 3,
    "taxes": 0,
    "totalAmount": 3,
    "paidAmount": 2,
    "surcharge": 0.06,
    "showBilling": true,
    "showShipping": true,
    "customValues": [
      {
        "key": "customer_id",
        "label": "Customer ID",
        "value": "Ramdom123",
        "valueLabel": ""
      },
      {
        "key": "Test1",
        "label": "Test1",
        "value": "Ramdom123",
        "valueLabel": ""
      }
    ],
    "attachments": [],
    "paid": false,
    "paidAt": "2025-12-26T17:04:02.537Z",
    "createdBy": "[email protected]",
    "updatedBy": "online",
    "createdAt": "2025-12-26T17:03:30.057Z",
    "updatedAt": "2025-12-26T17:04:02.599Z",
    "deletedAt": null,
    "paymentLink": "https://merchant.zerospay.com/zpay/payment-request/694ebfe2fff33e2b6034718f",
    "reference": "STR-CYT-251226-22911",
    "applyDiscount": false
  }
}

json

application/json

API delete paymentLink by id

DELETE

https://api.paywithzero.net/v1

/v1/public/202104/payment-link/{id}

Permanently delete a payment link.

API delete paymentLink by id › path Parameters

id

string · required

Payment link ID

API delete paymentLink by id › Headers

authorization

string · required

API delete paymentLink by id › Responses

Payment link deleted.

No data returned

DELETE/v1/public/202104/payment-link/{id}

curl --request DELETE \
  --url https://api.paywithzero.net/v1/v1/public/202104/payment-link/:id \
  --header 'authorization: <string>'

shell

Example Responses

{
  "data": {
    "clientId": "60e856cce2819f4a3cfa4294",
    "order": {
      "currency": "USD",
      "amount": 100,
      "shipping": 0,
      "discount": 0,
      "tax": 0,
      "poNumber": "47498",
      "products": [],
      "customValues": [
        {
          "key": "external-identifier",
          "label": "External Identifier",
          "value": "356",
          "valueLabel": ""
        },
        {
          "key": "location",
          "label": "Location",
          "value": "florida",
          "valueLabel": "Florida"
        }
      ],
      "totalAmount": 100
    },
    "active": false,
    "from": "paymentLink",
    "fromId": "678a673d510ae75f40a1a0fc",
    "showBilling": true,
    "showShipping": true,
    "signedOrder": false,
    "deletedAt": "2025-02-21T02:02:16.298Z",
    "createdBy": "[email protected]",
    "updatedBy": "[email protected]",
    "owner": "[email protected]",
    "ownerGroup": null,
    "attachments": [],
    "createdAt": "2025-01-17T14:20:45.422Z",
    "updatedAt": "2025-02-21T02:02:16.302Z",
    "id": "678a673d510ae75f40a1a0fe"
  }
}

json

application/json

POST

https://api.paywithzero.net/v1

/v1/public/202104/payment-link/send-by-email

Send a payment link to a customer via email. Provide paymentLinkId and email in the request body.

authorization

string · required

email

string · required

Email to send the payment link or Invoice

paymentLinkId

string

PaymentLink Id to send by email

Email sent.

No data returned

POST

https://api.paywithzero.net/v1

/v1/public/202104/payment-link/send-by-sms

Send a payment link to a customer via SMS. Provide paymentLinkId and phoneNumber (any valid US number including area code, e.g. 786 322 0000) in the request body.

authorization

string · required

phoneNumber

string · required

Phone to send the payment link or Invoice

paymentLinkId

string

Payment Link Id

invoiceId

string

Invoice Id

createdBy

string

Name of the user who created the payment link or Invoice

SMS sent.

No data returned

Upload payment link attachments

POST

https://api.paywithzero.net/v1

/v1/public/202104/payment-link/upload-attachments

Upload files to attach to a payment link. Returns file path objects to use in the attachments field when creating a payment link.

File limits: Up to 10 files per request, max 25 MB total size.

Supported formats: JPG, PNG, PDF.

Upload payment link attachments › Request Body

file

string[] · application/octet-stream · required

Upload payment link attachments › Responses

Files uploaded.

message

string

object[]

Payments Payment Links (Deprecated)

Payment Links

API get list of PaymentLink

API get list of PaymentLink › query Parameters

API get list of PaymentLink › Headers

API get list of PaymentLink › Responses

Create payment link

Create payment link › Headers

Create payment link › Request Body

Create payment link › Responses

API view paymentLink by id

API view paymentLink by id › path Parameters

API view paymentLink by id › Headers

API view paymentLink by id › Responses

API delete paymentLink by id

API delete paymentLink by id › path Parameters

API delete paymentLink by id › Headers

API delete paymentLink by id › Responses

Share payment link by email

Share payment link by email › Headers

Share payment link by email › Request Body

Share payment link by email › Responses

Share payment link by SMS

Share payment link by SMS › Headers

Share payment link by SMS › Request Body

Share payment link by SMS › Responses

Upload payment link attachments

Upload payment link attachments › Request Body

Upload payment link attachments › Responses

Payment Links

API get list of PaymentLink

API get list of PaymentLink › query Parameters

API get list of PaymentLink › Headers

API get list of PaymentLink › Responses

Create payment link

Create payment link › Headers

Create payment link › Request Body

Create payment link › Responses

API view paymentLink by id

API view paymentLink by id › path Parameters

API view paymentLink by id › Headers

API view paymentLink by id › Responses

API delete paymentLink by id

API delete paymentLink by id › path Parameters

API delete paymentLink by id › Headers

API delete paymentLink by id › Responses

Share payment link by email

Share payment link by email › Headers

Share payment link by email › Request Body

Share payment link by email › Responses

Share payment link by SMS

Share payment link by SMS › Headers

Share payment link by SMS › Request Body

Share payment link by SMS › Responses

Upload payment link attachments

Upload payment link attachments › Request Body

Upload payment link attachments › Responses