Skip to main content
GET
/
v1
/
payments
/
{paymentId}
Get payment
curl --request GET \
  --url https://app.blinksale.test/api/v1/payments/{paymentId} \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "message": "Payment retrieved 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

Path Parameters

paymentId
string<uuid>
required

The ID of the payment to retrieve

Response

Payment retrieved successfully

success
boolean
Example:

true

message
string
Example:

"Payment retrieved successfully"

data
object