How to start using our system?
Step-by-step guide on how to use the Plusius system
After registration on the platform, your access is approved and now you can use the system.
If it’s your first time using Postman, please visit Postman Learning Center to get familiar with how it works.
Below you can find more details and a step-by-step guide on how to use the platform.
1. To get started using our platform, the first step is to download and import our collection into Postman.
After the collection is downloaded, to import it to the Postman click on the Import button. You will be presented with options on how to upload the collection depending on where it is located after downloading.
Here you can simply drag and drop the collection that you just downloaded.
With the collection imported, we just have a few simple steps to go before you can start testing out our API.
2. Before start using our system, you will need to add an API Key that you created when registered on the portal. This way you've subscribed to the Sandbox environment.
An API Key needs to be added to the header of any of the requests in the format of the API Key and its value.
Once this is done the header API Key will be added to all requests in this collection.
3. In the collection we use collection variables to make testing easier. The variables will be populated by scripts as you’re using the requests.
If you want to understand how the variables are populated you can go to the Tests tab under the requests.
4. The next step will be to register your customer to the Plusius portal with your own customer reference which needs to be saved into your system as well. This reference will be used for any future customer identification.
Enter your "CustomerReference" data and send a POST request.
- If the customer is already registered in the system, Plusisus will return "statusCode": 400 response with an error message: "Customer already exists."
{
"httpStatusCode": 400,
"success": false,
"errors": [
{
"message": "Customer already exists",
"statusCode": 400
}
]
}
- If the customer doesn't exist in the system, a new one will be registered after you've sent a request.
5. When the customer is registered, the next step is to create a quote with the SettlementAmount and SettlementCurrency. Also, to create a quote you can use the CustomerReference of the customer you just created.
6. When a quote is created, we will receive a response with "uniqueQuoteId" and a list of payment options. This list contains payment options Ids - card payment and bank transfer payment. We will use card payment for this example.
uniqueQuoteId can be saved into system if we need to check quote details later with the corresponding API method.
7. With a uniqueQuoteId and selected paymentOptionId we can initiate card payment.
In the response we will get an URL to the website which will be used for redirection to card payment.
Here we need to enter card details - card number, date, and CVV code.
8. You will also need to set-up a Webhook receiver to receive notifications about status updates in the payment flow. For example, pay-in completed, pay-out completed, the endpoint can be defined here.
To view your customers, quotes, pay-ins and pay-outs, please visit your Platform Dashboard.
9. After the payment is completed - payment status Completed, you will need to initiate the pay-out with a pay-out request via our payout-request endpoint.
For this, you need to use the uniqueQuoteId, paymentOptionId. Also, your own recepientTransferReference. This is the payment reference that we will use when sending the money to the Payee.
10. We do not process these pay-out requests in the Sandbox environment.
Yet, in the Production environment, the next step would be to await a status update. The status update will be received via Webhook informing you that the payout request has been completed.
After that, you're done. The payment flow is complete and the money is in the Payee's bank account.