API callback
API callback
A payment request on Soisy can take on several statuses.
In addition to receiving status updates via email, you can receive update notifications as callsPOST using the parametercallbackUrl in the call to create an order. This parameter must contain the valid URL of a resource on your server.
The content is sent inapplication/x-www-form-urlencoded .
Attention! Make sure your system or e-commerce is able to accept calls with this format. E-commerce like Magento 2 does not accept the application / x-www-form-urlencoded format and it is necessary to act differently. If you need support contact us at: supporto@soisy.it
The content of the call is as follows:
{
"eventId": {eventId},
"eventMessage": {eventMessage},
"eventDate": {date},
"orderToken": {token},
"orderReference": {orderReference}
}
The field{token} will give you the Soisy reference identifying the payment, while{orderReference} is your internal reference code, which you sent us in the API call .{eventId} And{eventMessage} may contain, depending on the state , the following values:
| Status | Description (by environment) |
|---|---|
| Request approved eventId : LoanWasApprovedeventMessage : loan approved | Production : The applicant has passed the automatic pre-approval of our systems in the Soisy funnel and is continuing to enter their data. Sandbox : As in production. |
| Request completed eventId : RequestCompletedeventMessage : waiting for verification | Production : The applicant has completed the application process and is now awaiting checks by our operators. Sandbox : As in production. |
| Waiting for funding eventId : LoanWasVerifiedeventMessage : waiting for disbursement | Production : The installment payment request has been approved by an operator. The payment will be funded. Sandbox : Generated manually by the developer or Soisy customer support . |
| Funded eventId : LoanWasDisbursedeventMessage : payment received | Production : The installment payment request is definitively financed in a process that runs the night following the event Sandbox : Generated manually by the developer or Soisy customer support . |
| Canceled eventId : UserWasRejectedeventMessage : payment failed | Production : The request for pre-approval of the installment payment has been rejected by our automatic systems. Sandbox : As in production. |
| Canceled eventId : UserWasRejectedeventMessage : documents check KO | Production : Soisy, after the appropriate checks, refused the data or documents relating to the customer. Sandbox : Generated manually by the developer or Soisy customer support . |
The callback alone
LoanWasDisbursed will contain an additional field in the payload,amount , who will communicate the final total of that order (which could change during the request phase agreed with both parties: e-commerce and customer) expressed in euro cents . The payload in this case will be the following:
{
"eventId": {eventId},
"eventMessage": {eventMessage},
"eventDate": {date},
"amount": {amount}
"orderToken": {token},
"orderReference": {orderReference}
}
Testing
Here is the paragraph explaining in detail how to perform autonomous tests on the callback endpoint.
Should you need to contact Soisy customer support to request the generation of a sandboxed event, be sure to communicate to support the order token identifying the relevant payment request.
NB: Soisy customer support may prioritize more urgent tickets than callback generation requests. It is therefore always advisable to generate the callbacks independently and to contact customer support in the event of a technical roadblock.
