curl --request GET \
--url https://api.exowpee.com/v1/accounting/payment-sources/{paymentSource} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.exowpee.com/v1/accounting/payment-sources/{paymentSource}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.exowpee.com/v1/accounting/payment-sources/{paymentSource}', 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.exowpee.com/v1/accounting/payment-sources/{paymentSource}",
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.exowpee.com/v1/accounting/payment-sources/{paymentSource}"
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.exowpee.com/v1/accounting/payment-sources/{paymentSource}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.exowpee.com/v1/accounting/payment-sources/{paymentSource}")
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": "<string>",
"company_id": "<string>",
"organization_id": "<string>",
"source_type": "<string>",
"source_id": "<string>",
"payment_method": "<string>",
"register_payment_method_id": "<string>",
"money_account_id": "<string>",
"functional_amount": 123,
"currency_code": "<string>",
"currency_exponent": 123,
"original_amount": 123,
"original_currency_code": "<string>",
"original_currency_exponent": 123,
"company_settlement_amount": 123,
"company_incoming_fee_snapshot": {},
"customer": {},
"customer_id": "<string>",
"order": {},
"reference": "<string>",
"received_at": "2023-11-07T05:31:56Z",
"accounting_status": "<string>",
"settlement_id": "<string>",
"settlement": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}{
"message": "<string>",
"errors": {}
}View a payment source (company)
Company space. Shows one recorded payment source.
curl --request GET \
--url https://api.exowpee.com/v1/accounting/payment-sources/{paymentSource} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.exowpee.com/v1/accounting/payment-sources/{paymentSource}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.exowpee.com/v1/accounting/payment-sources/{paymentSource}', 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.exowpee.com/v1/accounting/payment-sources/{paymentSource}",
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.exowpee.com/v1/accounting/payment-sources/{paymentSource}"
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.exowpee.com/v1/accounting/payment-sources/{paymentSource}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.exowpee.com/v1/accounting/payment-sources/{paymentSource}")
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": "<string>",
"company_id": "<string>",
"organization_id": "<string>",
"source_type": "<string>",
"source_id": "<string>",
"payment_method": "<string>",
"register_payment_method_id": "<string>",
"money_account_id": "<string>",
"functional_amount": 123,
"currency_code": "<string>",
"currency_exponent": 123,
"original_amount": 123,
"original_currency_code": "<string>",
"original_currency_exponent": 123,
"company_settlement_amount": 123,
"company_incoming_fee_snapshot": {},
"customer": {},
"customer_id": "<string>",
"order": {},
"reference": "<string>",
"received_at": "2023-11-07T05:31:56Z",
"accounting_status": "<string>",
"settlement_id": "<string>",
"settlement": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}{
"message": "<string>",
"errors": {}
}accounting_payment_sources.list
Conditions
- The accounting module must be active for the organization.
- This action is available only in the company space.
- A cheque payment source is refused, because cheques have their own resource.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Identifier of the payment source (27-character KSUID string).
Query Parameters
Response mode. Default resource; none answers 204 No Content.
resource Comma-separated JSON keys of the root resource (id is always rendered). Available: id, company_id, organization_id, source_type, source_id, payment_method, register_payment_method_id, money_account_id, functional_amount, currency_code, currency_exponent, original_amount, original_currency_code, original_currency_exponent, company_settlement_amount, company_incoming_fee_snapshot, customer, customer_id, order, reference, received_at, accounting_status, settlement_id, created_at, updated_at.
Comma-separated include paths, each optionally followed by its fields in parentheses: units(id,sku),units.uomUnit(id,name). Max depth 6, max 40 paths. Available: settlement.
Response
Resource.
Identifier of the payment source (27-character KSUID string).
Identifier of the company the record belongs to.
Identifier of the organization the record belongs to.
Kind of business record that received the payment, for example order_payment (a payment on an order) or customer_credit_payment (a customer paying off credit).
Identifier of that business record (27-character KSUID string). Unique per company and source_type.
Method used: cash, credit_card, bank_transfer, mobile_money, cheque or other. Cheque sources are not returned by this API.
Register payment method used at the point of sale (27-character KSUID string); null when none.
Money account the payment goes to (27-character KSUID string).
Amount in the company currency, an integer in minor units (divide by 10 to the power currency_exponent).
Company currency of functional_amount (ISO 4217 code).
Number of decimal places of the currency (0 for XOF). An amount in minor units divided by 10 to this power gives the amount in the currency.
Amount in the currency the customer paid in, an integer in minor units (divide by 10 to the power original_currency_exponent).
Currency the customer paid in (ISO 4217 code).
Number of decimal places of the original currency.
Amount the company expects to be settled, in minor units of the company currency: the functional amount minus the incoming fee, if any.
Frozen details of the incoming fee taken when the payment was recorded (gross_amount, net_amount, direction and the fee figures); null when no fee applied.
Customer who paid, as an object with id and name (both null when none).
Customer who paid (27-character KSUID string); null when none.
Order the payment belongs to, as an object with id and number (both null for payments without an order).
Payment reference recorded with the payment; null when none.
Date and time the payment was received (ISO 8601).
Where the payment stands in accounting: not_initiated (nothing posted yet), or the status of its settlement or cheque transfer (initiated, settled, cancelled, reversed, transferred).
Settlement attached to this payment (27-character KSUID string); null until one is created.
The settlement of the payment. Only returned when requested with ?include=settlement, to callers with the permission settlements.retrieve, and limited to your company.
Date and time the record was created (ISO 8601, UTC).
Date and time the record was last changed (ISO 8601, UTC).