Skip to main content
POST
/
v1
/
customer-credits
/
accounts
/
{id}
/
credit
Credit an account
curl --request POST \
  --url https://api.creem.io/v1/customer-credits/accounts/{id}/credit \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "amount": "1000",
  "reference": "signup_bonus",
  "idempotency_key": "idem_abc123"
}
'
import requests

url = "https://api.creem.io/v1/customer-credits/accounts/{id}/credit"

payload = {
"amount": "1000",
"reference": "signup_bonus",
"idempotency_key": "idem_abc123"
}
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({amount: '1000', reference: 'signup_bonus', idempotency_key: 'idem_abc123'})
};

fetch('https://api.creem.io/v1/customer-credits/accounts/{id}/credit', 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/accounts/{id}/credit",
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([
'amount' => '1000',
'reference' => 'signup_bonus',
'idempotency_key' => 'idem_abc123'
]),
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/accounts/{id}/credit"

payload := strings.NewReader("{\n \"amount\": \"1000\",\n \"reference\": \"signup_bonus\",\n \"idempotency_key\": \"idem_abc123\"\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/accounts/{id}/credit")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": \"1000\",\n \"reference\": \"signup_bonus\",\n \"idempotency_key\": \"idem_abc123\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.creem.io/v1/customer-credits/accounts/{id}/credit")

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 \"amount\": \"1000\",\n \"reference\": \"signup_bonus\",\n \"idempotency_key\": \"idem_abc123\"\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",
      "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"
}
}

Authorizations

x-api-key
string
header
required

API key for authentication. You can find your API key in the Creem dashboard under Settings > API Keys.

Path Parameters

id
string
required

Body

application/json
amount
string
required

Amount to credit or debit (string to support large numbers)

Example:

"1000"

reference
string
required

Your reference ID to link this transaction to an event in your system (e.g. order ID, campaign ID)

Example:

"signup_bonus"

idempotency_key
string
required

Idempotency key to prevent duplicate transactions

Example:

"idem_abc123"

Response

Credit transaction created

id
string
required

Transaction ID

Example:

"cct_abc123"

store_id
string
required

Store ID

reference
string
required

Reference string

Example:

"order_xyz"

idempotency_key
string
required

Idempotency key

entries
object[]
required

Transaction entries

created_at
string
required

Creation timestamp

reversal_of
object

ID of the transaction this reverses, if applicable

Example:

"cct_abc123"