Get credit details

curl --request GET \
  --url https://api.togai.com/credits/{credit_id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.togai.com/credits/{credit_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/credits/{credit_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/credits/{credit_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))

}

require 'uri'
require 'net/http'

url = URI("https://api.togai.com/credits/{credit_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

{
  "accountId": "ACC001",
  "purpose": "PREPAID_CREDIT",
  "effectiveFrom": "2020-07-04",
  "priority": 1,
  "id": "cred.1znqBOVcai0.0tBFz",
  "customerId": "7VcRw9xZDIqsC5E",
  "status": "ACTIVE",
  "createdAt": "2023-11-07T05:31:56Z",
  "transactions": [
    {
      "id": "<string>",
      "creditId": "<string>",
      "transactionType": "CREDITED",
      "amount": 200,
      "createdAt": "2023-11-07T05:31:56Z",
      "invoiceId": "<string>"
    }
  ],
  "applicableEntityIds": [
    [
      "umg.1znQx9jiIXw.r44fc",
      "ALL_USAGE_METER_RATE_CARDS",
      "ALL_FIXED_FEE_RATE_CARDS"
    ]
  ],
  "effectiveUntil": "2021-07-04",
  "creditAmount": 1000,
  "grantorId": "<string>",
  "idempotencyKey": "<string>",
  "creditUnit": "USD",
  "holdAmount": 500,
  "consumedAmount": 400,
  "updatedAt": "2023-11-07T05:31:56Z"
}

{
  "message": "<Reason message>"
}

{
  "message": "<Reason message>"
}

{
  "message": "<Reason message>"
}

{
  "message": "<Reason message>"
}

{
  "message": "<Reason message>"
}

{
  "message": "<Reason message>"
}

GET

credits

{credit_id}

Get credit details

curl --request GET \
  --url https://api.togai.com/credits/{credit_id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.togai.com/credits/{credit_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/credits/{credit_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/credits/{credit_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))

}

require 'uri'
require 'net/http'

url = URI("https://api.togai.com/credits/{credit_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

{
  "accountId": "ACC001",
  "purpose": "PREPAID_CREDIT",
  "effectiveFrom": "2020-07-04",
  "priority": 1,
  "id": "cred.1znqBOVcai0.0tBFz",
  "customerId": "7VcRw9xZDIqsC5E",
  "status": "ACTIVE",
  "createdAt": "2023-11-07T05:31:56Z",
  "transactions": [
    {
      "id": "<string>",
      "creditId": "<string>",
      "transactionType": "CREDITED",
      "amount": 200,
      "createdAt": "2023-11-07T05:31:56Z",
      "invoiceId": "<string>"
    }
  ],
  "applicableEntityIds": [
    [
      "umg.1znQx9jiIXw.r44fc",
      "ALL_USAGE_METER_RATE_CARDS",
      "ALL_FIXED_FEE_RATE_CARDS"
    ]
  ],
  "effectiveUntil": "2021-07-04",
  "creditAmount": 1000,
  "grantorId": "<string>",
  "idempotencyKey": "<string>",
  "creditUnit": "USD",
  "holdAmount": 500,
  "consumedAmount": 400,
  "updatedAt": "2023-11-07T05:31:56Z"
}

{
  "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

credit_id

string

required

Example:

"creds.1znQx9jiIXw.r44fc"

Response

Response for Fetch Credit Details request. This contains Credit Transactions

Payload to grant Credits

accountId

string

required

Example:

"ACC001"

purpose

string

required

Example:

"PREPAID_CREDIT"

effectiveFrom

string<date>

required

Example:

"2020-07-04"

priority

integer

required

Example:

1

string

required

Identifier of credits

Maximum string length: 50

Example:

"cred.1znqBOVcai0.0tBFz"

customerId

string

required

Example:

"7VcRw9xZDIqsC5E"

status

enum<string>

required

Available options:

ACTIVE,

CONSUMED,

EXPIRED,

VOIDED

Example:

"ACTIVE"

createdAt

string<date-time>

required

transactions

object[]

required

Show child attributes

applicableEntityIds

string[]

List of entity ids for which the credit is applicable. If null or empty, the credit is applicable to all ids. This list can accept special values like: - ALL_USAGE_METER_RATE_CARDS: To apply the credit to all usage meter rate cards - ALL_FIXED_FEE_RATE_CARDS: To apply the credit to all fixed fee rate cards

effectiveUntil

string<date>

Example:

"2021-07-04"

creditAmount

number

Example:

1000

grantorId

string

The entity through which the credit has been granted

idempotencyKey

string

The idempotency key for uniqueness of the credit record

creditUnit

string

Example:

"USD"

holdAmount

number

Example:

500

consumedAmount

number

Example:

400

updatedAt

string<date-time>

Introduction

APIs

Get credit details

Authorizations

Path Parameters

Response