Zebec Card API Documentation
Overview
The Zebec Card API allows users to manage authentication, user accounts, instant and silver cards, transactions, and more. This API follows REST standards and supports JSON-based requests and responses.
Base URL:
{{baseUrl}}
Authentication
Register
Endpoint: POST /auth/register
Request:
{
"firstName": "John",
"lastName": "Doe",
"email": "johndoe@example.com",
"password": "securepassword",
"address1": "123 Main St",
"city": "New York",
"zipCode": "10001",
"country": "USA",
"state": "NY",
"phone": "+11234567890"
}
Response:
{
"message": "User registered successfully",
"userId": "12345"
}
Login
Endpoint: POST /auth/login
Request:
{
"email": "johndoe@example.com",
"password": "securepassword"
}
Response:
{
"token": "jwtTokenHere",
"expiresIn": 3600
}
Logout
Endpoint: POST /auth/logout
Request:
{
"jwtToken": "{{jwtToken}}"
}
Response:
{
"message": "User logged out successfully"
}
Forgot Password
Endpoint: POST /auth/forgot-password
Request:
{
"email": "johndoe@example.com"
}
Response:
{
"message": "Password reset link sent"
}
Reset Password
Endpoint: POST /auth/reset-password
Request:
{
"email": "johndoe@example.com",
"newPassword": "newSecurePassword",
"newPasswordConfirmation": "newSecurePassword",
"twoFactorToken": "123456"
}
Response:
{
"message": "Password reset successfully"
}
User Management
Get User by ID
Endpoint: GET /users/{id}
Response:
{
"userId": "12345",
"firstName": "John",
"lastName": "Doe",
"email": "johndoe@example.com"
}
Update User
Endpoint: PUT /users
Request:
{
"firstName": "John",
"lastName": "Doe",
"address1": "456 Elm St",
"city": "Los Angeles",
"zipCode": "90001",
"country": "USA",
"state": "CA",
"phone": "+11234567890"
}
Response:
{
"message": "User updated successfully"
}
Update Password
Endpoint: PUT /users/update-password
Request:
{
"existingPassword": "oldPassword",
"newPassword": "newSecurePassword"
}
Response:
{
"message": "Password updated successfully"
}
Instant Cards
Order an Instant Card
Endpoint: POST /instant-card/order
Response:
{
"orderId": "abc123",
"status": "pending"
}
Retry Card Order
Endpoint: POST /instant-card/order/{id}/retry
Response:
{
"message": "Order retry initiated",
"orderId": "abc123"
}
Get Card Order by ID
Endpoint: GET /instant-card/order/{id}
Response:
{
"orderId": "abc123",
"status": "completed"
}
Get Available Currencies
Endpoint: GET /instant-card/currency/{country}
Response:
{
"currencies": ["USD", "EUR"]
}
Get Available Cards
Endpoint: GET /instant-card/cards/{currency}/{country}
Response:
{
"cards": [{ "name": "Visa", "currency": "USD" }]
}
Get Vault Balance
Endpoint: GET /instant-card/vault-balance
Response:
{
"balance": "1000.00 USD"
}
Cancel Payment
Endpoint: PUT /instant-card/payment/cancel
Response:
{
"message": "Payment canceled successfully"
}
Resend Email Confirmation
Endpoint: POST /instant-card/resend-email/{orderId}
Response:
{
"message": "Email resent successfully"
}
Get Bank Balance Report
Endpoint: GET /instant-card/bank-balance-report
Response:
{
"report": "Report URL"
}
License
This API documentation is provided for reference purposes only. Please refer to the official Zebec API documentation for the latest updates.