Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
This method returns
Excerpt

Use this method to get a list of payment methods.

Tip

Valid Tokens: Company.

This method does not return payment methods from the Clearent Integration.


Filter by label (Content by label)
showLabelsfalse
max5
titleRelated Articles
cqllabel in ( "payment-api" , "payment-ecommerce" , "company-token" , "documentation" )

Request


URL: https://api.kometsales.com/api/payment.method.list

Method: GET

Content-Type: URL

Params.

Parameters


Input parameters

authenticationToken (required)(string:50)

:

Komet Sales security token.

curl


Code Block
languagejs
https://api.kometsales.com/api/payment.method.list?
authenticationToken=token_info_goes_here

Response

Output


status (integer:1)

: transaction

Transaction status.

1 for success or 0 for failure.

Valid values: 1 = Success | 0 = Failure


message (string:500)

: description of the status of the transaction

Transaction status description.


method

: array of

(array)

An array containing the payment methods.


id (integer:20)

: payment method

Komet Sales internal Payment Method ID.


name (string:50)

: name of the payment method.Sample Response

Payment method name.


Code Block
{
    "status": "1",
    "message": "OK",
    "method": [
        {
            "id": "1",
            "name": "Check"
        },
        {
            "id": "2",
            "name": "Credit Card Visa"
        }
    ]
}
Note

This method will not return payment methods from the Clearent Integration.

Panel
titleRelated Articles
Filter by label (Content by label)showLabelsfalsemax10showSpacefalsesorttitlecqllabel in ( "accounts-receivables" , "payments" )labelsaccounts-receivables payments

We've encountered an issue exporting this macro. Please try exporting this page again later.