The Fixosoft API is organized around REST. Our API uses predictable, resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and adheres to standard HTTP response codes, authentication, and verbs.
You can use the Fixosoft API in test mode, which doesn't affect your live data or interact with the banking networks. The API key you use to authenticate the request determines whether the request is in live mode or test mode.
The Fixosoft API does not support bulk updates; you can only work with one object per request.
The Fixosoft API differs for every account as we release new versions and tailor functionality. Log in to see docs customized to your version of the API, including your test key and data.
Need an API Key?
Please fill out the form below to receive an API key.
Not a Developer?
Please Contact Us at Fixosoft.com, and we will assist you in implementing the API code.
Base URL
https://api.fixosoft.com/misimf/v1
Header
'Authorization' => 'Bearer YOUR_API_KEY'
Fixosoft uses conventional HTTP response codes to indicate the success or failure of an API request. Generally, codes in the 2xx range indicate success. Codes in the 4xx range indicate an error due to the information provided (e.g., a required parameter was omitted, a charge failed, etc.). Codes in the 5xx range indicate an error with Fixosoft’s servers (these are rare).
Some 4xx errors, which could be handled programmatically, include an error code that briefly explains the issue.
Status Codes
200 |
OK |
Everything worked as expected. |
400 |
Bad Request |
The request was unacceptable, often due to missing a required parameter. |
401 |
Unauthorized |
No valid API key provided / Login with invalid credentials. |
429 |
Too Many Requests |
1000 requests per hour: Exceeding this limit will result in a 429 Too Many Requests response. |
500 |
Server Errors |
Something went wrong on Fixosoft’s end (these are rare). |
Error Handling
400 |
Bad Request |
The response will include an error message indicating which parameter is missing or invalid. |
500 |
Server Errors |
If the server encounters an unexpected condition, it will return a 500 status with an error message. |
New Client
The `new_client` API endpoint allows clients to register a new client entity in the system.
MisparMeyazeg String Required (Yes)
Unique identifier for the client.
TypeEntity String Required (Yes)
Type of the entity being registered.
EntityNumber String Required (Yes)
Unique number identifying the entity.
FirstName String Required (Yes)
First name of the contact person.
LastName String Required (Yes)
Last name of the contact person.
CommercialNameBusiness String Required (Yes)
Commercial name of the business.
BusinessMail String Required (Yes)
Business email address.
City String Required (Yes)
City where the business is located.
Street String Required (Yes)
Street address of the business.
HouseNumber String Required (Yes)
House number of the business location.
IsUpdate Boolean Required (Yes)
Indicates if this is an update to an existing record.
JSON Example Request
{
"MisparMeyazeg": "123456789",
"TypeEntity": "Company",
"EntityNumber": "987654321",
"FirstName": "Jane",
"LastName": "Doe",
"CommercialNameBusiness": "Doe's Design",
"BusinessMail": "jane.doe@example.com",
"City": "Jerusalem",
"Street": "Ben Yehuda",
"HouseNumber": "12",
"IsUpdate": false
}
Response
{
"message": "Client registration successful",
"success": true,
"MisparLakoah": "40176174",
"MisparMeuzag": "558405668",
"meuzagim_details": {
"data": [...]
}
}
Error Response
{
"message": "EnterMisparMeyazeg",
"success": false
}
Example Request
$client = new GuzzleHttp\Client();
$response = $client->post('https://api.fixosoft.com/misimf/v1/new_client', [
'headers' => [
'Authorization' => 'Bearer YOUR_API_KEY'
],
'json' => [
'MisparMeyazeg' => '123456789',
'TypeEntity' => 'Company',
'EntityNumber' => '987654321',
'FirstName' => 'Jane',
'LastName' => 'Doe',
'CommercialNameBusiness' => 'Doe\'s Design',
'BusinessMail' => 'jane.doe@example.com',
'City' => 'Jerusalem',
'Street' => 'Ben Yehuda',
'HouseNumber' => '12',
'IsUpdate' => false
]
]);
$body = $response->getBody();
Update Client
The `update_client` API endpoint allows updating existing client information in the system.
MisparMeyazeg String Required (Yes)
Unique identifier for the client.
MisparMeuzag String Required (Yes)
Identifier for the specific client branch.
TypeEntity String Required (Yes)
Type of the entity being registered.
EntityNumber String Required (Yes)
Unique number identifying the entity.
FirstName String Required (Yes)
First name of the contact person.
LastName String Required (Yes)
Last name of the contact person.
CommercialNameBusiness String Required (Yes)
Commercial name of the business.
BusinessMail String Required (Yes)
Business email address.
City String Required (Yes)
City where the business is located.
Street String Required (Yes)
Street address of the business.
HouseNumber String Required (Yes)
House number of the business location.
IsUpdate Boolean Required (Yes)
Indicates if this is an update to an existing record.
JSON Example Request
{
"MisparMeyazeg": "123456789",
"MisparMeuzag": "987654321",
"TypeEntity": "Company",
"EntityNumber": "123456789",
"FirstName": "Jane",
"LastName": "Doe",
"CommercialNameBusiness": "Doe's Design",
"BusinessMail": "jane.doe@example.com",
"City": "Jerusalem",
"Street": "Ben Yehuda",
"HouseNumber": "12",
"IsUpdate": true
}
Response
{
"message": "Client update successful",
"success": true,
"MisparLakoah": "40176174",
"MisparMeuzag": "558405668",
"meuzagim_details": {
"data": [...]
}
}
Error Response
{
"message": "EnterMisparMeyazeg",
"success": false
}
Example Request
$client = new GuzzleHttp\Client();
$response = $client->post('https://api.fixosoft.com/misimf/v1/update_client', [
'headers' => [
'Authorization' => 'Bearer YOUR_API_KEY'
],
'json' => [
'MisparMeyazeg' => '123456789',
'MisparMeuzag' => '987654321',
'TypeEntity' => 'Company',
'EntityNumber' => '123456789',
'FirstName' => 'Jane',
'LastName' => 'Doe',
'CommercialNameBusiness' => 'Doe\'s Design',
'BusinessMail' => 'jane.doe@example.com',
'City' => 'Jerusalem',
'Street' => 'Ben Yehuda',
'HouseNumber' => '12',
'IsUpdate' => true
]
]);
$body = $response->getBody();
Rate Limits:
*1000 requests per hour*: Exceeding this limit will result in a 429 Too Many Requests response.
UserCode String Required (Yes)
The user code for login.
Password String Required (Yes)
The password for login.
IpNum String Required (Yes)
User's IP address.
Browser String Required (Yes)
Browser information.
IMEI String Required (No)
Device IMEI number.
Mobile String Required (Yes)
Mobile phone number.
Json Example Request
{
"UserCode": "john_doe",
"Password": "password123",
"IpNum": "192.168.1.1",
"Browser": "Chrome",
"IMEI": "123456789012345",
"Mobile": "0987654321"
}
Response
{
"message": "Login successful",
"success": true,
"MisparLakoah": "40176174",
"MisparMeuzag": "",
"NeedChangePassword": "No"
}
Error Response
{
"message": "EnterUserCode",
"success": false
}
Example Request
$client = new GuzzleHttp\Client();
$response = $client->post('https://api.fixosoft.com/misimf/v1/login', [
'json' => [
'UserCode' => 'john_doe',
'Password' => 'password123',
'IpNum' => '192.168.1.1',
'Browser' => 'Chrome',
'IMEI' => '123456789012345',
'Mobile' => '0987654321'
]
]);
$body = $response->getBody();
```
## Rate Limits
• *Unlimited*: No rate limits for this endpoint.
Rate Limits:
*Unlimited*: No rate limits for this endpoint.
Json Example Request
{
"UserCode": "john_doe",
"OldPassword": "oldpassword123",
"NewPassword": "newpassword123"
}
Response
{
"message": "Password changed successfully",
"success": true,
"MisparLakoah": "40176174",
"MisparMeuzag": ""
}
Error Response
{
"message": "EnterUserCode",
"success": false
}
Example Request
$client = new GuzzleHttp\Client();
$response = $client->post('https://api.fixosoft.com/misimf/v1/change_password', [
'headers' => [
'Authorization' => 'Bearer YOUR_API_KEY'
],
'json' => [
'UserCode' => 'john_doe',
'OldPassword' => 'oldpassword123',
'NewPassword' => 'newpassword123'
]
]);
$body = $response->getBody();
## Rate Limits
• *Unlimited*: No rate limits for this endpoint.
Delete User
The delete_user API endpoint allows administrators to delete a user from the system.
Json Example Request
{
"UserCode": "john_doe"
}
Response
{
"message": "User deleted successfully",
"success": true,
"MisparLakoah": "40176174",
"MisparMeuzag": "987654321"
}
Error Response
{
"message": "EnterUserCode",
"success": false
}
Example Request
$client = new GuzzleHttp\Client();
$response = $client->post('https://api.fixosoft.com/misimf/v1/delete_user', [
'headers' => [
'Authorization' => 'Bearer YOUR_API_KEY'
],
'json' => [
'UserCode' => 'john_doe'
]
]);
$body = $response->getBody();
Rate Limits:
1000 requests per hour: Exceeding this limit will result in a 429 Too Many Requests response.
Forgot Password
The `forgot_password` API endpoint allows users to reset their password by sending a reset link to their registered email address.
Json Example Request
{
"UserCode": "john_doe",
"mail": "john.doe@example.com"
}
Response
{
"message": "Password reset link sent successfully",
"success": true,
"MisparLakoah": "40176174",
"MisparMeuzag": "987654321"
}
Error Response
{
"message": "EnterUserCode",
"success": false
}
Example Request
$client = new GuzzleHttp\Client();
$response = $client->post('https://api.fixosoft.com/misimf/v1/forgot_password', [
'json' => [
'UserCode' => 'john_doe',
'mail' => 'john.doe@example.com'
]
]);
$body = $response->getBody();
Rate Limits:
1000 requests per hour: Exceeding this limit will result in a 429 Too Many Requests response.
Institutes
The institutes API endpoint provides a list of financial institutes associated with a client.
Json Example Request
{
"UserCode": "john_doe",
"MisparMeuzag": "987654321"
}
Response
{
"message": "Institutes retrieved successfully",
"success": true,
"MisparLakoah": "40176174",
"MisparMeuzag": "987654321",
"mosadot_details": {
"data": [
{
"MisparMosad": "1",
"Description": "ביטוח לאומי",
"MaxPayment": "24",
"ThreeDSecure": "Yes",
"nominalInterest": "9.5"
},
{
"MisparMosad": "2",
"Description": "מס הכנסה",
"MaxPayment": "24",
"ThreeDSecure": "Yes",
"nominalInterest": "9.5"
}
]
},
"OcrReadOnly": "Yes",
"code": 0
}
Error Response
{
"message": "EnterUserCode",
"success": false
}
Example Request
$client = new GuzzleHttp\Client();
$response = $client->post('https://api.fixosoft.com/misimf/v1/institutes', [
'headers' => [
'Authorization' => 'Bearer YOUR_API_KEY'
],
'json' => [
'UserCode' => 'john_doe',
'MisparMeuzag' => '987654321'
]
]);
$body = $response->getBody();
Rate Limits:
*Unlimited*: No rate limits for this endpoint.
Register Entity
The register API endpoint allows users to register a new entity (such as a business or individual) in the matrix system.
TypeEntity String Required (Yes)
The type of the entity (e.g., company, individual).
EntityNumber String Required (Yes)
The unique identifier for the entity.
FirstName String Required (Yes)
The first name of the entity's representative.
LastName String Required (Yes)
The last name of the entity's representative.
CommercialNameBusiness String Required (Yes)
The commercial name of the business.
LegalNameBusiness String Required (No)
The legal name of the business (if different).
ContactDetails String Required (No)
Additional contact details.
BusinessMail String Required (Yes)
The business email address.
Phone String Required (No)
The business phone number.
Mobile String Required (Yes)
The mobile phone number of the entity's representative.
City String Required (Yes)
The city where the business is located.
street String Required (Yes)
The street address of the business.
HouseNumber String Required (Yes)
The house number of the business address.
Floor String Required (No)
The floor number, if applicable.
zipcode String Required (No)
The postal code of the business address.
IsSingleRepresented String Required (Yes)
Indicates if the entity is singly represented ("Yes" or "No").
IsUpdate Integer Required (Yes)
Indicates if this is an update operation (1 for true, 0 for false).
Json Example Request
{
"TypeEntity": "Company",
"EntityNumber": "123456789",
"FirstName": "John",
"LastName": "Doe",
"CommercialNameBusiness": "John Doe Enterprises",
"LegalNameBusiness": "John Doe Inc.",
"ContactDetails": "info@johndoe.com",
"BusinessMail": "contact@johndoe.com",
"Phone": "0987654321",
"Mobile": "1234567890",
"City": "New York",
"street": "5th Avenue",
"HouseNumber": "10",
"Floor": "3",
"zipcode": "10001",
"IsSingleRepresented": "Yes",
"IsUpdate": 0
}
Response
{
"message": "Registration successful",
"success": true,
"MisparLakoah": "40176174",
"MisparMeuzag": "558405668"
}
Error Response
{
"message": "EnterTypeEntity",
"success": false
}
Example Request
$client = new GuzzleHttp\Client();
$response = $client->post('https://api.fixosoft.com/misimf/v1/register', [
'json' => [
'TypeEntity' => 'Company',
'EntityNumber' => '123456789',
'FirstName' => 'John',
'LastName' => 'Doe',
'CommercialNameBusiness' => 'John Doe Enterprises',
'LegalNameBusiness' => 'John Doe Inc.',
'ContactDetails' => 'info@johndoe.com',
'BusinessMail' => 'contact@johndoe.com',
'Phone' => '0987654321',
'Mobile' => '1234567890',
'City' => 'New York',
'street' => '5th Avenue',
'HouseNumber' => '10',
'Floor' => '3',
'zipcode' => '10001',
'IsSingleRepresented' => 'Yes',
'IsUpdate' => 0
]
]);
$body = $response->getBody();
Rate Limits:
500 requests per hour: Exceeding this limit will result in a 429 Too Many Requests response.
Update Entity
The update API endpoint allows users to update details of an existing entity in the system.
TypeEntity String Required (Yes)
The type of the entity (e.g., company, individual).
EntityNumber String Required (Yes)
The unique identifier for the entity.
FirstName String Required (Yes)
The first name of the entity's representative.
LastName String Required (Yes)
The last name of the entity's representative.
CommercialNameBusiness String Required (Yes)
The commercial name of the business.
LegalNameBusiness String Required (No)
The legal name of the business (if different).
ContactDetails String Required (No)
Additional contact details.
BusinessMail String Required (Yes)
The business email address.
Phone String Required (No)
The business phone number.
Mobile String Required (Yes)
The mobile phone number of the entity's representative.
City String Required (Yes)
The city where the business is located.
street String Required (Yes)
The street address of the business.
HouseNumber String Required (Yes)
The house number of the business address.
Floor String Required (No)
The floor number, if applicable.
zipcode String Required (No)
The postal code of the business address.
IsSingleRepresented String Required (Yes)
Indicates if the entity is singly represented ("Yes" or "No").
IsUpdate Integer Required (Yes)
Indicates if this is an update operation (1 for true, 0 for false).
MisparLakoah String Required (Yes)
The unique identifier of the client (Mispar Lakoah).
Json Example Request
{
"TypeEntity": "Company",
"EntityNumber": "123456789",
"FirstName": "John",
"LastName": "Doe",
"CommercialNameBusiness": "John Doe Enterprises",
"LegalNameBusiness": "John Doe Inc.",
"ContactDetails": "info@johndoe.com",
"BusinessMail": "contact@johndoe.com",
"Phone": "0987654321",
"Mobile": "1234567890",
"City": "New York",
"street": "5th Avenue",
"HouseNumber": "10",
"Floor": "3",
"zipcode": "10001",
"IsSingleRepresented": "Yes",
"IsUpdate": 1,
"MisparLakoah": "40176174"
}
Response
{
"message": "Update successful",
"success": true,
"MisparLakoah": "40176174",
"MisparMeuzag": "558405668"
}
Error Response
{
"message": "EnterTypeEntity",
"success": false
}
Example Request
$client = new GuzzleHttp\Client();
$response = $client->post('https://api.fixosoft.com/misimf/v1/update', [
'json' => [
'TypeEntity' => 'Company',
'EntityNumber' => '123456789',
'FirstName' => 'John',
'LastName' => 'Doe',
'CommercialNameBusiness' => 'John Doe Enterprises',
'LegalNameBusiness' => 'John Doe Inc.',
'ContactDetails' => 'info@johndoe.com',
'BusinessMail' => 'contact@johndoe.com',
'Phone' => '0987654321',
'Mobile' => '1234567890',
'City' => 'New York',
'street' => '5th Avenue',
'HouseNumber' => '10',
'Floor' => '3',
'zipcode' => '10001',
'IsSingleRepresented' => 'Yes',
'IsUpdate' => 1,
'MisparLakoah' => '40176174'
]
]);
$body = $response->getBody();
Rate Limits:
500 requests per hour: Exceeding this limit will result in a 429 Too Many Requests response.
Create Payment
The create_payment API endpoint is used to initiate a new payment transaction with Cardcom, generating a payment link that can be provided to the client.
UserCode String Required (Yes)
The user code for the account initiating the payment.
ReturnValue String Required (Yes)
A return value identifier to associate the transaction with a specific order or entity.
Amount String Required (Yes)
The amount to be charged in the transaction (in NIS).
ProductName String Required (Yes)
The name of the product or service being paid for.
ThreeDSecureState String Required (Yes)
Indicates whether 3D Secure should be enabled ("Yes" or "No").
SelectedNumOfPayments String Required (Yes)
The number of payments selected for the transaction.
MinNumOfPayments String Required (Yes)
The minimum number of payments allowed.
MaxNumOfPayments String Required (Yes)
The maximum number of payments allowed.
Json Example Request
{
"UserCode": "john_doe",
"ReturnValue": "order_123456",
"Amount": "500.00",
"ProductName": "Subscription Service",
"ThreeDSecureState": "Yes",
"SelectedNumOfPayments": "1",
"MinNumOfPayments": "1",
"MaxNumOfPayments": "12"
}
Response
{
"message": "Payment link created successfully",
"success": true,
"LowProfileId": "a1184d4a-da95-48a3-a99c-0bb6013b07c9",
"Url": "https://secure.cardcom.solutions/u/7mHcD"
}
Error Response
{
"message": "EnterUserCode",
"success": false
}
Example Request
$client = new GuzzleHttp\Client();
$response = $client->post('https://api.fixosoft.com/misimf/v1/cardcom_create', [
'json' => [
'UserCode' => 'john_doe',
'ReturnValue' => 'order_123456',
'Amount' => '500.00',
'ProductName' => 'Subscription Service',
'ThreeDSecureState' => 'Yes',
'SelectedNumOfPayments' => '1',
'MinNumOfPayments' => '1',
'MaxNumOfPayments' => '12'
]
]);
$body = $response->getBody();
Rate Limits:
500 requests per hour: Exceeding this limit will result in a 429 Too Many Requests response.
Payments Details
The payments_details API endpoint allows users to retrieve details of transactions or payments for a specific client within a given date range.
UserCode String Required (Yes)
The user code for the account being accessed.
MisparMeuzag String Required (Yes)
Identifier for the specific client branch.
FromDealDate String Required (Yes)
The starting date of the transaction period (format: YYYY-MM-DD).
ToDealDate String Required (Yes)
The ending date of the transaction period (format: YYYY-MM-DD).
Json Example Request
{
"UserCode": "john_doe",
"MisparMeuzag": "987654321",
"FromDealDate": "2024-08-01",
"ToDealDate": "2024-08-31"
}
Response
{
"message": "Payments details retrieved successfully",
"success": true,
"MisparLakoah": "40176174",
"MisparMeuzag": "987654321",
"transactions_details": {
"data": [
{
"EntityNumber": "587499887",
"EntityName": "John Doe Enterprises",
"UID": "05874998872307230011",
"Mosad": "מס הכנסה",
"TransactionDate": "2024-08-05",
"TransactionTime": "16:06:35",
"Net": "1000.00",
"Payments": "5",
"fee": "27.60",
"Interest": "12.00",
"Vat": "6.73",
"total": "1046.33",
"Last4digits": "1234",
"status": "0",
"ConfirmationNumber": "fb4e44dc-4976-438d-a81f-1d734c408c98",
"InvoiceNumber": "INV123456",
"PDFlink": "https://misimf.com/files/scans/58749988705874998872307230011/scan01.JPG"
}
]
}
}
Error Response
{
"message": "EnterUserCode",
"success": false
}
Example Request
$client = new GuzzleHttp\Client();
$response = $client->post('https://api.fixosoft.com/misimf/v1/payments_details', [
'json' => [
'UserCode' => 'john_doe',
'MisparMeuzag' => '987654321',
'FromDealDate' => '2024-08-01',
'ToDealDate' => '2024-08-31'
]
]);
$body = $response->getBody();
Rate Limits:
500 requests per hour: Exceeding this limit will result in a 429 Too Many Requests response.
Update Payment Method
The `update_pay` API endpoint allows users to update payment details for a specific transaction.
UserCode String Required (Yes)
The user code for the transaction.
MisparMeuzag String Required (Yes)
Identifier for the specific client branch.
DealDate String Required (Yes)
The date of the deal (format: YYYY-MM-DD).
LastPaymentDate String Required (Yes)
The date of the last payment (format: YYYY-MM-DD).
NetSum String Required (Yes)
The net sum of the payment.
NoPayments String Required (Yes)
The number of payments.
MisparMosad String Required (Yes)
Identifier for the financial institution.
fileToUpload String Required (Yes)
The file to be uploaded for the payment proof.
KodMotav String Required (Yes)
The code of the recipient institution.
Barcod String Required (Yes)
The barcode related to the payment.
Json Example Request
{
"UserCode": "john_doe",
"MisparMeuzag": "987654321",
"DealDate": "2024-08-01",
"LastPaymentDate": "2024-09-01",
"NetSum": "1000.00",
"NoPayments": "5",
"MisparMosad": "1234567",
"fileToUpload": "receipt.pdf",
"KodMotav": "0001234",
"Barcod": "1234567890123"
}
Response
{
"message": "Payment details updated successfully",
"success": true,
"MisparLakoah": "40176174",
"MisparMeuzag": "987654321",
"fee": 2.95,
"interest": 3.60,
"net": "1000.00",
"vat": 1.11,
"total": 1003.60,
"UID": "00401761742309120038",
"code": 0
}
Error Response
{
"message": "EnterUserCode",
"success": false
}
Example Request
$client = new GuzzleHttp\Client();
$response = $client->post('https://api.example.com/v1/update_payment', [
'headers' => [
'Authorization' => 'Bearer YOUR_API_KEY'
],
'json' => [
'UserCode' => 'john_doe',
'MisparMeuzag' => '987654321',
'DealDate' => '2024-08-01',
'LastPaymentDate' => '2024-09-01',
'NetSum' => '1000.00',
'NoPayments' => '5',
'MisparMosad' => '1234567',
'fileToUpload' => 'receipt.pdf',
'KodMotav' => '0001234’,
‘Barcod’ => ‘1234567890123’
]
]);
$body = $response->getBody();
Rate Limits:
500 requests per hour*: Exceeding this limit will result in a 429 Too Many Requests response.
Payment Result
The payment_result API endpoint is used to retrieve the result of a Cardcom payment transaction after the payment process has been completed.
LowProfileId String Required (Yes)
The unique identifier for the transaction provided by Cardcom.
NewLowProfileId String Required (Yes)
The new unique identifier for the transaction after redirection.
UserCode String Required (Yes)
The user code for the account associated with the transaction.
MisparMeuzag String Required (Yes)
Identifier for the specific client branch.
MisparMosad String Required (Yes)
The institution code associated with the transaction.
ThreeDSecure String Required (Yes)
Indicates whether 3D Secure was used ("Yes" or "No").
UID String Required (Yes)
Unique identifier associated with the transaction.
fileToUpload File Required (Yes)
The file to be uploaded, such as a receipt or confirmation document.
KodMotav String Required (Yes)
The beneficiary code associated with the transaction.
Barcod String Required (Yes)
The barcode associated with the payment document.
Json Example Request
{
"LowProfileId": "a1184d4a-da95-48a3-a99c-0bb6013b07c9",
"NewLowProfileId": "b2234d5e-da95-48a3-a99c-0bb6013b07c9",
"UserCode": "john_doe",
"MisparMeuzag": "987654321",
"MisparMosad": "1",
"ThreeDSecure": "Yes",
"UID": "05874998872307230011",
"fileToUpload": "base64_encoded_file_string",
"KodMotav": "1234567",
"Barcod": "1234567890123"
}
Response
{
"message": "Transaction result retrieved successfully",
"success": true,
"MisparLakoah": "40176174",
"MisparMeuzag": "987654321",
"success_cardcom": true,
"TranzactionId": "148328570"
}
Error Response
{
"message": "EnterUserCode",
"success": false
}
Example Request
$client = new GuzzleHttp\Client();
$response = $client->post('https://api.fixosoft.com/misimf/v1/cardcom_result', [
'json' => [
'LowProfileId' => 'a1184d4a-da95-48a3-a99c-0bb6013b07c9',
'NewLowProfileId' => 'b2234d5e-da95-48a3-a99c-0bb6013b07c9',
'UserCode' => 'john_doe',
'MisparMeuzag' => '987654321',
'MisparMosad' => '1',
'ThreeDSecure' => 'Yes',
'UID' => '05874998872307230011',
'fileToUpload' => 'base64_encoded_file_string',
'KodMotav' => '1234567',
'Barcod' => '1234567890123'
]
]);
$body = $response->getBody();
Rate Limits:
500 requests per hour: Exceeding this limit will result in a 429 Too Many Requests response.
Send OTP
The `send_otp` API endpoint sends a one-time password (OTP) to the user's registered mobile number for authentication.
Json Example Request
{
"UserCode": "john_doe"
}
Response
{
"message": "OTP sent successfully",
"success": true,
"MisparLakoah": "40176174",
"MisparMeuzag": ""
}
Error Response
{
"message": "EnterUserCode",
"success": false
}
Example Request
$client = new GuzzleHttp\Client();
$response = $client->post('https://api.fixosoft.com/misimf/v1/send_otp', [
'headers' => [
'Authorization' => 'Bearer YOUR_API_KEY'
],
'json' => [
'UserCode' => 'john_doe'
]
]);
$body = $response->getBody();
Rate Limits:
100 requests per hour: Exceeding this limit will result in a 429 Too Many Requests response.
OTP End
The otp_end API endpoint is used to verify the One-Time Password (OTP) provided by the user and retrieve the customer's details if the OTP is correct.
OTP End
Json Example Request
{
"UserCode": "john_doe",
"OTP": "123456"
}
Response
{
"message": "OTP verified successfully",
"success": true,
"MisparLakoah": "40176174",
"MisparMeuzag": "",
"costumer_details": {
"data": [
{
"TypeEntity": "AuthorizedDealer",
"EntityNumber": "40176174",
"FirstName": "John",
"LastName": "Doe",
"CommercialNameBusiness": "John Doe Enterprises",
"LegalNameBusiness": "John Doe Inc.",
"Contact": [
{
"ContactDetails": ""
}
],
"Phone": "0501234567",
"Mobile": "0501234567",
"BusinessMail": "john.doe@example.com",
"BusinessAddress": [
{
"city": "New York",
"street": "5th Avenue",
"HouseNumber": "10",
"floor": "",
"zipcode": "10001"
}
],
"IsSingleRepresented": "No"
}
]
},
"meuzagim_details": {
"data": [
{
"TypeEntity": "AuthorizedDealer",
"EntityNumber": "40176174",
"MisparMeuzag": "40176174",
"active": "No",
"FirstName": "John",
"LastName": "Doe",
"mail": "john.doe@example.com",
"CommercialNameBusiness": "John Doe Enterprises",
"LegalNameBusiness": "John Doe Inc.",
"BusinessAddress": [
{
"city": "New York",
"street": "5th Avenue",
"HouseNumber": "10",
"floor": "",
"zipcode": "10001"
}
]
}
]
},
"IsSingleRepresented": "No"
}
Error Response
{
"message": "Invalid OTP",
"success": false
}
Example Request
$client = new GuzzleHttp\Client();
$response = $client->post('https://api.fixosoft.com/misimf/v1/otp_end', [
'json' => [
'UserCode' => 'john_doe',
'OTP' => '123456'
]
]);
$body = $response->getBody();
Rate Limits:
500 requests per hour: Exceeding this limit will result in a 429 Too Many Requests response.
Document OCR
The document_ocr API endpoint is used to process an uploaded document, extract barcode information, and validate it against a specified institution (Mispar Mosad).
Json Example Request
{
"MisparMosad": "1",
"file": "base64_encoded_file_string"
}
Response
{
"success": true,
"result": {
"barcodeValue": "1234567890123",
"netoFromFile": 1234.56,
"KodMotav": "1234567"
},
"findMotavim": true,
"htmlWarning": "",
"errorCode": 0
}
Error Response
{
"success": false,
"result": "Error: Missing uploaded file",
"findMotavim": false,
"htmlWarning": "",
"errorCode": 400
}
Example Request
$client = new GuzzleHttp\Client();
$response = $client->post('https://api.fixosoft.com/misimf/v1/ocrbarcod', [
'multipart' => [
[
'name' => 'MisparMosad',
'contents' => '1'
],
[
'name' => 'file',
'contents' => fopen('/path/to/document.pdf', 'r')
]
]
]);
$body = $response->getBody();
Rate Limits:
1000 requests per hour: Exceeding this limit will result in a 429 Too Many Requests response.