This document provides an overview of the available API endpoints for integrating with NoTalkPayments application.
The base URL for the NoTalkPayments API is: TBD
All requests to the API must be made over HTTPS. Requests over HTTP will fail.
All requests and responses are formatted in JSON.
NoTalkPayments endpoints require authentication for all requests. You can authenticate by including the API key in the request header.
Authorization: Bearer YOUR_API_KEY
Be careful to never expose your API credentials in any client-side code.
To create and access your API key, you need to follow the steps below. Note that only Company Admins can create API keys on NoTalkPayments.
The NoTalkPayments API will communicate responses using standard HTTP codes.
| HTTP Code | Description |
|---|---|
| 200 | OK (Everything worked as expected.) |
| 400 | Bad Request (This often means a required parameter is missing.) |
| 401 | Unauthorized |
| 404 | Not Found (The requested item does not exist.) |
| 429 | Too Many Requests |
| 500 | Internal server error |
We have rate limits in place in order to provide a fair response time to all our API users.
The primary rate limit is 40 requests per second. All requests count towards the rate limit.
If the rate limit is exceeded, the API returns a 429 status code indicating Too Many Requests, with the error message Your request rate has exceeded our rate limit.
| Description: | Retrieves a Business Unit from your account |
| URL: | /api/BusinessUnit/{id} |
| Method | GET |
| Content-Type | application/json |
| Response body |
{
"businessUnitExternalId": string,
"customerId": number,
"name": string,
"address": string,
"city": string,
"provinceCode": string,
"countryCode": string
}
|
| Description: | Creates a Business Unit object under your account |
| URL: | /api/BusinessUnit |
| Method | POST |
| Content-Type | application/json |
| Request body |
{
"businessUnitExternalId": string,
"customerId": number,
"name": string,
"address": string,
"city": string,
"provinceCode": string,
"countryCode": string
}
|
| Response body |
{
"id": number,
"businessUnitExternalId": string,
"customerId": number,
"name": string,
"address": string,
"city": string,
"provinceCode": string,
"countryCode": string
}
|
| Description: | Creates a Business Unit object under your account |
| URL: | /api/BusinessUnit |
| Method | PUT |
| Content-Type | application/json |
| Request body |
{
"id": number,
"businessUnitExternalId": string,
"customerId": number,
"name": string,
"address": string,
"city": string,
"provinceCode": string,
"countryCode": string
}
|
| Response body |
{
"id": number,
"businessUnitExternalId": string,
"customerId": number,
"name": string,
"address": string,
"city": string,
"provinceCode": string,
"countryCode": string
}
|
| Description: | Delete a Business Unit object under your account |
| URL: | /api/BusinessUnit/{id} |
| Method | DELETE |
| Content-Type | application/json |
| Description: | Retrieves a Debtor from your account |
| URL: | /api/Debtor/{id} |
| Method | GET |
| Content-Type | application/json |
| Response body |
{
"id": number,
"debtorExternalId": string,
"customerId": number,
"firstName": string,
"lastName": string,
"email": string,
"workPhone": string,
"homePhone": string,
"address": string,
"city": string,
"provinceCode": string,
"countryCode": string,
"dateOfBirth": date,
"employeerName":string
}
|
| Description: | Creates a Debtor object under your account |
| URL: | /api/Debtor |
| Method | POST |
| Content-Type | application/json |
| Request body |
{
"debtorExternalId": string,
"customerId": number,
"firstName": string,
"lastName": string,
"email": string,
"workPhone": string,
"homePhone": string,
"address": string,
"city": string,
"provinceCode": string,
"countryCode": string,
"dateOfBirth": date,
"employeerName":string
}
|
| Response body |
{
"id": number,
"debtorExternalId": string,
"customerId": number,
"firstName": string,
"lastName": string,
"email": string,
"workPhone": string,
"homePhone": string,
"address": string,
"city": string,
"provinceCode": string,
"countryCode": string,
"dateOfBirth": date,
"employeerName":string
}
|
| Description: | Update a Debtor object under your account |
| URL: | /api/Debtor |
| Method | PUT |
| Content-Type | application/json |
| Request body |
{
"id": number,
"debtorExternalId": string,
"customerId": number,
"firstName": string,
"lastName": string,
"email": string,
"workPhone": string,
"homePhone": string,
"address": string,
"city": string,
"provinceCode": string,
"countryCode": string,
"dateOfBirth": date,
"employeerName":string
}
|
| Response body |
{
"id": number,
"debtorExternalId": string,
"customerId": number,
"firstName": string,
"lastName": string,
"email": string,
"workPhone": string,
"homePhone": string,
"address": string,
"city": string,
"provinceCode": string,
"countryCode": string,
"dateOfBirth": date,
"employeerName":string
}
|
| Description: | Delete a Debtor object under your account |
| URL: | /api/Debtor/{id} |
| Method | DELETE |
| Content-Type | application/json |
| Description: | Retrieves a Invoice from your account |
| URL: | /api/Invoice/{id} |
| Method | GET |
| Content-Type | application/json |
| Response body |
{
"id": number,
"debtorId": number,
"invoiceExternalNumber": string,
"description": string,
"currencyCode": string,
"references": [{
"firstName": string,
"lastName": string,
"homePhone": string,
"workPhone": string,
"OtherPhone": string,
"Occuppation": string,
"Email": string
}],
"amount": number,
"dueDate": DateOnly,
"invoiceDate": DateOnly,
"businessUnitExternalId": string
}
|
| Description: | Creates a Invoice object under your account |
| URL: | /api/Invoice |
| Method | POST |
| Content-Type | application/json |
| Request body |
{
"invoiceExternalNumber": string,
"description": string,
"currencyCode": string,
"references": [{
"firstName": string,
"lastName": string,
"homePhone": string,
"workPhone": string,
"OtherPhone": string,
"Occuppation": string,
"Email": string
}],
"amount": 0,
"dueDate": DateOnly,
"invoiceDate": DateOnly,
"businessUnitExternalId": string
}
|
| Response body |
{
"id": number,
"debtorId": number,
"invoiceExternalNumber": string,
"description": string,
"currencyCode": string,
"references": [{
"firstName": string,
"lastName": string,
"homePhone": string,
"workPhone": string,
"OtherPhone": string,
"Occuppation": string,
"Email": string
}],
"amount": 0,
"dueDate": DateOnly,
"invoiceDate": DateOnly,
"businessUnitExternalId": string
}
|
| Description: | Creates a Invoice object under your account |
| URL: | /api/Invoice |
| Method | PUT |
| Content-Type | application/json |
| Request body |
{
"id": number,
"invoiceExternalNumber": string,
"description": string,
"currencyCode": string,
"references": [{
"firstName": string,
"lastName": string,
"homePhone": string,
"workPhone": string,
"OtherPhone": string,
"Occuppation": string,
"Email": string
}],
"amount": 0,
"dueDate": DateOnly,
"invoiceDate": DateOnly,
"businessUnitExternalId": string
}
|
| Response body |
{
"id": number,
"debtorId": number,
"invoiceExternalNumber": string,
"description": string,
"currencyCode": string,
"references": [{
"firstName": string,
"lastName": string,
"homePhone": string,
"workPhone": string,
"OtherPhone": string,
"Occuppation": string,
"Email": string
}],
"amount": 0,
"dueDate": DateOnly,
"invoiceDate": DateOnly,
"businessUnitExternalId": string
}
|
| Description: | Delete a Invoice object under your account |
| URL: | /api/Invoice/{id} |
| Method | DELETE |
| Content-Type | application/json |