TOtogaihq
Payments

Get a payment

Changed on

Get payment

get/payments/{payment_id}

Request

Path parameters

payment_idstring required
Example:payment.1zYnCiM9Bpg.lv25y

Query parameters

versioninteger
Example:2

Optional version to get a specific version. Gets latest version if it is not provided.

Response

Response for POST payments requests

idstring required
descriptionstring
notesstring
accountIdstring required
totalAmountnumber required
currencystring required
versionnumber required
createdBystring required
createdAtstring date-time required

Example response

{
  "id": "pay.w123rwe.1231",
  "accountId": "ACC001",
  "lineItemRecords": [
    {
      "togaiId": "inv.234.12efwe"
    }
  ]
}

Changes

  • f22fc08442b7Revision changes
    • info

      the response property became required for the status

  • ea9c4628bfdbRevision changes
    • warning

      added the new CHEQUE enum value to the / response property for the response status

    • info

      removed the CHECK enum value from the / response property for the response status