Create a payment

curl --request POST \
  --url https://api.salesbricks.com/api/v2/invoices/{invoice_id}/payments \
  --header 'Content-Type: application/json' \
  --header 'X-SALESBRICKS-KEY: <api-key>' \
  --data '
{
  "paid_amount": 123,
  "paid_at": "2023-11-07T05:31:56Z",
  "payment_proof": "<string>",
  "memo": "<string>"
}
'

import requests

url = "https://api.salesbricks.com/api/v2/invoices/{invoice_id}/payments"

payload = {
    "paid_amount": 123,
    "paid_at": "2023-11-07T05:31:56Z",
    "payment_proof": "<string>",
    "memo": "<string>"
}
headers = {
    "X-SALESBRICKS-KEY": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-SALESBRICKS-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    paid_amount: 123,
    paid_at: '2023-11-07T05:31:56Z',
    payment_proof: '<string>',
    memo: '<string>'
  })
};

fetch('https://api.salesbricks.com/api/v2/invoices/{invoice_id}/payments', 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.salesbricks.com/api/v2/invoices/{invoice_id}/payments",
  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([
    'paid_amount' => 123,
    'paid_at' => '2023-11-07T05:31:56Z',
    'payment_proof' => '<string>',
    'memo' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-SALESBRICKS-KEY: <api-key>"
  ],
]);

$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.salesbricks.com/api/v2/invoices/{invoice_id}/payments"

	payload := strings.NewReader("{\n  \"paid_amount\": 123,\n  \"paid_at\": \"2023-11-07T05:31:56Z\",\n  \"payment_proof\": \"<string>\",\n  \"memo\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-SALESBRICKS-KEY", "<api-key>")
	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.salesbricks.com/api/v2/invoices/{invoice_id}/payments")
  .header("X-SALESBRICKS-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"paid_amount\": 123,\n  \"paid_at\": \"2023-11-07T05:31:56Z\",\n  \"payment_proof\": \"<string>\",\n  \"memo\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.salesbricks.com/api/v2/invoices/{invoice_id}/payments")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-SALESBRICKS-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"paid_amount\": 123,\n  \"paid_at\": \"2023-11-07T05:31:56Z\",\n  \"payment_proof\": \"<string>\",\n  \"memo\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "payment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "invoice_number": "<string>",
  "invoice_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "paid_amount": 123,
  "paid_at": "2023-11-07T05:31:56Z",
  "currency": "<string>",
  "error": "<string>"
}

{
  "error": {
    "message": "<string>",
    "error_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

{
  "error": {
    "code": "ERR_NOT_FOUND",
    "message": "Not found — the resource you are looking for does not exist."
  }
}

POST

invoices

{invoice_id}

payments

Create a payment

curl --request POST \
  --url https://api.salesbricks.com/api/v2/invoices/{invoice_id}/payments \
  --header 'Content-Type: application/json' \
  --header 'X-SALESBRICKS-KEY: <api-key>' \
  --data '
{
  "paid_amount": 123,
  "paid_at": "2023-11-07T05:31:56Z",
  "payment_proof": "<string>",
  "memo": "<string>"
}
'

import requests

url = "https://api.salesbricks.com/api/v2/invoices/{invoice_id}/payments"

payload = {
    "paid_amount": 123,
    "paid_at": "2023-11-07T05:31:56Z",
    "payment_proof": "<string>",
    "memo": "<string>"
}
headers = {
    "X-SALESBRICKS-KEY": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-SALESBRICKS-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    paid_amount: 123,
    paid_at: '2023-11-07T05:31:56Z',
    payment_proof: '<string>',
    memo: '<string>'
  })
};

fetch('https://api.salesbricks.com/api/v2/invoices/{invoice_id}/payments', 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.salesbricks.com/api/v2/invoices/{invoice_id}/payments",
  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([
    'paid_amount' => 123,
    'paid_at' => '2023-11-07T05:31:56Z',
    'payment_proof' => '<string>',
    'memo' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-SALESBRICKS-KEY: <api-key>"
  ],
]);

$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.salesbricks.com/api/v2/invoices/{invoice_id}/payments"

	payload := strings.NewReader("{\n  \"paid_amount\": 123,\n  \"paid_at\": \"2023-11-07T05:31:56Z\",\n  \"payment_proof\": \"<string>\",\n  \"memo\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-SALESBRICKS-KEY", "<api-key>")
	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.salesbricks.com/api/v2/invoices/{invoice_id}/payments")
  .header("X-SALESBRICKS-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"paid_amount\": 123,\n  \"paid_at\": \"2023-11-07T05:31:56Z\",\n  \"payment_proof\": \"<string>\",\n  \"memo\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.salesbricks.com/api/v2/invoices/{invoice_id}/payments")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-SALESBRICKS-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"paid_amount\": 123,\n  \"paid_at\": \"2023-11-07T05:31:56Z\",\n  \"payment_proof\": \"<string>\",\n  \"memo\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "payment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "invoice_number": "<string>",
  "invoice_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "paid_amount": 123,
  "paid_at": "2023-11-07T05:31:56Z",
  "currency": "<string>",
  "error": "<string>"
}

{
  "error": {
    "message": "<string>",
    "error_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

{
  "error": {
    "code": "ERR_NOT_FOUND",
    "message": "Not found — the resource you are looking for does not exist."
  }
}

Authorizations

X-SALESBRICKS-KEY

string

header

required

API key for authentication

Path Parameters

invoice_id

string

required

Pattern: ^([a-zA-Z\d\-]+)$

Body

payment_method

enum<string>

required

Payment method used for this payment.

WIRE - Wire
CHECK - Check
ACH - Direct debit
CREDIT_CARD - Credit Card

Available options:

WIRE,

CHECK,

ACH,

CREDIT_CARD

paid_amount

integer

required

Amount paid in the smallest currency unit.

paid_at

string<date-time> | null

Timestamp of the payment. Defaults to the current time.

payment_proof

string | null

Proof of payment such as a transaction reference or confirmation number.

memo

string | null

Internal memo or notes about this payment.

Response

payment_id

string<uuid>

required

read-only

Unique identifier for the payment

invoice_number

string | null

required

read-only

The invoice number this payment was made against, snapshotted from the invoice version current when the payment was recorded — it does not change when the invoice is later regenerated, so it may differ from the invoice's top-level invoice_number. Falls back to the invoice's current number when no version is linked. Join payments to invoices by ID, not by number.

invoice_version_id

string<uuid> | null

required

read-only

Identifier of the invoice version this payment was made against — the version current when the payment was recorded. Null only when the invoice has no versions (it was never generated).

paid_amount

integer | null

required

read-only

The amount paid

paid_at

string<date-time> | null

required

read-only

the date at which this payment was paid

currency

string

required

read-only

The currency in which the payment is denominated (e.g., USD, EUR)

error

string | null

required

read-only

Any errors that occured during this payment processing

Customers

Payment Methods

Customer Contacts

Discount Coupons

Invoices

Invoice Versions

Legal Entities

Plans

Revenue

Subscriptions

Subscription Management

Subscription State

Usage

Subscription History

Subscription Recasts

Subscription Upgrades

Create a payment

Authorizations

Path Parameters

Body

Response