Get Payment

coreplus API

The coreplus API provides access to appointment booking related end points, such as clients, practitioners, availability slots and appointments. It is a RESTful API, which utilises the HTTP verbs for creating viewing objects.

If you are a developer looking to create an external consumer server to server application for your coreplus clients, then by signing up for a sandbox account you will get access to your own trial coreplus account on our sandbox server with authorisation credentials.

If you have any questions regarding the API documentation, please do not hesitate to contact us at integrations@corepluspm.com

Get Payment

Required parameters	Type	Description
invoiceId	String	The id of Invoice to get the payment details

Example request URL: https://sandbox.coreplus.com.au/API/Core/v2/Payment/?invoiceId=db371ca8-f914-488d-a5ec-7c2edeb92285

Example response

{
   "invoiceId":"db371ca8-f914-488d-a5ec-7c2edeb92285",
   "lineItems":[
      {
         "lineItemId":"a1ad6ffa-f933-43bc-bd4a-b5a21deb65be",
         "payments":[
            {
               "amountPaid":"70",
               "datePaid":"2025-05-06",
               "paymentMethod":"Amex",
               "paymentNotes":"Full payment made",
               "type":"Credit"
            },
            {
               "amountPaid":"70.00",
               "datePaid":"2025-05-06",
               "paymentMethod":"BPay",
               "paymentNotes":"Refunded payment as user requested",
               "type":"Refund"
            }
         ]
      }
   ]
}

coreplus API

Develop with us