Skip to main content
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>"
}
'
{
  "payment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "invoice_number": "<string>",
  "paid_amount": 123,
  "paid_at": "2023-11-07T05:31:56Z",
  "currency": "<string>",
  "error": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.salesbricks.com/llms.txt

Use this file to discover all available pages before exploring further.

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

Short form identifier for the invoice. If the invoice_number is null, this is an estimate

​
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