curl --request PUT \
--url https://api.exowpee.com/v1/team/organization/money-accounts/{moneyAccountId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"is_active": true,
"companies": [
{
"company_id": "<string>",
"supports_incoming": true,
"supports_outgoing": true
}
],
"provider_reference": "<string>"
}
'import requests
url = "https://api.exowpee.com/v1/team/organization/money-accounts/{moneyAccountId}"
payload = {
"name": "<string>",
"is_active": True,
"companies": [
{
"company_id": "<string>",
"supports_incoming": True,
"supports_outgoing": True
}
],
"provider_reference": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
is_active: true,
companies: [{company_id: '<string>', supports_incoming: true, supports_outgoing: true}],
provider_reference: '<string>'
})
};
fetch('https://api.exowpee.com/v1/team/organization/money-accounts/{moneyAccountId}', 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/team/organization/money-accounts/{moneyAccountId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'is_active' => true,
'companies' => [
[
'company_id' => '<string>',
'supports_incoming' => true,
'supports_outgoing' => true
]
],
'provider_reference' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.exowpee.com/v1/team/organization/money-accounts/{moneyAccountId}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"is_active\": true,\n \"companies\": [\n {\n \"company_id\": \"<string>\",\n \"supports_incoming\": true,\n \"supports_outgoing\": true\n }\n ],\n \"provider_reference\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.exowpee.com/v1/team/organization/money-accounts/{moneyAccountId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"is_active\": true,\n \"companies\": [\n {\n \"company_id\": \"<string>\",\n \"supports_incoming\": true,\n \"supports_outgoing\": true\n }\n ],\n \"provider_reference\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.exowpee.com/v1/team/organization/money-accounts/{moneyAccountId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"is_active\": true,\n \"companies\": [\n {\n \"company_id\": \"<string>\",\n \"supports_incoming\": true,\n \"supports_outgoing\": true\n }\n ],\n \"provider_reference\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"type": "<string>",
"accepted_payment_methods": [
"<unknown>"
],
"is_active": true,
"provider": "<string>",
"provider_reference": "<string>",
"supports_incoming": true,
"supports_outgoing": true,
"organization_id": "<string>",
"accounting_account_id": "<string>",
"companies": "<array>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}{
"message": "<string>",
"errors": {}
}Update a money account
Renames a money account, switches it on or off, edits its provider reference and replaces the companies that can use it. The type and provider cannot be changed.
curl --request PUT \
--url https://api.exowpee.com/v1/team/organization/money-accounts/{moneyAccountId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"is_active": true,
"companies": [
{
"company_id": "<string>",
"supports_incoming": true,
"supports_outgoing": true
}
],
"provider_reference": "<string>"
}
'import requests
url = "https://api.exowpee.com/v1/team/organization/money-accounts/{moneyAccountId}"
payload = {
"name": "<string>",
"is_active": True,
"companies": [
{
"company_id": "<string>",
"supports_incoming": True,
"supports_outgoing": True
}
],
"provider_reference": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
is_active: true,
companies: [{company_id: '<string>', supports_incoming: true, supports_outgoing: true}],
provider_reference: '<string>'
})
};
fetch('https://api.exowpee.com/v1/team/organization/money-accounts/{moneyAccountId}', 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/team/organization/money-accounts/{moneyAccountId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'is_active' => true,
'companies' => [
[
'company_id' => '<string>',
'supports_incoming' => true,
'supports_outgoing' => true
]
],
'provider_reference' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.exowpee.com/v1/team/organization/money-accounts/{moneyAccountId}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"is_active\": true,\n \"companies\": [\n {\n \"company_id\": \"<string>\",\n \"supports_incoming\": true,\n \"supports_outgoing\": true\n }\n ],\n \"provider_reference\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.exowpee.com/v1/team/organization/money-accounts/{moneyAccountId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"is_active\": true,\n \"companies\": [\n {\n \"company_id\": \"<string>\",\n \"supports_incoming\": true,\n \"supports_outgoing\": true\n }\n ],\n \"provider_reference\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.exowpee.com/v1/team/organization/money-accounts/{moneyAccountId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"is_active\": true,\n \"companies\": [\n {\n \"company_id\": \"<string>\",\n \"supports_incoming\": true,\n \"supports_outgoing\": true\n }\n ],\n \"provider_reference\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"type": "<string>",
"accepted_payment_methods": [
"<unknown>"
],
"is_active": true,
"provider": "<string>",
"provider_reference": "<string>",
"supports_incoming": true,
"supports_outgoing": true,
"organization_id": "<string>",
"accounting_account_id": "<string>",
"companies": "<array>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}{
"message": "<string>",
"errors": {}
}money_accounts.update
Conditions
- The call is refused when the organization’s pricing plan does not include the accounting module.
- The name, when sent, must stay unique among the organization’s money accounts (the account itself is excluded from the check).
- The type cannot be changed. The provider is set at creation and cannot be changed; on a mobile money account a provider sent here is ignored.
- A provider or provider reference value is refused when the stored account is not a mobile money account.
- When companies are sent, each company must be active and belong to the organization, may appear only once, and must be allowed at least one direction.
- When companies is sent, the list of linked companies is replaced by the list sent: companies left out lose their access, and directions are updated for the others.
- The matching account in the books is not renamed.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Identifier of the money account (27-character KSUID string).
Query Parameters
Response mode. Default none; none answers 204 No Content.
none, resource Comma-separated JSON keys of the root resource (id is always rendered). Available: id, name, type, accepted_payment_methods, is_active, provider, provider_reference, supports_incoming, supports_outgoing, organization_id, accounting_account_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: companies.
Body
Name of the account, at most 255 characters and unique among the organization's money accounts; surrounding spaces are removed. Required on creation.
255Kind of account: bank or mobile_money. Required on creation; ignored on update, because the type cannot change.
bank, mobile_money Whether the account is switched on. Required on creation.
The companies allowed to use the account. Required on creation (an empty list is allowed). On update, when sent, it replaces the whole list of linked companies.
Show child attributes
Show child attributes
Mobile money provider (orange_money, mtn_momo, moov_money, wave, cinetpay, paydunya, fedapay or other). Optional. Accepted only for a mobile money account and refused for a bank account. It is set at creation; on update it is ignored for a mobile money account.
orange_money, mtn_momo, moov_money, wave, cinetpay, paydunya, fedapay, other Reference of the account at the mobile money provider, at most 255 characters. Accepted only for a mobile money account. Optional.
255Response
Resource (only with response=resource).
Identifier of the money account (27-character KSUID string).
Name of the account, unique within the organization.
Kind of account: bank or mobile_money.
Payment methods this account accepts, derived from its type (bank: bank_transfer, cheque, credit_card; mobile_money: mobile_money) and limited to the methods the organization's pricing plan allows.
Whether the account is switched on.
Mobile money provider (orange_money, mtn_momo, moov_money, wave, cinetpay, paydunya, fedapay or other). Only organization sessions see it; null for a bank account.
Free reference of the account at the provider, for mobile money accounts. Only organization sessions see it.
Whether the current company may receive payments through the account. Only returned in the company space.
Whether the current company may send payments through the account. Only returned in the company space.
Identifier of the organization the record belongs to.
Identifier of the matching account in the organization's books, created with the money account. Only organization sessions see it.
Companies linked to the account with their directions. Returned only to organization sessions and only when requested with include=companies.
Date and time the record was created (ISO 8601, UTC).
Date and time the record was last changed (ISO 8601, UTC).