curl --request POST \
--url https://api.zupy.com/api/v2/partner/credits/ \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"campaign_id": 2,
"quantity": "<string>",
"external_reference": "<string>",
"phone": "<string>",
"email": "jsmith@example.com",
"cpf": "<string>",
"wallet_address": "<string>",
"name": "<string>"
}
'import requests
url = "https://api.zupy.com/api/v2/partner/credits/"
payload = {
"campaign_id": 2,
"quantity": "<string>",
"external_reference": "<string>",
"phone": "<string>",
"email": "jsmith@example.com",
"cpf": "<string>",
"wallet_address": "<string>",
"name": "<string>"
}
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({
campaign_id: 2,
quantity: '<string>',
external_reference: '<string>',
phone: '<string>',
email: 'jsmith@example.com',
cpf: '<string>',
wallet_address: '<string>',
name: '<string>'
})
};
fetch('https://api.zupy.com/api/v2/partner/credits/', 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.zupy.com/api/v2/partner/credits/",
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([
'campaign_id' => 2,
'quantity' => '<string>',
'external_reference' => '<string>',
'phone' => '<string>',
'email' => 'jsmith@example.com',
'cpf' => '<string>',
'wallet_address' => '<string>',
'name' => '<string>'
]),
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.zupy.com/api/v2/partner/credits/"
payload := strings.NewReader("{\n \"campaign_id\": 2,\n \"quantity\": \"<string>\",\n \"external_reference\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"cpf\": \"<string>\",\n \"wallet_address\": \"<string>\",\n \"name\": \"<string>\"\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.zupy.com/api/v2/partner/credits/")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"campaign_id\": 2,\n \"quantity\": \"<string>\",\n \"external_reference\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"cpf\": \"<string>\",\n \"wallet_address\": \"<string>\",\n \"name\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zupy.com/api/v2/partner/credits/")
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 \"campaign_id\": 2,\n \"quantity\": \"<string>\",\n \"external_reference\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"cpf\": \"<string>\",\n \"wallet_address\": \"<string>\",\n \"name\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"external_reference": "<string>",
"campaign_id": 123,
"quantity": "<string>",
"unit": "<string>",
"unit_value": "<string>",
"amount": "<string>",
"customer_id": "<string>",
"status": "<string>",
"created_at": "2023-11-07T05:31:56Z"
}{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"external_reference": "<string>",
"campaign_id": 123,
"quantity": "<string>",
"unit": "<string>",
"unit_value": "<string>",
"amount": "<string>",
"customer_id": "<string>",
"status": "<string>",
"created_at": "2023-11-07T05:31:56Z"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"errors": [
{
"field": "<string>",
"detail": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}Credit Z$ to a user
Credits quantity units of one of your campaigns’ action to the user the identifiers point at — found, or created once, never duplicated. 201 a new credit; 200 an identical replay of the same external_reference (the same credit is returned, nothing is credited twice). Refusals are application/problem+json with a stable error_code. Scope partner.credit.
curl --request POST \
--url https://api.zupy.com/api/v2/partner/credits/ \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"campaign_id": 2,
"quantity": "<string>",
"external_reference": "<string>",
"phone": "<string>",
"email": "jsmith@example.com",
"cpf": "<string>",
"wallet_address": "<string>",
"name": "<string>"
}
'import requests
url = "https://api.zupy.com/api/v2/partner/credits/"
payload = {
"campaign_id": 2,
"quantity": "<string>",
"external_reference": "<string>",
"phone": "<string>",
"email": "jsmith@example.com",
"cpf": "<string>",
"wallet_address": "<string>",
"name": "<string>"
}
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({
campaign_id: 2,
quantity: '<string>',
external_reference: '<string>',
phone: '<string>',
email: 'jsmith@example.com',
cpf: '<string>',
wallet_address: '<string>',
name: '<string>'
})
};
fetch('https://api.zupy.com/api/v2/partner/credits/', 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.zupy.com/api/v2/partner/credits/",
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([
'campaign_id' => 2,
'quantity' => '<string>',
'external_reference' => '<string>',
'phone' => '<string>',
'email' => 'jsmith@example.com',
'cpf' => '<string>',
'wallet_address' => '<string>',
'name' => '<string>'
]),
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.zupy.com/api/v2/partner/credits/"
payload := strings.NewReader("{\n \"campaign_id\": 2,\n \"quantity\": \"<string>\",\n \"external_reference\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"cpf\": \"<string>\",\n \"wallet_address\": \"<string>\",\n \"name\": \"<string>\"\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.zupy.com/api/v2/partner/credits/")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"campaign_id\": 2,\n \"quantity\": \"<string>\",\n \"external_reference\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"cpf\": \"<string>\",\n \"wallet_address\": \"<string>\",\n \"name\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zupy.com/api/v2/partner/credits/")
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 \"campaign_id\": 2,\n \"quantity\": \"<string>\",\n \"external_reference\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"cpf\": \"<string>\",\n \"wallet_address\": \"<string>\",\n \"name\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"external_reference": "<string>",
"campaign_id": 123,
"quantity": "<string>",
"unit": "<string>",
"unit_value": "<string>",
"amount": "<string>",
"customer_id": "<string>",
"status": "<string>",
"created_at": "2023-11-07T05:31:56Z"
}{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"external_reference": "<string>",
"campaign_id": 123,
"quantity": "<string>",
"unit": "<string>",
"unit_value": "<string>",
"amount": "<string>",
"customer_id": "<string>",
"status": "<string>",
"created_at": "2023-11-07T05:31:56Z"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"errors": [
{
"field": "<string>",
"detail": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}Authorizations
Per-company partner API key (zupy_pk_…). Validated by Zupy against the company integration key hash (Story 14.x); send it on every request as the X-API-Key header. Scoped read-write to the owning company's data.
Body
Body of a credit. Your partner account is never in the body: it is the API key's.
x >= 1Units of the campaign's action (e.g. litres), > 0, at most 6 decimals.
^-?\d{0,18}(?:\.\d{0,6})?$The partner's own id for this credit. Same reference + same data = the same credit.
200322064255Response
A credit your partner account made.
^-?\d{0,18}(?:\.\d{0,6})?$^-?\d{0,16}(?:\.\d{0,2})?$^-?\d{0,16}(?:\.\d{0,2})?$settling: the Z$ is already spendable and its on-chain record is pending; settled: recorded on-chain; settlement_failed: the on-chain record failed for good; unknown: contact Zupy support.