FOMO DevelopersPaymentAPI ReferencePC POS USB API
latest
PC POS USB API · latest
Local bridge API exposed by the POS USB desktop client after the listener is started.
Create payment
Header Parameters
x-api-version*string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "http://localhost:8080/CreatePayment" \ -H "x-api-version: v1" \ -H "Content-Type: application/json" \ -d '{ "amount": "1.00", "retrieval_reference_number": "invoice-123456789", "condition_code": "82" }'{
"success": true,
"message": "Create payment command processed",
"retrieval_reference_number": "invoice-123456789",
"condition_code": "82"
}Cancel payment
Header Parameters
x-api-version*string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "http://localhost:8080/CancelPayment" \ -H "x-api-version: v1" \ -H "Content-Type: application/json" \ -d '{}'{
"success": true,
"message": "Cancel payment command processed"
}Query payment
Header Parameters
x-api-version*string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
retrieval_reference_number*string
Response Body
application/json
curl -X POST "http://localhost:8080/QueryPayment" \ -H "x-api-version: v1" \ -H "Content-Type: application/json" \ -d '{ "retrieval_reference_number": "invoice-123456789" }'{
"success": true,
"message": "Query payment command processed",
"retrieval_reference_number": "invoice-123456789",
"condition_code": "82",
"transaction_id": "100100090250128303091105",
"transaction_status": "00"
}Void payment
Header Parameters
x-api-version*string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
retrieval_reference_number*string
Response Body
application/json
curl -X POST "http://localhost:8080/VoidPayment" \ -H "x-api-version: v1" \ -H "Content-Type: application/json" \ -d '{ "retrieval_reference_number": "invoice-123456789" }'{
"success": true,
"message": "Void payment command processed"
}Submit batch
Header Parameters
x-api-version*string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "http://localhost:8080/SubmitBatch" \ -H "x-api-version: v1" \ -H "Content-Type: application/json" \ -d '{}'{
"success": true,
"message": "Submit batch command processed"
}