Skip to main content

Create Payment Method

POST /api/v1/InvoiceSetting/createpayment

Description​

This endpoint is used to create a new payment method setting. It allows users to define and configure a new payment method for invoices.

Headers:

  • Content-Type: application/json

ApiKey:

  • No API key required

Path Parameters:

  • version: string, required

Request Body:

  • CreateInvoicePaymentMethodSettings object containing the new payment method settings

URL:

  • POST: {{baseUrl API url}}/api/v1/InvoiceSetting/createpayment

Response:

  • 200: Success, indicates that the new payment method settings have been successfully created.

Error Codes:

  • 400: Bad Request, the request body is not valid or missing required fields.

  • 404: Resource not found, the specified version or setting does not exist.

  • 500: Internal server error, something went wrong while processing the request.

Example Request URL:

POST /api/v1/InvoiceSetting/createpayment
Content-Type: application/json
{
  "paymentMethod": "Credit Card",
  "gateway": "Stripe",
  "accountNumber": "1234567890",
  "isActive": true
}

Example Response:

HTTP/1.1 200 OK

Method: POST​

/api/v1/InvoiceSetting/createpayment

Headers​

Content-TypeValue
Content-Typeapplication/json

Body (raw)​

{
  "paymentMethods": [
    "<integer>",
    "<integer>"
  ]
}

Response: 200​

LANGUAGE

AUTHORIZATION

Bearer

CURL REQUEST

curl --request POST \ 
 --url  /api/v1/InvoiceSetting/createpayment \ 
 --header 'accept: application/json' \ 
 --header 'content-type: application/json'

RESPONSE

Click Try It! to start a request and see the response here!