Skip to main content
GET
/
api
/
v1
/
driver
/
cash-settlements
/
{cashSettlementId}
Get Cash Settlement
curl --request GET \
  --url https://api.example.com/api/v1/driver/cash-settlements/{cashSettlementId} \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.example.com/api/v1/driver/cash-settlements/{cashSettlementId}"

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

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

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

fetch('https://api.example.com/api/v1/driver/cash-settlements/{cashSettlementId}', 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.example.com/api/v1/driver/cash-settlements/{cashSettlementId}",
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.example.com/api/v1/driver/cash-settlements/{cashSettlementId}"

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.example.com/api/v1/driver/cash-settlements/{cashSettlementId}")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/driver/cash-settlements/{cashSettlementId}")

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
{
  "cashSettlementId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "checkoutSessionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "paymentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "cooperativeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "transportOperatorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "driverId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "declaredAmount": 1,
  "submittedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "submittedAt": "2023-11-07T05:31:56Z",
  "confirmedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "confirmedAt": "2023-11-07T05:31:56Z",
  "rejectedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "rejectedAt": "2023-11-07T05:31:56Z",
  "rejectionReason": "<string>",
  "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "updatedAt": "2023-11-07T05:31:56Z"
}
{
"statusCode": 400,
"message": "Bad Request Error",
"errors": [
{
"code": "invalid_type",
"message": "Required",
"path": "name"
}
]
}
{
"statusCode": 404,
"error": "Not Found",
"message": "resource.not_found"
}
{
"statusCode": 404,
"error": "Not Found",
"message": "resource.not_found"
}
{
"statusCode": 404,
"error": "Not Found",
"message": "resource.not_found"
}
{
"statusCode": 404,
"error": "Not Found",
"message": "resource.not_found"
}

Authorizations

Authorization
string
header
required

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

Path Parameters

cashSettlementId
string<uuid>
required

Cash settlement identifier

Query Parameters

fields
string

Comma-separated list of fields to include in the response. Supports dot notation for nested projection.

Response

OK

Automatically submitted accountability record for one CASH checkout session.

cashSettlementId
string<uuid>
required

Cash settlement identifier.

checkoutSessionId
string<uuid>
required

Unique checkout session that originated the settlement.

paymentId
string<uuid> | null
required

Payment linked after cooperative confirmation.

organizationId
string<uuid>
required

Cooperative organization identifier.

cooperativeId
string<uuid>
required

Cooperative responsible for confirmation.

transportOperatorId
string<uuid>
required

Transport operator from the trip context.

driverId
string<uuid>
required

Driver responsible for the cash sale.

declaredAmount
integer
required

Amount automatically declared in cents.

Required range: x >= 0
status
enum<string>
required

Cash settlement status.

Available options:
PENDING,
CONFIRMED,
REJECTED
submittedBy
string<uuid>
required

User that confirmed the checkout session.

submittedAt
string<date-time>
required

Automatic submission date.

confirmedBy
string<uuid> | null
required

OPS user that confirmed the settlement.

confirmedAt
string<date-time> | null
required

Cooperative confirmation date.

rejectedBy
string<uuid> | null
required

OPS user that rejected the settlement.

rejectedAt
string<date-time> | null
required

Cooperative rejection date.

rejectionReason
string | null
required

Reason informed when the settlement is rejected.

createdBy
string<uuid> | null
required

User that created the record.

createdAt
string<date-time>
required

Creation date.

updatedBy
string<uuid> | null
required

User that last updated the record.

updatedAt
string<date-time>
required

Last update date.