API Explorer API Reference
Snap Checkout 2.0 API is built to help empower your tools and applications to get the most out of them through an easy integration. All our APIs are organized around REST. All our APIs will return JSON as response, including errors.
Schemes: https
Authentication
Login
POST /auth-sandbox.snapfinance.com/oauth/token
Authenticate users and get an access_token
Credentials to obtain token
Request Example
{
"client_id": "string",
"client_secret": "string",
"audience": "string",
"grant_type": "string"
}
Success
Bad Request
Unauthorized
Forbidden
Not Found
Method Not Allowed
Too Many Requests
Internal Server Error
Service Unavailable
Response Content-Types: application/json
Response Example (200 OK)
{
"access_token": "string",
"scope": "string",
"expires_in": "string",
"token_type": "string"
}
Application
POST /v2/internal/application/complete/{applicationId}
Updates application status to either Complete or Pending Delivery
(no description)
(no description)
Application status updated successfully
Unauthorized to perform update
Not found
Issue with Snap- Server Error - Error completing order
Response Content-Types: application/json
Response Example (200 OK)
{
"access_token": "string",
"scope": "string",
"expires_in": "string",
"token_type": "string"
}
Response Example (401 Unauthorized)
{
"success": "string",
"status": "string",
"statusMessage": "string",
"error": {
"code": "integer",
"message": "string"
}
}
Response Example (404 Not Found)
{
"success": "string",
"status": "string",
"statusMessage": "string",
"error": {
"code": "integer",
"message": "string"
}
}
Response Example (500 Internal Server Error)
{
"success": "string",
"status": "string",
"statusMessage": "string",
"error": {
"code": "integer",
"message": "string"
}
}
Payment Calculator
POST /v2/tools/payment-calculator/{merchantId}
Values to calculate
Merchant Id
Request Example
{
"invoiceAmount": "number",
"paymentAmount": "number",
"frequency": "string",
"applicationId": "number"
}
Calculation successful
Application not found
Error calculating invoice
Response Content-Types: application/json
Response Example (200 OK)
{
"success": "string",
"status": "string",
"statusMessage": "string",
"data": {
"message": "string"
}
}
Response Example (400 Bad Request)
{
"success": "string",
"status": "string",
"statusMessage": "string",
"error": {
"code": "integer",
"message": "string"
}
}
Response Example (500 Internal Server Error)
{
"success": "string",
"status": "string",
"statusMessage": "string",
"error": {
"code": "integer",
"message": "string"
}
}
Schema Definitions
PaymentCalc: object
- invoiceAmount: number
- paymentAmount: number
- frequency: string WEEKLY, BI_WEEKLY, SEMI_MONTHLY, MONTHLY, MONTHLY_WEEK
- applicationId: number
Example
{
"invoiceAmount": "number",
"paymentAmount": "number",
"frequency": "string",
"applicationId": "number"
}
LoginModel: object
- client_id: string
- client_secret: string
- audience: string
- grant_type: string
Example
{
"client_id": "string",
"client_secret": "string",
"audience": "string",
"grant_type": "string"
}
ErrorResponseModel: object
- success: string
- status: string
- statusMessage: string
- error: object
-
- code: integer
- message: string
Example
{
"success": "string",
"status": "string",
"statusMessage": "string",
"error": {
"code": "integer",
"message": "string"
}
}
LoginResponseModel: object
- access_token: string
- scope: string
- expires_in: string
- token_type: string
Example
{
"access_token": "string",
"scope": "string",
"expires_in": "string",
"token_type": "string"
}