Create an invoice
curl --request POST \
--url https://api.paymentsmojo.com/payment-requests \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"merchantAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"invoiceNumber": "<string>",
"amount": 123,
"poNumber": "<string>",
"customerName": "<string>",
"customerCompany": "<string>",
"customerEmail": "<string>",
"customerPhone": "<string>",
"delivery": "<string>",
"memo": "<string>",
"dueDate": "2023-12-25",
"lines": [
{
"description": "<string>",
"quantity": 123,
"unitCost": 123,
"uom": "<string>",
"commodityCode": "<string>",
"upc": "<string>"
}
],
"send": true
}
'import requests
url = "https://api.paymentsmojo.com/payment-requests"
payload = {
"merchantAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"invoiceNumber": "<string>",
"amount": 123,
"poNumber": "<string>",
"customerName": "<string>",
"customerCompany": "<string>",
"customerEmail": "<string>",
"customerPhone": "<string>",
"delivery": "<string>",
"memo": "<string>",
"dueDate": "2023-12-25",
"lines": [
{
"description": "<string>",
"quantity": 123,
"unitCost": 123,
"uom": "<string>",
"commodityCode": "<string>",
"upc": "<string>"
}
],
"send": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
merchantAccountId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
invoiceNumber: '<string>',
amount: 123,
poNumber: '<string>',
customerName: '<string>',
customerCompany: '<string>',
customerEmail: '<string>',
customerPhone: '<string>',
delivery: '<string>',
memo: '<string>',
dueDate: '2023-12-25',
lines: [
{
description: '<string>',
quantity: 123,
unitCost: 123,
uom: '<string>',
commodityCode: '<string>',
upc: '<string>'
}
],
send: true
})
};
fetch('https://api.paymentsmojo.com/payment-requests', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.paymentsmojo.com/payment-requests",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'merchantAccountId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'invoiceNumber' => '<string>',
'amount' => 123,
'poNumber' => '<string>',
'customerName' => '<string>',
'customerCompany' => '<string>',
'customerEmail' => '<string>',
'customerPhone' => '<string>',
'delivery' => '<string>',
'memo' => '<string>',
'dueDate' => '2023-12-25',
'lines' => [
[
'description' => '<string>',
'quantity' => 123,
'unitCost' => 123,
'uom' => '<string>',
'commodityCode' => '<string>',
'upc' => '<string>'
]
],
'send' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.paymentsmojo.com/payment-requests"
payload := strings.NewReader("{\n \"merchantAccountId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"invoiceNumber\": \"<string>\",\n \"amount\": 123,\n \"poNumber\": \"<string>\",\n \"customerName\": \"<string>\",\n \"customerCompany\": \"<string>\",\n \"customerEmail\": \"<string>\",\n \"customerPhone\": \"<string>\",\n \"delivery\": \"<string>\",\n \"memo\": \"<string>\",\n \"dueDate\": \"2023-12-25\",\n \"lines\": [\n {\n \"description\": \"<string>\",\n \"quantity\": 123,\n \"unitCost\": 123,\n \"uom\": \"<string>\",\n \"commodityCode\": \"<string>\",\n \"upc\": \"<string>\"\n }\n ],\n \"send\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.paymentsmojo.com/payment-requests")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"merchantAccountId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"invoiceNumber\": \"<string>\",\n \"amount\": 123,\n \"poNumber\": \"<string>\",\n \"customerName\": \"<string>\",\n \"customerCompany\": \"<string>\",\n \"customerEmail\": \"<string>\",\n \"customerPhone\": \"<string>\",\n \"delivery\": \"<string>\",\n \"memo\": \"<string>\",\n \"dueDate\": \"2023-12-25\",\n \"lines\": [\n {\n \"description\": \"<string>\",\n \"quantity\": 123,\n \"unitCost\": 123,\n \"uom\": \"<string>\",\n \"commodityCode\": \"<string>\",\n \"upc\": \"<string>\"\n }\n ],\n \"send\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.paymentsmojo.com/payment-requests")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"merchantAccountId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"invoiceNumber\": \"<string>\",\n \"amount\": 123,\n \"poNumber\": \"<string>\",\n \"customerName\": \"<string>\",\n \"customerCompany\": \"<string>\",\n \"customerEmail\": \"<string>\",\n \"customerPhone\": \"<string>\",\n \"delivery\": \"<string>\",\n \"memo\": \"<string>\",\n \"dueDate\": \"2023-12-25\",\n \"lines\": [\n {\n \"description\": \"<string>\",\n \"quantity\": 123,\n \"unitCost\": 123,\n \"uom\": \"<string>\",\n \"commodityCode\": \"<string>\",\n \"upc\": \"<string>\"\n }\n ],\n \"send\": true\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"merchantAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"mid": "<string>",
"locationName": "<string>",
"invoiceNumber": "<string>",
"poNumber": "<string>",
"amount": 123,
"amountPaid": 123,
"balance": 123,
"customerName": "<string>",
"customerCompany": "<string>",
"customerEmail": "<string>",
"customerPhone": "<string>",
"delivery": "<string>",
"sentVia": "<string>",
"sentAt": "2023-11-07T05:31:56Z",
"sendProblem": "<string>",
"memo": "<string>",
"dueDate": "2023-11-07T05:31:56Z",
"lines": 123,
"status": "<string>",
"failedAttempts": 123,
"problem": "<string>",
"paidAt": "2023-11-07T05:31:56Z",
"level3Sent": true,
"createdAt": "2023-11-07T05:31:56Z",
"createdByName": "<string>",
"cancelledAt": "2023-11-07T05:31:56Z",
"cancelledByName": "<string>",
"link": "<string>",
"lineItems": [
{
"description": "<string>",
"quantity": 123,
"unitCost": 123,
"uom": "<string>",
"commodityCode": "<string>",
"upc": "<string>"
}
],
"payments": [
{
"amount": 123,
"retRef": "<string>",
"lastFour": "<string>",
"payerName": "<string>",
"paidAt": "2023-11-07T05:31:56Z",
"level3Sent": true,
"savedCard": true
}
],
"savedCards": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"cardBrand": "<string>",
"lastFour": "<string>",
"expiry": "<string>",
"savedAt": "2023-11-07T05:31:56Z",
"savedByName": "<string>"
}
],
"customerPrefers": "<string>"
}{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"merchantAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"mid": "<string>",
"locationName": "<string>",
"invoiceNumber": "<string>",
"poNumber": "<string>",
"amount": 123,
"amountPaid": 123,
"balance": 123,
"customerName": "<string>",
"customerCompany": "<string>",
"customerEmail": "<string>",
"customerPhone": "<string>",
"delivery": "<string>",
"sentVia": "<string>",
"sentAt": "2023-11-07T05:31:56Z",
"sendProblem": "<string>",
"memo": "<string>",
"dueDate": "2023-11-07T05:31:56Z",
"lines": 123,
"status": "<string>",
"failedAttempts": 123,
"problem": "<string>",
"paidAt": "2023-11-07T05:31:56Z",
"level3Sent": true,
"createdAt": "2023-11-07T05:31:56Z",
"createdByName": "<string>",
"cancelledAt": "2023-11-07T05:31:56Z",
"cancelledByName": "<string>",
"link": "<string>",
"lineItems": [
{
"description": "<string>",
"quantity": 123,
"unitCost": 123,
"uom": "<string>",
"commodityCode": "<string>",
"upc": "<string>"
}
],
"payments": [
{
"amount": 123,
"retRef": "<string>",
"lastFour": "<string>",
"payerName": "<string>",
"paidAt": "2023-11-07T05:31:56Z",
"level3Sent": true,
"savedCard": true
}
],
"savedCards": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"cardBrand": "<string>",
"lastFour": "<string>",
"expiry": "<string>",
"savedAt": "2023-11-07T05:31:56Z",
"savedByName": "<string>"
}
],
"customerPrefers": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"errors": {}
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"errors": {}
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"errors": {}
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"errors": {}
}Invoices
Create an invoice
Makes a payment request for an invoice and, unless send is false, sends its pay link to the customer by email or text (the customer’s own choice wins once they’ve made one). The customer’s email is required; lines, when given, must add up to amount. With send: false the request and its link are made without sending anything: send it later with POST /payment-requests/{id}/send. Send an Idempotency-Key header to make retries safe: a repeat with the same key returns the request already made, with 200 instead of 201.
POST
/
payment-requests
Create an invoice
curl --request POST \
--url https://api.paymentsmojo.com/payment-requests \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"merchantAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"invoiceNumber": "<string>",
"amount": 123,
"poNumber": "<string>",
"customerName": "<string>",
"customerCompany": "<string>",
"customerEmail": "<string>",
"customerPhone": "<string>",
"delivery": "<string>",
"memo": "<string>",
"dueDate": "2023-12-25",
"lines": [
{
"description": "<string>",
"quantity": 123,
"unitCost": 123,
"uom": "<string>",
"commodityCode": "<string>",
"upc": "<string>"
}
],
"send": true
}
'import requests
url = "https://api.paymentsmojo.com/payment-requests"
payload = {
"merchantAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"invoiceNumber": "<string>",
"amount": 123,
"poNumber": "<string>",
"customerName": "<string>",
"customerCompany": "<string>",
"customerEmail": "<string>",
"customerPhone": "<string>",
"delivery": "<string>",
"memo": "<string>",
"dueDate": "2023-12-25",
"lines": [
{
"description": "<string>",
"quantity": 123,
"unitCost": 123,
"uom": "<string>",
"commodityCode": "<string>",
"upc": "<string>"
}
],
"send": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
merchantAccountId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
invoiceNumber: '<string>',
amount: 123,
poNumber: '<string>',
customerName: '<string>',
customerCompany: '<string>',
customerEmail: '<string>',
customerPhone: '<string>',
delivery: '<string>',
memo: '<string>',
dueDate: '2023-12-25',
lines: [
{
description: '<string>',
quantity: 123,
unitCost: 123,
uom: '<string>',
commodityCode: '<string>',
upc: '<string>'
}
],
send: true
})
};
fetch('https://api.paymentsmojo.com/payment-requests', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.paymentsmojo.com/payment-requests",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'merchantAccountId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'invoiceNumber' => '<string>',
'amount' => 123,
'poNumber' => '<string>',
'customerName' => '<string>',
'customerCompany' => '<string>',
'customerEmail' => '<string>',
'customerPhone' => '<string>',
'delivery' => '<string>',
'memo' => '<string>',
'dueDate' => '2023-12-25',
'lines' => [
[
'description' => '<string>',
'quantity' => 123,
'unitCost' => 123,
'uom' => '<string>',
'commodityCode' => '<string>',
'upc' => '<string>'
]
],
'send' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.paymentsmojo.com/payment-requests"
payload := strings.NewReader("{\n \"merchantAccountId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"invoiceNumber\": \"<string>\",\n \"amount\": 123,\n \"poNumber\": \"<string>\",\n \"customerName\": \"<string>\",\n \"customerCompany\": \"<string>\",\n \"customerEmail\": \"<string>\",\n \"customerPhone\": \"<string>\",\n \"delivery\": \"<string>\",\n \"memo\": \"<string>\",\n \"dueDate\": \"2023-12-25\",\n \"lines\": [\n {\n \"description\": \"<string>\",\n \"quantity\": 123,\n \"unitCost\": 123,\n \"uom\": \"<string>\",\n \"commodityCode\": \"<string>\",\n \"upc\": \"<string>\"\n }\n ],\n \"send\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.paymentsmojo.com/payment-requests")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"merchantAccountId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"invoiceNumber\": \"<string>\",\n \"amount\": 123,\n \"poNumber\": \"<string>\",\n \"customerName\": \"<string>\",\n \"customerCompany\": \"<string>\",\n \"customerEmail\": \"<string>\",\n \"customerPhone\": \"<string>\",\n \"delivery\": \"<string>\",\n \"memo\": \"<string>\",\n \"dueDate\": \"2023-12-25\",\n \"lines\": [\n {\n \"description\": \"<string>\",\n \"quantity\": 123,\n \"unitCost\": 123,\n \"uom\": \"<string>\",\n \"commodityCode\": \"<string>\",\n \"upc\": \"<string>\"\n }\n ],\n \"send\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.paymentsmojo.com/payment-requests")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"merchantAccountId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"invoiceNumber\": \"<string>\",\n \"amount\": 123,\n \"poNumber\": \"<string>\",\n \"customerName\": \"<string>\",\n \"customerCompany\": \"<string>\",\n \"customerEmail\": \"<string>\",\n \"customerPhone\": \"<string>\",\n \"delivery\": \"<string>\",\n \"memo\": \"<string>\",\n \"dueDate\": \"2023-12-25\",\n \"lines\": [\n {\n \"description\": \"<string>\",\n \"quantity\": 123,\n \"unitCost\": 123,\n \"uom\": \"<string>\",\n \"commodityCode\": \"<string>\",\n \"upc\": \"<string>\"\n }\n ],\n \"send\": true\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"merchantAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"mid": "<string>",
"locationName": "<string>",
"invoiceNumber": "<string>",
"poNumber": "<string>",
"amount": 123,
"amountPaid": 123,
"balance": 123,
"customerName": "<string>",
"customerCompany": "<string>",
"customerEmail": "<string>",
"customerPhone": "<string>",
"delivery": "<string>",
"sentVia": "<string>",
"sentAt": "2023-11-07T05:31:56Z",
"sendProblem": "<string>",
"memo": "<string>",
"dueDate": "2023-11-07T05:31:56Z",
"lines": 123,
"status": "<string>",
"failedAttempts": 123,
"problem": "<string>",
"paidAt": "2023-11-07T05:31:56Z",
"level3Sent": true,
"createdAt": "2023-11-07T05:31:56Z",
"createdByName": "<string>",
"cancelledAt": "2023-11-07T05:31:56Z",
"cancelledByName": "<string>",
"link": "<string>",
"lineItems": [
{
"description": "<string>",
"quantity": 123,
"unitCost": 123,
"uom": "<string>",
"commodityCode": "<string>",
"upc": "<string>"
}
],
"payments": [
{
"amount": 123,
"retRef": "<string>",
"lastFour": "<string>",
"payerName": "<string>",
"paidAt": "2023-11-07T05:31:56Z",
"level3Sent": true,
"savedCard": true
}
],
"savedCards": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"cardBrand": "<string>",
"lastFour": "<string>",
"expiry": "<string>",
"savedAt": "2023-11-07T05:31:56Z",
"savedByName": "<string>"
}
],
"customerPrefers": "<string>"
}{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"merchantAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"mid": "<string>",
"locationName": "<string>",
"invoiceNumber": "<string>",
"poNumber": "<string>",
"amount": 123,
"amountPaid": 123,
"balance": 123,
"customerName": "<string>",
"customerCompany": "<string>",
"customerEmail": "<string>",
"customerPhone": "<string>",
"delivery": "<string>",
"sentVia": "<string>",
"sentAt": "2023-11-07T05:31:56Z",
"sendProblem": "<string>",
"memo": "<string>",
"dueDate": "2023-11-07T05:31:56Z",
"lines": 123,
"status": "<string>",
"failedAttempts": 123,
"problem": "<string>",
"paidAt": "2023-11-07T05:31:56Z",
"level3Sent": true,
"createdAt": "2023-11-07T05:31:56Z",
"createdByName": "<string>",
"cancelledAt": "2023-11-07T05:31:56Z",
"cancelledByName": "<string>",
"link": "<string>",
"lineItems": [
{
"description": "<string>",
"quantity": 123,
"unitCost": 123,
"uom": "<string>",
"commodityCode": "<string>",
"upc": "<string>"
}
],
"payments": [
{
"amount": 123,
"retRef": "<string>",
"lastFour": "<string>",
"payerName": "<string>",
"paidAt": "2023-11-07T05:31:56Z",
"level3Sent": true,
"savedCard": true
}
],
"savedCards": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"cardBrand": "<string>",
"lastFour": "<string>",
"expiry": "<string>",
"savedAt": "2023-11-07T05:31:56Z",
"savedByName": "<string>"
}
],
"customerPrefers": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"errors": {}
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"errors": {}
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"errors": {}
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"errors": {}
}Authorizations
An access token from POST /oauth/token (your API key's id and secret). It lasts 10 minutes.
Headers
Body
application/json
Show child attributes
Show child attributes
Response
OK
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes