Post a transaction
curl --request POST \
--url https://api.creem.io/v1/customer-credits/transactions \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"reference": "order_xyz",
"idempotency_key": "idem_abc123",
"entries": [
{
"account_id": "cca_abc123",
"amount": "1000"
}
]
}
'import requests
url = "https://api.creem.io/v1/customer-credits/transactions"
payload = {
"reference": "order_xyz",
"idempotency_key": "idem_abc123",
"entries": [
{
"account_id": "cca_abc123",
"amount": "1000"
}
]
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
reference: 'order_xyz',
idempotency_key: 'idem_abc123',
entries: [{account_id: 'cca_abc123', amount: '1000'}]
})
};
fetch('https://api.creem.io/v1/customer-credits/transactions', 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.creem.io/v1/customer-credits/transactions",
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([
'reference' => 'order_xyz',
'idempotency_key' => 'idem_abc123',
'entries' => [
[
'account_id' => 'cca_abc123',
'amount' => '1000'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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.creem.io/v1/customer-credits/transactions"
payload := strings.NewReader("{\n \"reference\": \"order_xyz\",\n \"idempotency_key\": \"idem_abc123\",\n \"entries\": [\n {\n \"account_id\": \"cca_abc123\",\n \"amount\": \"1000\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<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://api.creem.io/v1/customer-credits/transactions")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"reference\": \"order_xyz\",\n \"idempotency_key\": \"idem_abc123\",\n \"entries\": [\n {\n \"account_id\": \"cca_abc123\",\n \"amount\": \"1000\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.creem.io/v1/customer-credits/transactions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"reference\": \"order_xyz\",\n \"idempotency_key\": \"idem_abc123\",\n \"entries\": [\n {\n \"account_id\": \"cca_abc123\",\n \"amount\": \"1000\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "cct_abc123",
"store_id": "<string>",
"reference": "order_xyz",
"idempotency_key": "<string>",
"entries": [
{
"id": "cce_abc123",
"transaction_id": "cct_abc123",
"account_id": "cca_abc123",
"side": "debit",
"amount": "1000",
"created_at": "<string>"
}
],
"created_at": "<string>",
"reversal_of": "cct_abc123"
}{
"error": {
"type": "invalid_request_error",
"code": "unbalanced_transaction",
"message": "Total debits must equal total credits",
"request_id": "req_abc123def456",
"param": "entries"
}
}{
"error": {
"type": "invalid_request_error",
"code": "unbalanced_transaction",
"message": "Total debits must equal total credits",
"request_id": "req_abc123def456",
"param": "entries"
}
}Customer Credits
Post a transaction
Post a multi-entry transaction across accounts. Entries must balance: total debits must equal total credits.
POST
/
v1
/
customer-credits
/
transactions
Post a transaction
curl --request POST \
--url https://api.creem.io/v1/customer-credits/transactions \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"reference": "order_xyz",
"idempotency_key": "idem_abc123",
"entries": [
{
"account_id": "cca_abc123",
"amount": "1000"
}
]
}
'import requests
url = "https://api.creem.io/v1/customer-credits/transactions"
payload = {
"reference": "order_xyz",
"idempotency_key": "idem_abc123",
"entries": [
{
"account_id": "cca_abc123",
"amount": "1000"
}
]
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
reference: 'order_xyz',
idempotency_key: 'idem_abc123',
entries: [{account_id: 'cca_abc123', amount: '1000'}]
})
};
fetch('https://api.creem.io/v1/customer-credits/transactions', 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.creem.io/v1/customer-credits/transactions",
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([
'reference' => 'order_xyz',
'idempotency_key' => 'idem_abc123',
'entries' => [
[
'account_id' => 'cca_abc123',
'amount' => '1000'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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.creem.io/v1/customer-credits/transactions"
payload := strings.NewReader("{\n \"reference\": \"order_xyz\",\n \"idempotency_key\": \"idem_abc123\",\n \"entries\": [\n {\n \"account_id\": \"cca_abc123\",\n \"amount\": \"1000\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<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://api.creem.io/v1/customer-credits/transactions")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"reference\": \"order_xyz\",\n \"idempotency_key\": \"idem_abc123\",\n \"entries\": [\n {\n \"account_id\": \"cca_abc123\",\n \"amount\": \"1000\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.creem.io/v1/customer-credits/transactions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"reference\": \"order_xyz\",\n \"idempotency_key\": \"idem_abc123\",\n \"entries\": [\n {\n \"account_id\": \"cca_abc123\",\n \"amount\": \"1000\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "cct_abc123",
"store_id": "<string>",
"reference": "order_xyz",
"idempotency_key": "<string>",
"entries": [
{
"id": "cce_abc123",
"transaction_id": "cct_abc123",
"account_id": "cca_abc123",
"side": "debit",
"amount": "1000",
"created_at": "<string>"
}
],
"created_at": "<string>",
"reversal_of": "cct_abc123"
}{
"error": {
"type": "invalid_request_error",
"code": "unbalanced_transaction",
"message": "Total debits must equal total credits",
"request_id": "req_abc123def456",
"param": "entries"
}
}{
"error": {
"type": "invalid_request_error",
"code": "unbalanced_transaction",
"message": "Total debits must equal total credits",
"request_id": "req_abc123def456",
"param": "entries"
}
}Authorizations
API key for authentication. You can find your API key in the Creem dashboard under Settings > API Keys.
Body
application/json
Your reference ID to link this transaction to an event in your system
Example:
"order_xyz"
Idempotency key to prevent duplicate transactions
Example:
"idem_abc123"
Array of entries. Must have at least 2 entries and the total debits must equal total credits.
Show child attributes
Show child attributes
Response
Transaction posted
Transaction ID
Example:
"cct_abc123"
Store ID
Reference string
Example:
"order_xyz"
Idempotency key
Transaction entries
Show child attributes
Show child attributes
Creation timestamp
ID of the transaction this reverses, if applicable
Example:
"cct_abc123"