# Payment Endpoints {#payment-endpoints}


Manage payment records linked to invoices and contacts.


## Base Path {#base-path}


```
/api/payment
```


## Endpoints {#endpoints}



### List Payments {#list-payments}


```
GET /api/payment
Authorization: Bearer {token}
```


### Get Payment by ID {#get-payment-by-id}


```
GET /api/payment/:id
Authorization: Bearer {token}
```


### Create Payment {#create-payment}


```
POST /api/payment
Authorization: Bearer {token}
```

**Request Body:**

```json
{
  "paymentDate": "2025-01-31",
  "amount": 2500,
  "currency": "USD",
  "note": "Partial payment for Invoice #1001",
  "paymentMethod": "BANK_TRANSFER",
  "invoiceId": "invoice-uuid",
  "contactId": "contact-uuid",
  "projectId": "project-uuid"
}
```


### Update Payment {#update-payment}


```
PUT /api/payment/:id
Authorization: Bearer {token}
```


### Delete Payment {#delete-payment}


```
DELETE /api/payment/:id
Authorization: Bearer {token}
```


## Payment Methods {#payment-methods}


| Method        | Code            |
| ------------- | --------------- |
| Cash          | `CASH`          |
| Bank Transfer | `BANK_TRANSFER` |
| Debit Card    | `DEBIT_CARD`    |
| Credit Card   | `CREDIT_CARD`   |
| Cheque        | `CHEQUE`        |
| Online        | `ONLINE`        |


## Permissions {#permissions}


| Action | Required Permission |
| ------ | ------------------- |
| View   | `ORG_PAYMENT_VIEW`  |
| Add    | `ORG_PAYMENT_ADD`   |
| Edit   | `ORG_PAYMENT_EDIT`  |


## Related Pages {#related-pages}


- [Invoice Endpoints](https://sourcey-gauzy.pages.dev/api/invoice-endpoints/index.md) — invoicing
- [Payments Feature](https://sourcey-gauzy.pages.dev/features/payments/index.md) — feature guide