GET
/
payments
/
{payment_id}
curl --request GET \
  --url https://api.togai.com/payments/{payment_id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "payment.1223dfs.234ds",
  "description": "Payment for services",
  "notes": "Invoice payment",
  "accountId": "acc123",
  "currency": "USD",
  "externalPaymentReferences": {
    "sourceName": "XYZ Company",
    "sourceType": "CARD",
    "transactionNumber": "TXN123",
    "description": "Card payment"
  },
  "lineItemRecords": [
    {
      "togaiId": "inv.234.12efwe",
      "amount": 1000,
      "type": "INVOICE",
      "order": 1
    },
    {
      "togaiId": "inv.235.12efwe",
      "amount": 600,
      "type": "INVOICE",
      "order": 2
    },
    {
      "togaiId": "cred.236.12efwe",
      "amount": 100,
      "type": "CREDIT",
      "order": 3
    }
  ],
  "totalAmount": 1700,
  "version": 1,
  "createdBy": "user123",
  "createdAt": "2023-01-01T12:00:00"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
payment_id
string
required
Example:

"payment.1zYnCiM9Bpg.lv25y"

Query Parameters

​
version
integer

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

Example:

2

Response

200
application/json
Response for POST payments requests

Payment object

​
id
string
required
Example:

"pay.w123rwe.1231"

​
accountId
string
required
Example:

"ACC001"

​
externalPaymentReferences
object
required

external payment reference object

​
lineItemRecords
object[]
required

payment line item record object

​
totalAmount
number
required
​
currency
string
required
​
version
number
required
​
createdBy
string
required
​
createdAt
string
required
​
description
string
​
notes
string
List all paymentscreate payments