All Collections
Cloud Commerce Pro
CCP - Open API: Paying an Invoice for an Order
CCP - Open API: Paying an Invoice for an Order

Using the API to get the details of an invoice against an order

Chelsea Kelly avatar
Written by Chelsea Kelly
Updated over a week ago

The CreatePayment function can:-

  • assign a payment against a known invoice

The CreatePayment function will return a generic response which includes:-

  • Success indicator if the payment was made or not

  • Content the PaymentID for the payment if successful, useful for internal logging

Tips and Recommendations when using this function

  • Pass in the InvoiceID returned from the getInvoiceSummaryForOrderID function as the intInvoiceID for the function

  • Use the amounts returned from the getInvoiceSupportForOrderID function to calculate the payment value to use for dbPaymentAmount if wanting to pay an invoice in full

  • intSalesChannelID and intCustomerID relating to the invoice can be found in the result of the AddCustomer function, if this function was used when inputting the order.

  • TransactionTypeID should be set to Invoice if you want to pay an invoice

  • The recommended date format for dtPaymentDate is 2021-10-22T12:01:44

  • It is recommended that you embed an order reference into a short description for strPaymentReference


All requests for this function need to go to the following endpoint:


Example Minimal Request to pay an order for so that it falls into the Dispatch Queue:

<soapenv:Envelope xmlns:soapenv="" xmlns:tem="">
<soapenv:Header />
<tem:strPaymentReference>Payment made against external order: TEST23456</tem:strPaymentReference>

Example of Successful Response

<s:Envelope xmlns:s="">
<s:Body xmlns:xsi="" xmlns:xsd="">
<CreatePaymentResponse xmlns="">
<ErrorMessage />
<Errors />
Did this answer your question?