Integrations
Create Invoice (Checkout)
To create an invoice, you first need to obtain the payment method ID.
- If you use the same payment method every time, request it from the support team.
- If you use different methods, send a request to the endpoint below.
Endpoint: /v1/payment-method/list
Method: GET
Response example:
{
"data": [
{
"id": "11111",
"title": "Cards International",
"countries": ["US", "GB", "FR"],
"currencies": ["USD", "EUR"],
"icon": "",
"fields": [
{
"name": "cardNumber",
"title": "card number"
},
{
"name": "holderName",
"title": "holder name"
}
]
},
{
"id": "11117",
"title": "Alipay",
"countries": ["CN"],
"currencies": ["CNY"],
"icon": "",
"fields": []
}
]
}
Use the id value as payment_method when creating an invoice.
Create Invoice
Endpoint: /v1/payment/create
Method: POST
Request (minimal parameters):
{
"amount": "10.03",
"currency": "USD",
"payment_method": "11111",
"save_card": "1",
"customer": {
"email": "[email protected]",
"name": "John Doe",
"ip": "192.168.1.1"
},
"urls": {
"success": "https://example.com/success",
"fail": "https://example.com/fail",
"notification": "https://example.com/notification"
},
"reference": "3d7d949e-94fb-4b8b-bc32-7c7f46bcd638",
"metadata": {
"key1": "value1",
"key2": "value2"
}
}
Request with Saved Card:
{
"amount": "10.03",
"currency": "USD",
"payment_method": "11111",
"customer": {
"email": "[email protected]",
"name": "John Doe",
"ip": "192.168.1.1"
},
"urls": {
"success": "https://example.com/success",
"fail": "https://example.com/fail",
"notification": "https://example.com/notification"
},
"reference": "3d7d949e-94fb-4b8b-bc32-7c7f46bcd638",
"card": {
"cardId": "050159eb-6af3-407c-84c0-ca1680711a77"
},
"metadata": {
"key1": "value1",
"key2": "value2"
}
}
Response:
{
"data": {
"payment_id": "...",
"amount": "10.03",
"currency": "USD",
"status": "pending",
"reference": "...",
"url": "https://api.beezyycashier.com/process/...",
"method": "get"
}
}
Redirect your customer to the url.
Update Payment Info
By Payment ID
Endpoint: /v1/payment/{payment_id}
Method: GET
By Reference
Endpoint: /v1/payment/by-reference/{reference}
Method: GET
Example Response
{
"data": {
"payment_id": "...",
"amount": "10.03",
"status": "success",
"transactions": [ ... ]
}
}
Refunds
Endpoint: /v1/refund/create
Method: POST
{
"reference": "...",
"payment_id": "...",
"amount": "10.03",
"currency": "USD"
}
Response:
{
"data": {
"refund_id": "...",
"amount": "10.03",
"status": "success",
"message": "Refund Accepted"
}
}
Save Card
Endpoint: /v1/client/card/save
Method: POST
{
"payment_method": "11111",
"customer": {
"email": "[email protected]",
"name": "John Doe",
"ip": "192.168.1.1"
},
"urls": {
"success": "https://example.com/success",
"fail": "https://example.com/fail",
"notification": "https://example.com/notification"
},
"reference": "...",
"metadata": {
"key1": "value1"
}
}
Client Info
By Email:
GET: /v1/client/[email protected]
By Card ID:
GET: /v1/client/card/{card_id}
Card Actions
- Deactivate:
GET /v1/client/card/deactivate/{card_id} - Activate:
GET /v1/client/card/activate/{card_id}
Withdrawals
Single:
POST: /v1/withdrawal/create
{
"reference": "...",
"amount": "10.03",
"currency": "USD",
"withdrawal_method_id": "22222",
"receiver": {
"cardNumber": "...",
"name": "John Doe",
"email": "[email protected]"
},
"urls": {
"notification": "https://example.com/notify"
}
}
Mass:
POST: /v1/withdrawal/create-mass
Body: array of withdrawal objects
By Stack ID:
GET: /v1/withdrawal/{stack_id}
Notification Signature
You can verify notifications by checking the signature header.
- Algorithm:
HMAC-SHA512 - Signature:
hash_hmac('sha512', raw_request_body, project_key) - Header:
signature - For withdrawal notifications, use the project's withdrawal key instead of the payment key.
- Hash the raw JSON body exactly as received — do not re-encode or reformat before hashing.
Signature examples
The snippets below produce the same lowercase hex output for the same raw_body and project_key.
PHP
$signature = hash_hmac('sha512', $rawBody, $projectKey);
Python
import hmac
import hashlib
signature = hmac.new(
project_key.encode('utf-8'),
raw_body.encode('utf-8'),
hashlib.sha512
).hexdigest()
Go
import (
"crypto/hmac"
"crypto/sha512"
"encoding/hex"
)
mac := hmac.New(sha512.New, []byte(projectKey))
mac.Write([]byte(rawBody))
signature := hex.EncodeToString(mac.Sum(nil))
Java
import javax.crypto.Mac;
import javax.crypto.spec.SecretKeySpec;
import java.nio.charset.StandardCharsets;
Mac mac = Mac.getInstance("HmacSHA512");
mac.init(new SecretKeySpec(
projectKey.getBytes(StandardCharsets.UTF_8),
"HmacSHA512"
));
byte[] hash = mac.doFinal(rawBody.getBytes(StandardCharsets.UTF_8));
StringBuilder sb = new StringBuilder();
for (byte b : hash) sb.append(String.format("%02x", b));
String signature = sb.toString();
Important: raw_body must be the exact bytes received from the HTTP request body, before any json_decode / json.loads. Decoding and re-encoding the JSON will change whitespace and key order, which will break signature verification.