Strictly / PayWithZero Public API

Payment Requests

Endpointhttps://api.paywithzero.net/v1

Download schema

API get list of paymentRequest

GET

https://api.paywithzero.net/v1

/v1/public/payment-request

Returns a paginated list of payment requests.

API get list of paymentRequest › query Parameters

limit

integer · min: 1 · max: 100

Default: 25

page

integer · min: 1

Default: 1

API get list of paymentRequest › Headers

authorization

string · required

API get list of paymentRequest › Responses

200

Paginated payment requests.

No data returned

GET/v1/public/payment-request

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

shell

Example Responses

{
  "meta": {
    "count": 3,
    "totalPages": 1,
    "page": 1,
    "limit": 10
  },
  "data": [
    {
      "id": "639a094749aa3d51cf39be77",
      "order": {
        "currency": "USD",
        "shipping": 0,
        "discount": 0,
        "tax": 0.1,
        "products": [],
        "customValues": [],
        "amount": 0.02,
        "poNumber": "235"
      },
      "showBilling": false,
      "showShipping": false,
      "createdBy": "[email protected]",
      "updatedBy": "[email protected]",
      "createdAt": "2022-12-14T17:35:03.994Z",
      "updatedAt": "2022-12-14T17:35:03.994Z",
      "deletedAt": null
    },
    {
      "id": "639a99721db388674bf6ab73",
      "order": {
        "currency": "USD",
        "shipping": 0,
        "discount": 0,
        "tax": 0.1,
        "products": [],
        "customValues": [],
        "amount": 0.02,
        "poNumber": "235"
      },
      "showBilling": false,
      "showShipping": false,
      "createdBy": "[email protected]",
      "updatedBy": "[email protected]",
      "createdAt": "2022-12-15T03:50:10.735Z",
      "updatedAt": "2022-12-15T03:50:10.735Z",
      "deletedAt": null
    },
    {
      "id": "639a9b671db388674bf6ab75",
      "order": {
        "currency": "USD",
        "shipping": 0,
        "discount": 0,
        "tax": 0.1,
        "products": [],
        "customValues": [],
        "amount": 2,
        "poNumber": "235"
      },
      "showBilling": false,
      "showShipping": false,
      "createdBy": "[email protected]",
      "updatedBy": null,
      "createdAt": "2022-12-15T03:58:31.022Z",
      "updatedAt": "2022-12-15T13:58:13.061Z",
      "deletedAt": null
    }
  ]
}

json

application/json

API create paymentRequest

POST

https://api.paywithzero.net/v1

/v1/public/payment-request

Create a new payment request with billing info and optional product line items.

API create paymentRequest › Headers

authorization

string · required

API create paymentRequest › Request Body

clientId

string · required

Client owned paymentRequest

amount

number · required

Order amount

object · required

showBilling

boolean

If Billing Address must show in Single Payment Page

showShipping

boolean

If Shipping Address must show in Single Payment Page

customerId

string

Customer identifier

currency

string

Currency

orderId

string

Order identifier

orderDescription

string

Order descriptions

shipping

number

Order shipping

tax

number

Order taxes

poNumber

string

Order PO Number

object

API create paymentRequest › Responses

Payment request created.

No data returned

POST/v1/public/payment-request

curl --request POST \
  --url https://api.paywithzero.net/v1/v1/public/payment-request \
  --header 'Content-Type: application/json' \
  --header 'authorization: <string>' \
  --data '
{
  "tax": 10,
  "shipping": 10,
  "amount": 200,
  "poNumber": "235",
  "customValues": [],
  "currency": "USD",
  "showBilling": false,
  "showShipping": false
}
'

shell

Example Request Body

{
  "tax": 10,
  "shipping": 10,
  "amount": 200,
  "poNumber": "235",
  "customValues": [],
  "currency": "USD",
  "showBilling": false,
  "showShipping": false
}

json

application/json

Example Responses

{
  "id": "639b3751881451001df993bb",
  "order": {
    "currency": "USD",
    "shipping": 0,
    "discount": 0,
    "tax": 0.1,
    "amount": 2,
    "poNumber": "235",
    "customValues": [],
    "products": []
  },
  "showBilling": false,
  "showShipping": false,
  "createdBy": "[email protected]",
  "updatedBy": "[email protected]",
  "createdAt": "2022-12-15T15:03:45.481Z",
  "updatedAt": "2022-12-15T15:03:45.481Z",
  "deletedAt": null
}

json

application/json

API view paymentRequest by id

GET

https://api.paywithzero.net/v1

/v1/public/payment-request/{id}

Retrieve a single payment request by ID.

API view paymentRequest by id › path Parameters

id

string · required

Payment request ID

API view paymentRequest by id › Headers

authorization

string · required

API view paymentRequest by id › Responses

Payment request returned.

No data returned

Delete a Payment request by ID

DELETE

https://api.paywithzero.net/v1

/v1/public/payment-request/{id}

Permanently delete a payment request.

Delete a Payment request by ID › path Parameters

id

string · required

Payment request ID

Delete a Payment request by ID › Headers

authorization

string · required

Delete a Payment request by ID › Responses

Payment request deleted.

success

boolean

Payment Links (Deprecated)Plans

Strictly / PayWithZero Public API

Payment Requests

Endpointhttps://api.paywithzero.net/v1

Download schema

API get list of paymentRequest

GET

https://api.paywithzero.net/v1

/v1/public/payment-request

Returns a paginated list of payment requests.

API get list of paymentRequest › query Parameters

limit

integer · min: 1 · max: 100

Default: 25

page

integer · min: 1

Default: 1

API get list of paymentRequest › Headers

authorization

string · required

API get list of paymentRequest › Responses

200

Paginated payment requests.

No data returned

GET/v1/public/payment-request

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

shell

Example Responses

{
  "meta": {
    "count": 3,
    "totalPages": 1,
    "page": 1,
    "limit": 10
  },
  "data": [
    {
      "id": "639a094749aa3d51cf39be77",
      "order": {
        "currency": "USD",
        "shipping": 0,
        "discount": 0,
        "tax": 0.1,
        "products": [],
        "customValues": [],
        "amount": 0.02,
        "poNumber": "235"
      },
      "showBilling": false,
      "showShipping": false,
      "createdBy": "[email protected]",
      "updatedBy": "[email protected]",
      "createdAt": "2022-12-14T17:35:03.994Z",
      "updatedAt": "2022-12-14T17:35:03.994Z",
      "deletedAt": null
    },
    {
      "id": "639a99721db388674bf6ab73",
      "order": {
        "currency": "USD",
        "shipping": 0,
        "discount": 0,
        "tax": 0.1,
        "products": [],
        "customValues": [],
        "amount": 0.02,
        "poNumber": "235"
      },
      "showBilling": false,
      "showShipping": false,
      "createdBy": "[email protected]",
      "updatedBy": "[email protected]",
      "createdAt": "2022-12-15T03:50:10.735Z",
      "updatedAt": "2022-12-15T03:50:10.735Z",
      "deletedAt": null
    },
    {
      "id": "639a9b671db388674bf6ab75",
      "order": {
        "currency": "USD",
        "shipping": 0,
        "discount": 0,
        "tax": 0.1,
        "products": [],
        "customValues": [],
        "amount": 2,
        "poNumber": "235"
      },
      "showBilling": false,
      "showShipping": false,
      "createdBy": "[email protected]",
      "updatedBy": null,
      "createdAt": "2022-12-15T03:58:31.022Z",
      "updatedAt": "2022-12-15T13:58:13.061Z",
      "deletedAt": null
    }
  ]
}

json

application/json

API create paymentRequest

POST

https://api.paywithzero.net/v1

/v1/public/payment-request

Create a new payment request with billing info and optional product line items.

API create paymentRequest › Headers

authorization

string · required

API create paymentRequest › Request Body

clientId

string · required

Client owned paymentRequest

amount

number · required

Order amount

object · required

showBilling

boolean

If Billing Address must show in Single Payment Page

showShipping

boolean

If Shipping Address must show in Single Payment Page

customerId

string

Customer identifier

currency

string

Currency

orderId

string

Order identifier

orderDescription

string

Order descriptions

shipping

number

Order shipping

tax

number

Order taxes

poNumber

string

Order PO Number

object

API create paymentRequest › Responses

Payment request created.

No data returned

POST/v1/public/payment-request

curl --request POST \
  --url https://api.paywithzero.net/v1/v1/public/payment-request \
  --header 'Content-Type: application/json' \
  --header 'authorization: <string>' \
  --data '
{
  "tax": 10,
  "shipping": 10,
  "amount": 200,
  "poNumber": "235",
  "customValues": [],
  "currency": "USD",
  "showBilling": false,
  "showShipping": false
}
'

shell

Example Request Body

{
  "tax": 10,
  "shipping": 10,
  "amount": 200,
  "poNumber": "235",
  "customValues": [],
  "currency": "USD",
  "showBilling": false,
  "showShipping": false
}

json

application/json

Example Responses

{
  "id": "639b3751881451001df993bb",
  "order": {
    "currency": "USD",
    "shipping": 0,
    "discount": 0,
    "tax": 0.1,
    "amount": 2,
    "poNumber": "235",
    "customValues": [],
    "products": []
  },
  "showBilling": false,
  "showShipping": false,
  "createdBy": "[email protected]",
  "updatedBy": "[email protected]",
  "createdAt": "2022-12-15T15:03:45.481Z",
  "updatedAt": "2022-12-15T15:03:45.481Z",
  "deletedAt": null
}

json

application/json

API view paymentRequest by id

GET

https://api.paywithzero.net/v1

/v1/public/payment-request/{id}

Retrieve a single payment request by ID.

API view paymentRequest by id › path Parameters

id

string · required

Payment request ID

API view paymentRequest by id › Headers

authorization

string · required

API view paymentRequest by id › Responses

Payment request returned.

No data returned

Delete a Payment request by ID

DELETE

https://api.paywithzero.net/v1

/v1/public/payment-request/{id}

Permanently delete a payment request.

Delete a Payment request by ID › path Parameters

id

string · required

Payment request ID

Delete a Payment request by ID › Headers

authorization

string · required

Delete a Payment request by ID › Responses

Payment request deleted.

success

boolean

Payment Links (Deprecated)Plans