Skip to main content
GET
/
payments
/
{payment_id}
Get a payment
curl --request GET \
  --url https://api.togai.com/payments/{payment_id} \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.togai.com/payments/{payment_id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.togai.com/payments/{payment_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.togai.com/payments/{payment_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.togai.com/payments/{payment_id}"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "Bearer <token>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.togai.com/payments/{payment_id}")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.togai.com/payments/{payment_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "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"
}
{
"message": "<Reason message>"
}
{
"message": "<Reason message>"
}
{
"message": "<Reason message>"
}
{
"message": "<Reason message>"
}
{
"message": "<Reason message>"
}
{
"message": "<Reason message>"
}

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<int32>

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

Example:

2

Response

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
totalAmount
number
required
currency
string
required
version
number
required
createdBy
string
required
createdAt
string<date-time>
required
description
string
notes
string