COconnexcs
Payment

Read

Changed on

Retrieve a single Payment record by ID.

get/api/cp/payment/{id}

Request

  • Base URL
    https://app.connexcs.com
  • Auth
    • OAuth 2
      Authorization code: https://auth.connexcs.com/authorize
      Token URL: https://auth.connexcs.com/token
    • or HTTP bearer

Path parameters

idinteger required

Id identifier

Response

Successful response

idinteger

Id

company_idinteger

Company Id

payment_timestring date-time

Payment Time

descriptionstring

Description

totalnumber

Total

tax_ratenumber

Tax Rate

invoice_idinteger

Invoice Id

currencystring

Currency

override_xenumber

Override Xe

payment_feenumber

Payment Fee

status'Completed' | 'Pending' | 'Canceled'

Status

payment_idstring

Payment Id

charge_idstring

Charge Id

reconciliation_idstring

Reconciliation Id

tax_paidnumber

Tax Paid

Example response

{
  "id": 12345,
  "company_id": 1,
  "payment_time": "2025-01-17T10:30:00Z",
  "description": "A detailed description of the resource",
  "total": 10,
  "tax_rate": 99.99,
  "invoice_id": 1,
  "currency": "USD",
  "override_xe": 1.5,
  "payment_fee": 99.99,
  "status": "Completed",
  "payment_id": 1,
  "charge_id": 1,
  "reconciliation_id": 1,
  "tax_paid": 99.99
}

Changes

  • fa097c4785b8Revision changes
    • info

      the endpoint scheme security oAuth2 was added to the API

    • info

      the endpoint scheme security opaqueToken was added to the API

    • info

      the endpoint scheme security basicAuth was removed from the API