POST api/v1/MakePayment

Make a payment against an order, proforma or specific invoices for a customer

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
apiKey	Please contact Caliq support to get your key	string	Required
CustomerID	Caliq internal unique customer identifier. Must be supplied if AccountNo is omitted	integer	None.
AccountNo	User entered unique customer account number. Must be supplied if CustomerID is omitted	string	Required Max length: 10
PaymentTypeID	Indicates the type of payment used. Can be retrieved from api call	integer	Required
Amount	Amount paid by above method	decimal number	Required
TransactionID	Unique transaction reference returned from payment provider	string	Max length: 255
AuthNumber	Payment authorisation number	string	Max length: 50
SecurityKey	Payment security key	string	Max length: 50
VendorTXCode	Unique vendor transaction code of the payment	string	Max length: 50
PayTransactions		PayTransactions	None.

Request Formats

application/json, text/json

Sample:

{
  "apiKey": "sample string 1",
  "CustomerID": 1,
  "AccountNo": "sample string 2",
  "PaymentTypeID": 3,
  "Amount": 4.0,
  "TransactionID": "sample string 5",
  "AuthNumber": "sample string 6",
  "SecurityKey": "sample string 7",
  "VendorTXCode": "sample string 8",
  "PayTransactions": {
    "PayTransaction": [
      {
        "TransID": 1,
        "SubID": 2,
        "Type": "sample string 3",
        "Amount": 4.0
      },
      {
        "TransID": 1,
        "SubID": 2,
        "Type": "sample string 3",
        "Amount": 4.0
      }
    ]
  }
}

application/xml, text/xml

Sample:

<MakePaymentParams xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <apiKey>sample string 1</apiKey>
  <CustomerID>1</CustomerID>
  <AccountNo>sample string 2</AccountNo>
  <PaymentTypeID>3</PaymentTypeID>
  <Amount>4</Amount>
  <TransactionID>sample string 5</TransactionID>
  <AuthNumber>sample string 6</AuthNumber>
  <SecurityKey>sample string 7</SecurityKey>
  <VendorTXCode>sample string 8</VendorTXCode>
  <PayTransactions>
    <PayTransaction>
      <TransID>1</TransID>
      <SubID>2</SubID>
      <Type>sample string 3</Type>
      <Amount>4</Amount>
    </PayTransaction>
    <PayTransaction>
      <TransID>1</TransID>
      <SubID>2</SubID>
      <Type>sample string 3</Type>
      <Amount>4</Amount>
    </PayTransaction>
  </PayTransactions>
</MakePaymentParams>

Response Information

Resource Description

Returns:
200 OK Returns whether payment was successful or not
400 Bad Request - parameters supplied cannot be properly interpreted
401 Not Authorised if supplied api key is not valid
503 Service Unavailable

MakePaymentResults

Name	Description	Type	Additional information
MakePaymentDataData		MakePaymentDataData	None.

Response Formats

application/json, text/json

Sample:

{
  "MakePaymentDataData": {
    "OK": true,
    "MakePaymentIssues": [
      {
        "ID": 1,
        "Message": "sample string 2",
        "ExtraData": "sample string 3"
      },
      {
        "ID": 1,
        "Message": "sample string 2",
        "ExtraData": "sample string 3"
      }
    ]
  }
}

application/xml, text/xml

Sample:

<MakePaymentResults xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <MakePaymentDataData>
    <OK>true</OK>
    <MakePaymentIssues>
      <MakePaymentIssue>
        <ID>1</ID>
        <Message>sample string 2</Message>
        <ExtraData>sample string 3</ExtraData>
      </MakePaymentIssue>
      <MakePaymentIssue>
        <ID>1</ID>
        <Message>sample string 2</Message>
        <ExtraData>sample string 3</ExtraData>
      </MakePaymentIssue>
    </MakePaymentIssues>
  </MakePaymentDataData>
</MakePaymentResults>