curl -X GET "https://api.chariow.com/v1/sales/sal_abc123xyz" \
-H "Authorization: Bearer sk_live_your_api_key"
{
"message": "success",
"data": {
"id": "sal_abc123xyz",
"status": "completed",
"channel": {
"value": "store",
"label": "Store",
"description": "Sale made through the store checkout"
},
"amount": {
"value": 79.20,
"formatted": "$79.20",
"short": "79",
"currency": "USD"
},
"original_amount": {
"value": 99,
"formatted": "$99.00",
"short": "99",
"currency": "USD"
},
"discount_amount": {
"value": 19.80,
"formatted": "$19.80",
"short": "20",
"currency": "USD"
},
"settlement": {
"amount": {
"value": 75.24,
"formatted": "$75.24",
"short": "75",
"currency": "USD"
},
"due_at": "2025-02-01T00:00:00+00:00",
"done_at": "2025-02-01T10:15:00+00:00",
"service_fee": {
"value": 3.96,
"formatted": "$3.96",
"short": "4",
"currency": "USD"
}
},
"download": {
"total": 3,
"last_at": "2025-01-20T14:30:00+00:00"
},
"payment": {
"status": "success",
"transaction_id": "txn_moneroo_xyz789",
"gateway": "moneroo",
"method": {
"id": "card",
"name": "Credit/Debit Card",
"type": "card"
},
"amount": {
"value": 79.20,
"formatted": "$79.20",
"short": "79",
"currency": "USD"
},
"fee": {
"value": 2.37,
"formatted": "$2.37",
"short": "2",
"currency": "USD"
},
"fee_rate": "3.00%",
"interchange": {
"rate": "0.50%",
"fee": {
"value": 0.40,
"formatted": "$0.40",
"short": "0",
"currency": "USD"
}
},
"exchange_rate": {
"value": 1.0,
"formatted": "$1.00",
"short": "1",
"currency": "USD"
},
"failure_error": null
},
"shipping": {
"address": "123 Main Street",
"city": "New York",
"state": "NY",
"country": {
"code": "US",
"name": "United States"
},
"zip": "10001"
},
"context": {
"user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36",
"ip_address": "203.0.113.42",
"country": {
"code": "US",
"name": "United States"
},
"device_type": "desktop",
"locale": "en_US"
},
"custom_fields_values": {
"company_name": "Acme Corp",
"vat_number": "GB123456789"
},
"campaign": {
"id": "cmp_def456",
"name": "Black Friday Campaign",
"tracking_code": "BF2025"
},
"rating": {
"id": "rat_ghi789",
"value": 5,
"comment": "Excellent product!",
"created_at": "2025-01-18T09:00:00+00:00"
},
"store": {
"id": "str_xyz789",
"name": "My Digital Store",
"slug": "my-digital-store"
},
"product": {
"id": "prd_jkl012",
"name": "Advanced Laravel Course",
"slug": "advanced-laravel-course",
"type": "course"
},
"customer": {
"id": "cus_mno345",
"email": "customer@example.com",
"name": "John Doe",
"first_name": "John",
"last_name": "Doe"
},
"discount": {
"id": "dis_pqr678",
"code": "SAVE20",
"type": "percentage",
"value": 20
},
"is_reconciled": true,
"last_reconciled_at": "2025-01-16T08:00:00+00:00",
"failed_at": null,
"awaiting_payment_at": "2025-01-15T10:30:00+00:00",
"abandoned_at": null,
"completed_at": "2025-01-15T10:32:00+00:00",
"created_at": "2025-01-15T10:30:00+00:00",
"updated_at": "2025-01-15T10:32:00+00:00"
},
"errors": []
}
Sales
Get Sale
Retrieve details of a specific sale
curl -X GET "https://api.chariow.com/v1/sales/sal_abc123xyz" \
-H "Authorization: Bearer sk_live_your_api_key"
{
"message": "success",
"data": {
"id": "sal_abc123xyz",
"status": "completed",
"channel": {
"value": "store",
"label": "Store",
"description": "Sale made through the store checkout"
},
"amount": {
"value": 79.20,
"formatted": "$79.20",
"short": "79",
"currency": "USD"
},
"original_amount": {
"value": 99,
"formatted": "$99.00",
"short": "99",
"currency": "USD"
},
"discount_amount": {
"value": 19.80,
"formatted": "$19.80",
"short": "20",
"currency": "USD"
},
"settlement": {
"amount": {
"value": 75.24,
"formatted": "$75.24",
"short": "75",
"currency": "USD"
},
"due_at": "2025-02-01T00:00:00+00:00",
"done_at": "2025-02-01T10:15:00+00:00",
"service_fee": {
"value": 3.96,
"formatted": "$3.96",
"short": "4",
"currency": "USD"
}
},
"download": {
"total": 3,
"last_at": "2025-01-20T14:30:00+00:00"
},
"payment": {
"status": "success",
"transaction_id": "txn_moneroo_xyz789",
"gateway": "moneroo",
"method": {
"id": "card",
"name": "Credit/Debit Card",
"type": "card"
},
"amount": {
"value": 79.20,
"formatted": "$79.20",
"short": "79",
"currency": "USD"
},
"fee": {
"value": 2.37,
"formatted": "$2.37",
"short": "2",
"currency": "USD"
},
"fee_rate": "3.00%",
"interchange": {
"rate": "0.50%",
"fee": {
"value": 0.40,
"formatted": "$0.40",
"short": "0",
"currency": "USD"
}
},
"exchange_rate": {
"value": 1.0,
"formatted": "$1.00",
"short": "1",
"currency": "USD"
},
"failure_error": null
},
"shipping": {
"address": "123 Main Street",
"city": "New York",
"state": "NY",
"country": {
"code": "US",
"name": "United States"
},
"zip": "10001"
},
"context": {
"user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36",
"ip_address": "203.0.113.42",
"country": {
"code": "US",
"name": "United States"
},
"device_type": "desktop",
"locale": "en_US"
},
"custom_fields_values": {
"company_name": "Acme Corp",
"vat_number": "GB123456789"
},
"campaign": {
"id": "cmp_def456",
"name": "Black Friday Campaign",
"tracking_code": "BF2025"
},
"rating": {
"id": "rat_ghi789",
"value": 5,
"comment": "Excellent product!",
"created_at": "2025-01-18T09:00:00+00:00"
},
"store": {
"id": "str_xyz789",
"name": "My Digital Store",
"slug": "my-digital-store"
},
"product": {
"id": "prd_jkl012",
"name": "Advanced Laravel Course",
"slug": "advanced-laravel-course",
"type": "course"
},
"customer": {
"id": "cus_mno345",
"email": "customer@example.com",
"name": "John Doe",
"first_name": "John",
"last_name": "Doe"
},
"discount": {
"id": "dis_pqr678",
"code": "SAVE20",
"type": "percentage",
"value": 20
},
"is_reconciled": true,
"last_reconciled_at": "2025-01-16T08:00:00+00:00",
"failed_at": null,
"awaiting_payment_at": "2025-01-15T10:30:00+00:00",
"abandoned_at": null,
"completed_at": "2025-01-15T10:32:00+00:00",
"created_at": "2025-01-15T10:30:00+00:00",
"updated_at": "2025-01-15T10:32:00+00:00"
},
"errors": []
}
Retrieves comprehensive information about a specific sale by its public ID, including customer details, product information, payment details, applied discounts, marketing campaign, shipping information, and customer rating.
Path Parameters
The unique sale public identifier (e.g.,
sal_abc123xyz)Response
Show properties
Show properties
Unique sale identifier (e.g.,
sal_abc123xyz)Sale status (
awaiting_payment, completed, failed, abandoned, settled)Original amount before discount
Discount amount applied
Payment details
Show payment object
Show payment object
Payment status (
initiated, pending, cancelled, failed, success)Payment gateway transaction ID
Payment gateway used
Payment method details (card, mobile money, etc.)
Amount paid in payment currency
Payment processing fee
Payment fee rate as percentage
Interchange markup details
Exchange rate if multi-currency
Payment failure error details (if failed)
Custom field values provided during checkout
Marketing campaign (if tracked)
Customer rating (if provided)
Store information
Product information
Customer information
Applied discount (if any)
Whether sale has been reconciled
ISO 8601 timestamp of last reconciliation
ISO 8601 timestamp when sale failed
ISO 8601 timestamp when sale entered awaiting payment status
ISO 8601 timestamp when sale was abandoned
ISO 8601 timestamp when sale was completed
ISO 8601 timestamp when sale was created
ISO 8601 timestamp when sale was last updated
curl -X GET "https://api.chariow.com/v1/sales/sal_abc123xyz" \
-H "Authorization: Bearer sk_live_your_api_key"
{
"message": "success",
"data": {
"id": "sal_abc123xyz",
"status": "completed",
"channel": {
"value": "store",
"label": "Store",
"description": "Sale made through the store checkout"
},
"amount": {
"value": 79.20,
"formatted": "$79.20",
"short": "79",
"currency": "USD"
},
"original_amount": {
"value": 99,
"formatted": "$99.00",
"short": "99",
"currency": "USD"
},
"discount_amount": {
"value": 19.80,
"formatted": "$19.80",
"short": "20",
"currency": "USD"
},
"settlement": {
"amount": {
"value": 75.24,
"formatted": "$75.24",
"short": "75",
"currency": "USD"
},
"due_at": "2025-02-01T00:00:00+00:00",
"done_at": "2025-02-01T10:15:00+00:00",
"service_fee": {
"value": 3.96,
"formatted": "$3.96",
"short": "4",
"currency": "USD"
}
},
"download": {
"total": 3,
"last_at": "2025-01-20T14:30:00+00:00"
},
"payment": {
"status": "success",
"transaction_id": "txn_moneroo_xyz789",
"gateway": "moneroo",
"method": {
"id": "card",
"name": "Credit/Debit Card",
"type": "card"
},
"amount": {
"value": 79.20,
"formatted": "$79.20",
"short": "79",
"currency": "USD"
},
"fee": {
"value": 2.37,
"formatted": "$2.37",
"short": "2",
"currency": "USD"
},
"fee_rate": "3.00%",
"interchange": {
"rate": "0.50%",
"fee": {
"value": 0.40,
"formatted": "$0.40",
"short": "0",
"currency": "USD"
}
},
"exchange_rate": {
"value": 1.0,
"formatted": "$1.00",
"short": "1",
"currency": "USD"
},
"failure_error": null
},
"shipping": {
"address": "123 Main Street",
"city": "New York",
"state": "NY",
"country": {
"code": "US",
"name": "United States"
},
"zip": "10001"
},
"context": {
"user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36",
"ip_address": "203.0.113.42",
"country": {
"code": "US",
"name": "United States"
},
"device_type": "desktop",
"locale": "en_US"
},
"custom_fields_values": {
"company_name": "Acme Corp",
"vat_number": "GB123456789"
},
"campaign": {
"id": "cmp_def456",
"name": "Black Friday Campaign",
"tracking_code": "BF2025"
},
"rating": {
"id": "rat_ghi789",
"value": 5,
"comment": "Excellent product!",
"created_at": "2025-01-18T09:00:00+00:00"
},
"store": {
"id": "str_xyz789",
"name": "My Digital Store",
"slug": "my-digital-store"
},
"product": {
"id": "prd_jkl012",
"name": "Advanced Laravel Course",
"slug": "advanced-laravel-course",
"type": "course"
},
"customer": {
"id": "cus_mno345",
"email": "customer@example.com",
"name": "John Doe",
"first_name": "John",
"last_name": "Doe"
},
"discount": {
"id": "dis_pqr678",
"code": "SAVE20",
"type": "percentage",
"value": 20
},
"is_reconciled": true,
"last_reconciled_at": "2025-01-16T08:00:00+00:00",
"failed_at": null,
"awaiting_payment_at": "2025-01-15T10:30:00+00:00",
"abandoned_at": null,
"completed_at": "2025-01-15T10:32:00+00:00",
"created_at": "2025-01-15T10:30:00+00:00",
"updated_at": "2025-01-15T10:32:00+00:00"
},
"errors": []
}
Was this page helpful?
⌘I