Make Payment for Invoice

POST /api/v1/Invoice/MakePayment

Description

This endpoint is used to make a payment for an invoice. It expects a CreateInvoicePaymentsRequest object in the request body and returns a CreateInvoicePaymentsResponseResponse object indicating the status of the payment.

Headers:

• None

ApiKey:

• No API key required

Content-Type:

• text/plain

• application/json

• text/json

Path Parameters:

• version: string, required

Query Parameters:

• None

Request Body:

• CreateInvoicePaymentsRequest: object, required

URL:

• POST: {{baseUrl API url}}/api/v1/Invoice/MakePayment

Response:

• A CreateInvoicePaymentsResponseResponse object indicating the status of the payment.

Error Codes:

• 400: Bad Request

• 404: Resource not found

• 500: Internal server error

Example Request URL:

POST /api/v1/Invoice/MakePayment

Example Request Body:

{
  "invoiceId": "98f2d2e5-6140-4f19-9b58-48c5003e92f7",
  "amount": 100.00,
  "currency": "USD",
  "paymentDate": "2024-02-18",
  "paymentMethod": "CreditCard"
}

Example:

Request:

POST /api/v1/Invoice/MakePayment

Response:

HTTP/1.1 200 OK
{
  "status": "Success",
  "message": "Payment for invoice '98f2d2e5-6140-4f19-9b58-48c5003e92f7' is successful."
}

Method: POST

/api/v1/Invoice/MakePayment

Headers

Content-Type	Value
Content-Type	application/json

Headers

Content-Type	Value
Accept	text/plain

Body (raw)

{
  "invoiceId": "<uuid>",
  "amount": "<double>",
  "notes": "<string>",
  "paymentMode": 11
}

Response: 200

{
  "succeeded": "<boolean>",
  "message": "<string>",
  "errors": [
    "<string>",
    "<string>"
  ],
  "data": {
    "invoiceTransactionId": "<uuid>"
  }
}