Use Case #2
Request Payments using Invoiss
Invoiss provides a simple way to send payment requests directly to your POS or to your clients.
We've created a diagram to help you understand what happens behind the scenes when you request a payment using Invoiss. View diagram
Follow these steps:
- Create a Data Map between your application software and Invoiss API.
- Create a Client (if they don't already exist, otherwise simply retrieve the clientId). A client is the entity that will be making the payment. Every order requires a client.
- Create an Order using the clientId and line items. See required and optional fields for creating an order.
- Use the following endpoint to request a Payment using the orderId:
This endpoint requests a payment for an order. Ensure you provide all the necessary information to avoid errors.
Required attributes
Request
POST
/public/payments/requestcurl -X POST https://api.invoiss.com/public/payments/request \
-H "Authorization: {token}" \
-H "Content-Type: application/json" \
-d '{
"order": {
"client": "dd00baxx-e534-496c-9fe8-d1f856f76515"
},
"orderRemove": false,
"lineItems": [
{
"description": "Item Description",
"externalId": "external-id-1",
"quantity": 1,
"price": 10,
"name": "Sample Item"
}
]
}'
Response
{
true
}