Skip to main content
POST
/
v1
/
payments
Create payment
curl --request POST \
  --url https://app.blinksale.test/api/v1/payments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "invoice_id": "01jtbf0c9zaraqx3swthf88n5y",
  "amount": 1000,
  "payment_date": "2023-06-25",
  "is_settled": true,
  "notes": "Payment via bank transfer"
}
'
{
  "success": true,
  "message": "Payment created successfully",
  "data": {
    "id": "01jtbf0c9zaraqx3swthf88n5y",
    "organization_id": "01jtbf0c9zaraqx3swthf88n5y",
    "invoice_id": "01jtbf0c9zaraqx3swthf88n5y",
    "amount": 500,
    "is_settled": true,
    "payment_date": "2023-06-25",
    "notes": "Payment via check #12345",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
Authorization
string
header
required

Access token obtained from the /v1/auth/login endpoint

Body

application/json
​
invoice_id
string<uuid>
required
Example:

"01jtbf0c9zaraqx3swthf88n5y"

​
amount
number<float>
required
Example:

1000

​
payment_date
string<date> | null
Example:

"2023-06-25"

​
is_settled
boolean
default:true
Example:

true

​
notes
string | null
Example:

"Payment via bank transfer"

Response

Payment created successfully

​
success
boolean
Example:

true

​
message
string
Example:

"Payment created successfully"

​
data
object