Sulpayments API documentation (1.0.0)

These APIs use Mutual TLS as authentication method.

This method requires both the client and the server to confirm their identity with a certificate. Once the identity of both parties is confirmed, an encrypted connection is established.

Ask for a certificate in order to access the functionalities of the api.

If you are using postman here is an example on how to work with certificates in Postman

Find below an example on how to make a request using the certificate given.

// typescript
import axios from "axios";
import https from "https";
import fs from "fs";

const serverURL = "https://my.server";
const pfxPath = "/path/to/client.pfx"; // Replace with the path to your PFX file

const agent = new https.Agent({
  pfx: fs.readFileSync(pfxPath),
  passphrase: "your_pfx_file_password", // Replace with the password for your PFX file, if applicable
});
const requestData = {
  // Your request payload here
};
axios
  .post(serverURL, requestData, { httpsAgent: agent })
  .then((response) => {
    console.log("Response:", response.data);
  })
  .catch((error) => {
    console.error("Request error:", error.message);
  });

To complete the payment using a credit card, the following flow must be followed (see the illustrative diagrams below for better understanding):

In the first scenario:

1. The first request is sent to the endpoint /order/v1/client-token-3ds/card-token with the necessary data for token generation (refer to the documentation below for request details).
2. With the token generated using the card and user data, the second request is made to the endpoint /order/v3/transparent to finalize the order, populating the specialPaymentDetails.card3DSToken field with the token generated in step 1.
3. The payment is either PAID or CANCELED synchronously, and the response is returned to the client.

In the second scenario:

1. The first request is sent to the endpoint /order/v1/client-token-3ds/card-token with the necessary data for token generation (refer to the documentation below for request details).
2. With the token generated using the card and user data, the second request is made to the endpoint /order/v3/transparent to finalize the order, populating the specialPaymentDetails.card3DSToken field with the token generated in step 1.
3. If the payment status returned in step 2 is ANALYSIS, a challenge URL (field challengeUrl) is included in the response payload to the client. The user must be redirected to this URL to complete the challenge process on his bank.
4. After the user completes the challenge, the payment is confirmed via webhook notification to the client.