Organization - Create
curl --request POST \
--url https://sandbox.birrpay.io/v2/organizations \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"organization_name": "organization_abc"
}
'import requests
url = "https://sandbox.birrpay.io/v2/organizations"
payload = { "organization_name": "organization_abc" }
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({organization_name: 'organization_abc'})
};
fetch('https://sandbox.birrpay.io/v2/organizations', 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://sandbox.birrpay.io/v2/organizations",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'organization_name' => 'organization_abc'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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://sandbox.birrpay.io/v2/organizations"
payload := strings.NewReader("{\n \"organization_name\": \"organization_abc\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
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.post("https://sandbox.birrpay.io/v2/organizations")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"organization_name\": \"organization_abc\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.birrpay.io/v2/organizations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"organization_name\": \"organization_abc\"\n}"
response = http.request(request)
puts response.read_body{
"id": "org_q98uSGAYbjEwqs0mJwnz",
"modified_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"organization_name": "<string>",
"organization_details": {},
"metadata": {},
"organization_type": "standard"
}Organization
Organization - Create
Create a new organization
POST
/
v2
/
organizations
Organization - Create
curl --request POST \
--url https://sandbox.birrpay.io/v2/organizations \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"organization_name": "organization_abc"
}
'import requests
url = "https://sandbox.birrpay.io/v2/organizations"
payload = { "organization_name": "organization_abc" }
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({organization_name: 'organization_abc'})
};
fetch('https://sandbox.birrpay.io/v2/organizations', 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://sandbox.birrpay.io/v2/organizations",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'organization_name' => 'organization_abc'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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://sandbox.birrpay.io/v2/organizations"
payload := strings.NewReader("{\n \"organization_name\": \"organization_abc\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
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.post("https://sandbox.birrpay.io/v2/organizations")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"organization_name\": \"organization_abc\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.birrpay.io/v2/organizations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"organization_name\": \"organization_abc\"\n}"
response = http.request(request)
puts response.read_body{
"id": "org_q98uSGAYbjEwqs0mJwnz",
"modified_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"organization_name": "<string>",
"organization_details": {},
"metadata": {},
"organization_type": "standard"
}Authorizations
Format: admin-api-key=<admin-api-key>
Admin API keys allow you to perform some privileged actions such as creating a merchant account and Connector account. This is only used during development.
Body
application/json
Response
Organization Created
The unique identifier for the Organization
Required string length:
1 - 64Example:
"org_q98uSGAYbjEwqs0mJwnz"
Name of the Organization
Details about the organization
Metadata is useful for storing additional, unstructured information on an object.
Available options:
standard, platform