Skip to main content

Payments Processing Rental

POST /v4.1/payments/{paymentOrderId}/paid​

Endpoint Explanation:
This endpoint marks a payment as successfully paid for a rental contract. You provide details about the payment including which contract and invoice it's for, when the payment was made, the payment method used, and the amount collected.


curl -X PUT https://api.rc.saas.bolttech.asia/v4.1/payments/{paymentOrderId}/paid \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "paymentOrderId": "1faafad-9737-48a2-b3fc-2c963f8def8a",
    "contractId": "8e7b3c92-5a14-4d35-9f76-12db44c87591",
    "invoiceId": "INV-2025-0512",
    "externalTransactionId": "EXT-PAY-78965412",
    "providerTransactionNumber": "TR-9876543210",
    "paymentDateTime": "2025-05-14T12:35:42Z",
    "paymentMethod": "CREDIT_CARD",
    "paymentProvider": "STRIPE",
    "amount": 1250.0
  }'
{
  "paymentOrderId": "1faafad-9737-48a2-b3fc-2c963f8def8a",

  "contractId": "8e7b3c92-5a14-4d35-9f76-12db44c87591",

  "invoiceId": "INV-2025-0512",

  "externalTransactionId": "EXT-PAY-78965412",

  "providerTransactionNumber": "TR-9876543210",

  "paymentDateTime": "2025-05-14T12:35:42Z",

  "paymentMethod": "CREDIT_CARD",

  "paymentProvider": "STRIPE",

  "amount": 1250.0
}

POST /v4.1/payments/{paymentOrderId}/failed​

Endpoint Explanation:
This endpoint records when a payment collection attempt was unsuccessful. It's similar to the payment endpoint but is used when a payment attempt fails, allowing the system to track failed collection attempts.

curl -X PUT https://api.rc.saas.bolttech.asia/v4.1/payments/{paymentOrderId}/paid \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "paymentOrderId": "1faafad-9737-48a2-b3fc-2c963f8def8a",
    "contractId": "8e7b3c92-5a14-4d35-9f76-12db44c87591",
    "invoiceId": "INV-2025-0512",
    "externalTransactionId": "EXT-PAY-78965412",
    "providerTransactionNumber": "TR-9876543210",
    "paymentDateTime": "2025-05-14T12:35:42Z",
    "paymentMethod": "CREDIT_CARD",
    "paymentProvider": "STRIPE",
    "amount": 1250.0
  }'
{
// To be included
}