Soap API documentation

Method: listPaymentMethods

List available payment methods.

Request

Field	Type	Description
This method takes no parameters.

Response

Field	Type	Description
paymentMethod[][id]	integer	Payment method ID.	optional
paymentMethod[][name]	string	Name of the payment method.	optional
paymentMethod[][isClosed]	boolean	Is the payment method closed?	optional

Examples

Request

<?xml version="1.0" encoding="UTF-8"?>
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
    <Header>
        <authenticate xmlns="https://secure.clearbooks.co.uk/api/accounting/soap/">
            <apiKey xmlns="">yourApiKey</apiKey>
        </authenticate>
    </Header>
    <Body>
        <listPaymentMethods xmlns="https://secure.clearbooks.co.uk/api/accounting/soap/"/>
    </Body>
</Envelope>

Response

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://secure.clearbooks.co.uk/api/accounting/soap/">
    <SOAP-ENV:Body>
        <ns1:listPaymentMethodsResponse>
            <return>
                <ns1:PaymentMethod>
                    <id>1</id>
                    <name>Cash</name>
                    <isClosed>false</isClosed>
                </ns1:PaymentMethod>
                <ns1:PaymentMethod>
                    <id>2</id>
                    <name>Cheque</name>
                    <isClosed>false</isClosed>
                </ns1:PaymentMethod>
                <ns1:PaymentMethod>
                    <id>3</id>
                    <name>Bank Transfer</name>
                    <isClosed>false</isClosed>
                </ns1:PaymentMethod>
                <ns1:PaymentMethod>
                    <id>4</id>
                    <name>Credit Card</name>
                    <isClosed>false</isClosed>
                </ns1:PaymentMethod>
                <ns1:PaymentMethod>
                    <id>5</id>
                    <name>Debit Card</name>
                    <isClosed>false</isClosed>
                </ns1:PaymentMethod>
                <ns1:PaymentMethod>
                    <id>6</id>
                    <name>Direct Debit</name>
                    <isClosed>false</isClosed>
                </ns1:PaymentMethod>
                <ns1:PaymentMethod>
                    <id>7</id>
                    <name>Standing Order</name>
                    <isClosed>false</isClosed>
                </ns1:PaymentMethod>
                <ns1:PaymentMethod>
                    <id>20</id>
                    <name>Email Payment</name>
                    <isClosed>false</isClosed>
                </ns1:PaymentMethod>
                <ns1:PaymentMethod>
                    <id>21</id>
                    <name>Website Payment</name>
                    <isClosed>false</isClosed>
                </ns1:PaymentMethod>
            </return>
        </ns1:listPaymentMethodsResponse>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>