Strictly Public API

Payment Links (Deprecated)

Endpointhttps://api.paywithzero.net/v1

deprecated

API get list of PaymentLink

GET

https://api.paywithzero.net/v1

/public/payment-link

DEPRECATED — use GET /public/202104/payment-link instead. Returns paginated payment links as { meta: { count, totalPages, page, limit }, data: [...] }. Money fields in this deprecated list are in dollars.

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

key-hash

string · required

Security key hash issued to your integration (merchant dashboard: Administration → Security Keys).

API get list of PaymentLink › Responses

Paginated payment links (deprecated format). Money fields in dollars.

No data returned

GET/public/payment-link

curl --request GET \
  --url https://api.paywithzero.net/v1/public/payment-link \
  --header 'key-hash: YOUR_KEY_HASH'

shell

Example Responses

{
  "meta": {
    "count": 1,
    "totalPages": 1,
    "page": 1,
    "limit": 10
  },
  "data": [
    {
      "id": "694e771e9d17e6d8e640a52b",
      "amount": 1,
      "taxes": 0.06,
      "totalAmount": 1.06,
      "paidAmount": 0,
      "surcharge": 0,
      "showBilling": true,
      "showShipping": true,
      "customValues": [
        {
          "key": "customer_id",
          "label": "Customer ID",
          "value": "COD-123",
          "valueLabel": ""
        }
      ],
      "paid": false,
      "paidAt": null,
      "createdBy": "email",
      "updatedBy": "email",
      "createdAt": "2025-12-26T11:53:02.709Z",
      "updatedAt": "2025-12-26T11:53:03.434Z",
      "deletedAt": null,
      "paymentLink": "https://merchant.zerospay.com/zpay/payment-request/694e771f9d17e6d8e640a52e",
      "applyDiscount": false
    }
  ]
}

json

application/json

deprecated

Create payment link

POST

https://api.paywithzero.net/v1

/public/payment-link

DEPRECATED — use POST /public/202104/payment-link instead. customValues keys must be pre-configured in the merchant setup. Optionally include showBilling, showShipping, taxes (array of tax ids), and attachments (objects returned by /upload-attachments).

Money units on this deprecated endpoint: amount is an integer number of whole dollars; response money fields are in dollars. In the response, taxes is the computed tax amount (the selected taxes are listed in selectedTaxes).

Create payment link › Headers

key-hash

string · required

Security key hash issued to your integration (merchant dashboard: Administration → Security Keys).

Create payment link › Request Body

amount

number · required

Integer amount in cents (1000 = $10.00). Note: the deprecated POST /public/payment-link endpoint interprets this value as whole dollars instead.

Example: 1000

taxes

string[]

List of tax ids to apply (send [] when none). In responses, taxes is the computed tax amount, not this list.

Example: ["653bd6ffbefb29d425276854"]

showBilling

boolean

Show Billing

showShipping

boolean

Show Shipping

object[]

custom values data

object[]

Objects returned by POST .../upload-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 (deprecated format).

No data returned

POST/public/payment-link

curl --request POST \
  --url https://api.paywithzero.net/v1/public/payment-link \
  --header 'Content-Type: application/json' \
  --header 'key-hash: YOUR_KEY_HASH' \
  --data '
{
  "amount": 1,
  "customValues": [
    {
      "key": "customer_id",
      "label": "Customer ID",
      "value": "COD-123"
    }
  ],
  "showBilling": true,
  "showShipping": true,
  "taxes": [
    "653bd6ffbefb29d425276854"
  ]
}
'

shell

Example Request Body

{
  "amount": 1,
  "customValues": [
    {
      "key": "customer_id",
      "label": "Customer ID",
      "value": "COD-123"
    }
  ],
  "showBilling": true,
  "showShipping": true,
  "taxes": [
    "653bd6ffbefb29d425276854"
  ]
}

json

application/json

Example Responses

{
  "amount": 1,
  "taxes": 6,
  "selectedTaxes": [
    {
      "id": "653bd6ffbefb29d425276854",
      "clientId": "653a665504639e469f99096b",
      "taxName": "Washington",
      "percentage": 6,
      "_id": "694e771e9d17e6d8e640a52c"
    }
  ],
  "totalAmount": 1.06,
  "paid": false,
  "reference": "STR-CYT-251226-22877",
  "paidAmount": 0,
  "surcharge": 0,
  "discount": 0,
  "paymentMethod": null,
  "paidAt": null,
  "applyDiscount": false,
  "clientId": "653a665504639e469f99096b",
  "clientName": "Coders Strictly Tests",
  "status": "unpaid",
  "showBilling": true,
  "showShipping": true,
  "customValues": [
    {
      "key": "customer_id",
      "label": "Customer ID",
      "value": "COD-123",
      "valueLabel": ""
    }
  ],
  "createdBy": "email",
  "updatedBy": "email",
  "activity": [
    {
      "code": "Payment Link Created",
      "description": "Payment Link was created by username.",
      "date": "2025-12-26T11:53:02.705Z"
    }
  ],
  "sharedWith": [],
  "deletedAt": null,
  "payments": [],
  "attachments": [],
  "createdAt": "2025-12-26T11:53:02.709Z",
  "updatedAt": "2025-12-26T11:53:03.434Z",
  "paymentLink": ".zerospay.com/zpay/payment-request/694e771f9d17e6d8e640a52e",
  "paymentRequestId": "694e771f9d17e6d8e640a52e",
  "id": "694e771e9d17e6d8e640a52b"
}

json

application/json

deprecated

API view paymentLink by id

GET

https://api.paywithzero.net/v1

/public/payment-link/{id}

DEPRECATED — use GET /public/202104/payment-link/:id instead.

API view paymentLink by id › path Parameters

id

string · required

Payment link ID

API view paymentLink by id › Headers

key-hash

string · required

Security key hash issued to your integration (merchant dashboard: Administration → Security Keys).

API view paymentLink by id › Responses

Payment link returned.

No data returned

GET/public/payment-link/{id}

curl --request GET \
  --url https://api.paywithzero.net/v1/public/payment-link/:id \
  --header 'key-hash: YOUR_KEY_HASH'

shell

Example Responses

{
  "data": {
    "amount": 3,
    "taxes": 0,
    "totalAmount": 3,
    "paid": false,
    "reference": "STR-CYT-251226-22911",
    "paidAmount": 2,
    "surcharge": 0.06,
    "discount": 0,
    "paymentMethod": {
      "billingAddress": null,
      "last4": "9586",
      "paymentToken": "EXAMPLE",
      "type": "CARD",
      "metadata": {
        "ipAddress": "203.0.113.10",
        "loginDate": "2025-12-26T17:03:33.167Z",
        "submitDate": "2025-12-26T17:03:57.282Z",
        "user": "[email protected]"
      },
      "zipCode": "12656",
      "exp": "1229",
      "name": "John Doe",
      "cardType": "credit",
      "network": "mastercard",
      "brand": "mastercard",
      "number": "222300******9586",
      "bin": "22230000",
      "isSurchargeEligible": null,
      "isZipCodeEligible": null
    },
    "paidAt": "2025-12-26T17:04:02.537Z",
    "applyDiscount": false,
    "status": "partially-paid",
    "showBilling": true,
    "showShipping": true,
    "customValues": [
      {
        "key": "customer_id",
        "label": "Customer ID",
        "value": "Ramdom123",
        "valueLabel": ""
      },
      {
        "key": "Test1",
        "label": "Test1",
        "value": "Ramdom123",
        "valueLabel": ""
      }
    ],
    "createdBy": "[email protected]",
    "updatedBy": "online",
    "activity": [
      {
        "code": "Payment Link Created",
        "description": "Payment Link was created by Automated Testing User.",
        "date": "2025-12-26T17:03:30.056Z"
      },
      {
        "code": "Payment Link Shared",
        "description": "Payment Link was shared via copied Link.",
        "date": "2025-12-26T17:03:30.663Z"
      },
      {
        "code": "Payment Received",
        "description": "A payment for $2.00 was received using a Mastercard ending in 9586.\n                            Transaction ID: 1226170358.",
        "date": "2025-12-26T17:04:02.554Z"
      }
    ],
    "sharedWith": [],
    "deletedAt": null,
    "selectedTaxes": [],
    "payments": [
      {
        "type": "sale",
        "amountRefunded": 0,
        "paymentId": "694ec0027db6ff99147df7fe",
        "paidAmount": 200,
        "paidSurcharge": 6,
        "paidAt": "2025-12-26T17:04:02.537Z",
        "cardInfo": null,
        "paymentMethod": {
          "billingAddress": null,
          "last4": "9586",
          "paymentToken": "EXAMPLE",
          "type": "CARD",
          "metadata": {
            "ipAddress": "203.0.113.10",
            "loginDate": "2025-12-26T17:03:33.167Z",
            "submitDate": "2025-12-26T17:03:57.282Z",
            "user": "[email protected]"
          },
          "zipCode": "12656",
          "exp": "1229",
          "name": "John Doe",
          "cardType": "credit",
          "network": "mastercard",
          "brand": "mastercard",
          "number": "222300******9586",
          "bin": "22230000",
          "isSurchargeEligible": null,
          "isZipCodeEligible": null
        },
        "transactionId": "1226170358"
      }
    ],
    "attachments": [],
    "createdAt": "2025-12-26T17:03:30.057Z",
    "updatedAt": "2025-12-26T17:04:02.599Z",
    "paymentLink": "https://merchant.zerospay.com/zpay/payment-request/694ebfe2fff33e2b6034718f",
    "cardInfo": {
      "paymentToken": "",
      "customerVaultId": "",
      "token": "",
      "last4": "",
      "billingAddress": null,
      "zipCode": "",
      "exp": "",
      "name": "",
      "type": "",
      "network": "",
      "brand": "",
      "number": ""
    },
    "cardPrice": 0,
    "cardTaxes": 0,
    "cashPrice": 0,
    "cashTaxes": 0,
    "totalCardAmount": 0,
    "totalCashAmount": 0,
    "paymentId": "694ec0027db6ff99147df7fe",
    "transactionId": "1226170358",
    "id": "694ebfe2fff33e2b6034718d"
  }
}

json

application/json

deprecated

API delete paymentLink by id

DELETE

https://api.paywithzero.net/v1

/public/payment-link/{id}

DEPRECATED — use DELETE /public/202104/payment-link/:id instead. The response is the raw underlying payment-request document (order, active: false, deletedAt, ...), not the public payment-link shape.

API delete paymentLink by id › path Parameters

id

string · required

Payment link ID

API delete paymentLink by id › Headers

key-hash

string · required

Security key hash issued to your integration (merchant dashboard: Administration → Security Keys).

API delete paymentLink by id › Responses

Payment link deleted. Returns the raw payment-request document.

No data returned

DELETE/public/payment-link/{id}

curl --request DELETE \
  --url https://api.paywithzero.net/v1/public/payment-link/:id \
  --header 'key-hash: YOUR_KEY_HASH'

shell

Example Responses

{
  "data": {
    "clientId": "60e856cce2819f4a3cfa4294",
    "order": {
      "currency": "USD",
      "amount": 100,
      "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-21T01:59:21.305Z",
    "createdBy": "EXAMPLE",
    "updatedBy": "EXAMPLE",
    "owner": "EXAMPLE",
    "ownerGroup": null,
    "attachments": [],
    "createdAt": "2025-01-17T14:20:45.422Z",
    "updatedAt": "2025-02-21T01:59:21.309Z",
    "id": "678a673d510ae75f40a1a0fe"
  }
}

json

application/json

deprecated

API send the payment link by email

POST

https://api.paywithzero.net/v1

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

DEPRECATED — use POST /public/202104/payment-link/send-by-email instead.

API send the payment link by email › Headers

key-hash

string · required

Security key hash issued to your integration (merchant dashboard: Administration → Security Keys).

API send the payment link by email › Request Body

email

string

paymentLinkId

string

API send the payment link by email › Responses

Email sent.

No data returned

deprecated

API send the payment link by sms

POST

https://api.paywithzero.net/v1

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

DEPRECATED — use POST /public/202104/payment-link/send-by-sms instead.

Phone format: ^[+]?[(]?[0-9]{3}[)]?[ ]?[0-9]{3}[-]?[0-9]{4}$ — e.g. (555) 555-5555 or 5555555555; 555-555-5555 is rejected.

API send the payment link by sms › Headers

key-hash

string · required

Security key hash issued to your integration (merchant dashboard: Administration → Security Keys).

API send the payment link by sms › Request Body

phoneNumber

string

paymentLinkId

string

API send the payment link by sms › Responses

SMS sent.

No data returned

deprecated

Upload payment link attachments

POST

https://api.paywithzero.net/v1

/public/payment-link/upload-attachments

DEPRECATED — use POST /public/202104/payment-link/upload-attachments instead. Upload files to attach to a payment link. Up to 10 files per request, max 25 MB total. Supported: JPG, PNG, PDF.

Upload payment link attachments › Headers

key-hash

string · required

Security key hash issued to your integration (merchant dashboard: Administration → Security Keys).

Upload payment link attachments › Request Body

attachments

string[] · application/octet-stream · required

Multipart field name: attachments

Upload payment link attachments › Responses

Files uploaded.

No data returned

POST/public/payment-link/upload-attachments

curl --request POST \
  --url https://api.paywithzero.net/v1/public/payment-link/upload-attachments \
  --header 'Content-Type: multipart/form-data' \
  --header 'key-hash: YOUR_KEY_HASH' \
  --form attachments=string

shell

Example Request Body

{
  "attachments": [
    "string"
  ]
}

json

Example Responses

{
  "message": "Files uploaded successfully",
  "files": [
    {
      "path": "attachments/60d3a4008ff956001d85da21/payment-links/1747242200901_Secure_Payment.pdf",
      "fullPath": "https://storage.googleapis.com/zero-prod-out-of-scope-files/attachments/60d3a4008ff956001d85da21/payment-links/1747242200901_Secure_Payment.pdf",
      "originalName": "Secure Payment.pdf",
      "sizeInMB": 0.17
    }
  ]
}

json

application/json

Payment Links Terminal

Strictly Public API

Payment Links (Deprecated)

Endpointhttps://api.paywithzero.net/v1

Download schema

deprecated

API get list of PaymentLink

GET

https://api.paywithzero.net/v1

/public/payment-link

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

key-hash

string · required

Security key hash issued to your integration (merchant dashboard: Administration → Security Keys).

API get list of PaymentLink › Responses

Paginated payment links (deprecated format). Money fields in dollars.

No data returned

GET/public/payment-link

curl --request GET \
  --url https://api.paywithzero.net/v1/public/payment-link \
  --header 'key-hash: YOUR_KEY_HASH'

shell

Example Responses

{
  "meta": {
    "count": 1,
    "totalPages": 1,
    "page": 1,
    "limit": 10
  },
  "data": [
    {
      "id": "694e771e9d17e6d8e640a52b",
      "amount": 1,
      "taxes": 0.06,
      "totalAmount": 1.06,
      "paidAmount": 0,
      "surcharge": 0,
      "showBilling": true,
      "showShipping": true,
      "customValues": [
        {
          "key": "customer_id",
          "label": "Customer ID",
          "value": "COD-123",
          "valueLabel": ""
        }
      ],
      "paid": false,
      "paidAt": null,
      "createdBy": "email",
      "updatedBy": "email",
      "createdAt": "2025-12-26T11:53:02.709Z",
      "updatedAt": "2025-12-26T11:53:03.434Z",
      "deletedAt": null,
      "paymentLink": "https://merchant.zerospay.com/zpay/payment-request/694e771f9d17e6d8e640a52e",
      "applyDiscount": false
    }
  ]
}

json

application/json

deprecated

Create payment link

POST

https://api.paywithzero.net/v1

/public/payment-link

Create payment link › Headers

key-hash

string · required

Security key hash issued to your integration (merchant dashboard: Administration → Security Keys).

Create payment link › Request Body

amount

number · required

Integer amount in cents (1000 = $10.00). Note: the deprecated POST /public/payment-link endpoint interprets this value as whole dollars instead.

Example: 1000

taxes

string[]

List of tax ids to apply (send [] when none). In responses, taxes is the computed tax amount, not this list.

Example: ["653bd6ffbefb29d425276854"]

showBilling

boolean

Show Billing

showShipping

boolean

Show Shipping

object[]

custom values data

object[]

Objects returned by POST .../upload-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 (deprecated format).

No data returned

POST/public/payment-link

curl --request POST \
  --url https://api.paywithzero.net/v1/public/payment-link \
  --header 'Content-Type: application/json' \
  --header 'key-hash: YOUR_KEY_HASH' \
  --data '
{
  "amount": 1,
  "customValues": [
    {
      "key": "customer_id",
      "label": "Customer ID",
      "value": "COD-123"
    }
  ],
  "showBilling": true,
  "showShipping": true,
  "taxes": [
    "653bd6ffbefb29d425276854"
  ]
}
'

shell

Example Request Body

{
  "amount": 1,
  "customValues": [
    {
      "key": "customer_id",
      "label": "Customer ID",
      "value": "COD-123"
    }
  ],
  "showBilling": true,
  "showShipping": true,
  "taxes": [
    "653bd6ffbefb29d425276854"
  ]
}

json

application/json

Example Responses

{
  "amount": 1,
  "taxes": 6,
  "selectedTaxes": [
    {
      "id": "653bd6ffbefb29d425276854",
      "clientId": "653a665504639e469f99096b",
      "taxName": "Washington",
      "percentage": 6,
      "_id": "694e771e9d17e6d8e640a52c"
    }
  ],
  "totalAmount": 1.06,
  "paid": false,
  "reference": "STR-CYT-251226-22877",
  "paidAmount": 0,
  "surcharge": 0,
  "discount": 0,
  "paymentMethod": null,
  "paidAt": null,
  "applyDiscount": false,
  "clientId": "653a665504639e469f99096b",
  "clientName": "Coders Strictly Tests",
  "status": "unpaid",
  "showBilling": true,
  "showShipping": true,
  "customValues": [
    {
      "key": "customer_id",
      "label": "Customer ID",
      "value": "COD-123",
      "valueLabel": ""
    }
  ],
  "createdBy": "email",
  "updatedBy": "email",
  "activity": [
    {
      "code": "Payment Link Created",
      "description": "Payment Link was created by username.",
      "date": "2025-12-26T11:53:02.705Z"
    }
  ],
  "sharedWith": [],
  "deletedAt": null,
  "payments": [],
  "attachments": [],
  "createdAt": "2025-12-26T11:53:02.709Z",
  "updatedAt": "2025-12-26T11:53:03.434Z",
  "paymentLink": ".zerospay.com/zpay/payment-request/694e771f9d17e6d8e640a52e",
  "paymentRequestId": "694e771f9d17e6d8e640a52e",
  "id": "694e771e9d17e6d8e640a52b"
}

json

application/json

deprecated

API view paymentLink by id

GET

https://api.paywithzero.net/v1

/public/payment-link/{id}

DEPRECATED — use GET /public/202104/payment-link/:id instead.

API view paymentLink by id › path Parameters

id

string · required

Payment link ID

API view paymentLink by id › Headers

key-hash

string · required

Security key hash issued to your integration (merchant dashboard: Administration → Security Keys).

API view paymentLink by id › Responses

Payment link returned.

No data returned

GET/public/payment-link/{id}

curl --request GET \
  --url https://api.paywithzero.net/v1/public/payment-link/:id \
  --header 'key-hash: YOUR_KEY_HASH'

shell

Example Responses

{
  "data": {
    "amount": 3,
    "taxes": 0,
    "totalAmount": 3,
    "paid": false,
    "reference": "STR-CYT-251226-22911",
    "paidAmount": 2,
    "surcharge": 0.06,
    "discount": 0,
    "paymentMethod": {
      "billingAddress": null,
      "last4": "9586",
      "paymentToken": "EXAMPLE",
      "type": "CARD",
      "metadata": {
        "ipAddress": "203.0.113.10",
        "loginDate": "2025-12-26T17:03:33.167Z",
        "submitDate": "2025-12-26T17:03:57.282Z",
        "user": "[email protected]"
      },
      "zipCode": "12656",
      "exp": "1229",
      "name": "John Doe",
      "cardType": "credit",
      "network": "mastercard",
      "brand": "mastercard",
      "number": "222300******9586",
      "bin": "22230000",
      "isSurchargeEligible": null,
      "isZipCodeEligible": null
    },
    "paidAt": "2025-12-26T17:04:02.537Z",
    "applyDiscount": false,
    "status": "partially-paid",
    "showBilling": true,
    "showShipping": true,
    "customValues": [
      {
        "key": "customer_id",
        "label": "Customer ID",
        "value": "Ramdom123",
        "valueLabel": ""
      },
      {
        "key": "Test1",
        "label": "Test1",
        "value": "Ramdom123",
        "valueLabel": ""
      }
    ],
    "createdBy": "[email protected]",
    "updatedBy": "online",
    "activity": [
      {
        "code": "Payment Link Created",
        "description": "Payment Link was created by Automated Testing User.",
        "date": "2025-12-26T17:03:30.056Z"
      },
      {
        "code": "Payment Link Shared",
        "description": "Payment Link was shared via copied Link.",
        "date": "2025-12-26T17:03:30.663Z"
      },
      {
        "code": "Payment Received",
        "description": "A payment for $2.00 was received using a Mastercard ending in 9586.\n                            Transaction ID: 1226170358.",
        "date": "2025-12-26T17:04:02.554Z"
      }
    ],
    "sharedWith": [],
    "deletedAt": null,
    "selectedTaxes": [],
    "payments": [
      {
        "type": "sale",
        "amountRefunded": 0,
        "paymentId": "694ec0027db6ff99147df7fe",
        "paidAmount": 200,
        "paidSurcharge": 6,
        "paidAt": "2025-12-26T17:04:02.537Z",
        "cardInfo": null,
        "paymentMethod": {
          "billingAddress": null,
          "last4": "9586",
          "paymentToken": "EXAMPLE",
          "type": "CARD",
          "metadata": {
            "ipAddress": "203.0.113.10",
            "loginDate": "2025-12-26T17:03:33.167Z",
            "submitDate": "2025-12-26T17:03:57.282Z",
            "user": "[email protected]"
          },
          "zipCode": "12656",
          "exp": "1229",
          "name": "John Doe",
          "cardType": "credit",
          "network": "mastercard",
          "brand": "mastercard",
          "number": "222300******9586",
          "bin": "22230000",
          "isSurchargeEligible": null,
          "isZipCodeEligible": null
        },
        "transactionId": "1226170358"
      }
    ],
    "attachments": [],
    "createdAt": "2025-12-26T17:03:30.057Z",
    "updatedAt": "2025-12-26T17:04:02.599Z",
    "paymentLink": "https://merchant.zerospay.com/zpay/payment-request/694ebfe2fff33e2b6034718f",
    "cardInfo": {
      "paymentToken": "",
      "customerVaultId": "",
      "token": "",
      "last4": "",
      "billingAddress": null,
      "zipCode": "",
      "exp": "",
      "name": "",
      "type": "",
      "network": "",
      "brand": "",
      "number": ""
    },
    "cardPrice": 0,
    "cardTaxes": 0,
    "cashPrice": 0,
    "cashTaxes": 0,
    "totalCardAmount": 0,
    "totalCashAmount": 0,
    "paymentId": "694ec0027db6ff99147df7fe",
    "transactionId": "1226170358",
    "id": "694ebfe2fff33e2b6034718d"
  }
}

json

application/json

deprecated

API delete paymentLink by id

DELETE

https://api.paywithzero.net/v1

/public/payment-link/{id}

API delete paymentLink by id › path Parameters

id

string · required

Payment link ID

API delete paymentLink by id › Headers

key-hash

string · required

Security key hash issued to your integration (merchant dashboard: Administration → Security Keys).

API delete paymentLink by id › Responses

Payment link deleted. Returns the raw payment-request document.

No data returned

DELETE/public/payment-link/{id}

curl --request DELETE \
  --url https://api.paywithzero.net/v1/public/payment-link/:id \
  --header 'key-hash: YOUR_KEY_HASH'

shell

Example Responses

{
  "data": {
    "clientId": "60e856cce2819f4a3cfa4294",
    "order": {
      "currency": "USD",
      "amount": 100,
      "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-21T01:59:21.305Z",
    "createdBy": "EXAMPLE",
    "updatedBy": "EXAMPLE",
    "owner": "EXAMPLE",
    "ownerGroup": null,
    "attachments": [],
    "createdAt": "2025-01-17T14:20:45.422Z",
    "updatedAt": "2025-02-21T01:59:21.309Z",
    "id": "678a673d510ae75f40a1a0fe"
  }
}

json

application/json

deprecated

API send the payment link by email

POST

https://api.paywithzero.net/v1

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

DEPRECATED — use POST /public/202104/payment-link/send-by-email instead.

API send the payment link by email › Headers

key-hash

string · required

Security key hash issued to your integration (merchant dashboard: Administration → Security Keys).

API send the payment link by email › Request Body

email

string

paymentLinkId

string

API send the payment link by email › Responses

Email sent.

No data returned

deprecated

API send the payment link by sms

POST

https://api.paywithzero.net/v1

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

DEPRECATED — use POST /public/202104/payment-link/send-by-sms instead.

Phone format: ^[+]?[(]?[0-9]{3}[)]?[ ]?[0-9]{3}[-]?[0-9]{4}$ — e.g. (555) 555-5555 or 5555555555; 555-555-5555 is rejected.

API send the payment link by sms › Headers

key-hash

string · required

Security key hash issued to your integration (merchant dashboard: Administration → Security Keys).

API send the payment link by sms › Request Body

phoneNumber

string

paymentLinkId

string

API send the payment link by sms › Responses

SMS sent.

No data returned

deprecated

Upload payment link attachments

POST

https://api.paywithzero.net/v1

/public/payment-link/upload-attachments

DEPRECATED — use POST /public/202104/payment-link/upload-attachments instead. Upload files to attach to a payment link. Up to 10 files per request, max 25 MB total. Supported: JPG, PNG, PDF.

Upload payment link attachments › Headers

key-hash

string · required

Security key hash issued to your integration (merchant dashboard: Administration → Security Keys).

Upload payment link attachments › Request Body

attachments

string[] · application/octet-stream · required

Multipart field name: attachments

Upload payment link attachments › Responses

Files uploaded.

No data returned

POST/public/payment-link/upload-attachments

curl --request POST \
  --url https://api.paywithzero.net/v1/public/payment-link/upload-attachments \
  --header 'Content-Type: multipart/form-data' \
  --header 'key-hash: YOUR_KEY_HASH' \
  --form attachments=string

shell

Example Request Body

{
  "attachments": [
    "string"
  ]
}

json

Example Responses

{
  "message": "Files uploaded successfully",
  "files": [
    {
      "path": "attachments/60d3a4008ff956001d85da21/payment-links/1747242200901_Secure_Payment.pdf",
      "fullPath": "https://storage.googleapis.com/zero-prod-out-of-scope-files/attachments/60d3a4008ff956001d85da21/payment-links/1747242200901_Secure_Payment.pdf",
      "originalName": "Secure Payment.pdf",
      "sizeInMB": 0.17
    }
  ]
}

json

application/json

Payment Links Terminal