DreamPay API - Web Integration

Integrate DreamPay with your website to start accepting online payments from your customers holders of Brazilian credit cards.

Our standard checkout provides all the essential features for integrating DreamPay Checkout with the client-side of your application. This is available only for web-based integrations.

1. Pre-requisites

In order to use the DreamPay API for web integration of DreamPay you need to have a partner account. If you still don't have one, please register at https://linkgenerator.dreampay.com.br

2. API URL's

• You can find the DreamPay API at https://api.dreampay.com.br/
• You can find the DreamPay API Open Api at https://api.dreampay.com.br/docs/

3. API authentication

The authentication is made by sending in the header of all requests the key "ApiKey" where the value is found on your account profile page.

4. Flow steps

a. Generate payment link

As a first step to integrate DreamPay payments in your checkout flow you need to generate a payment link by making a POST request to /api/PaymentLinks

{
  "establishmentID": 1001,
  "customerName": "Your customer name",
  "customerEmail": "customer-email@gmail.com",
  "customerPhoneNumber": "+351919191919 - optional",
  "orderNumber": "136",
  "value": 29.99,
  "currencyCode": "EUR",
  "observations": "Some description - optional",
  "callbackUrl": "https://callbackurl.pt/endpoint - optional",
  "returnUrl": "https://return.url - optional"
}

The establishmentID is the 4 digit number that can be found in your contract, by checking the Terms and Conditions in your profile page.

b. Send customer to payment page

As a second step you should forward your customer to the payment link received in the previous step. You can open it in a modal window, an iframe or in a new window.

c. Display result of payment

The result of the payment is displayed in the DreamPay payment page. You can provide a returnUrl to forward the customer to a "Thank you" page or "My account" page to achieve a better user experience.

• You can check the status of the payment by making a GET request to /api/PaymentLinks/{id}
• You can provide a callbackUrl to receive a confirmation of the payment.

interface CallbackMessage {
  apiKey: string;
  paymentLink: string;
  status: string;
  message: string;
  integrationId: string;
}

You can get a list of all payment links that you generated by making a GET request to /api/PaymentLinks/establishment/{establishmentId}

5. Other methods available

a. List of payment links

You can get a list of all payment links that you generated by making a GET request to /api/PaymentLinks/establishment/{establishmentId}

b. Check payment link status

You can check the status of the payment by making a GET request to /api/PaymentLinks/{id}

6. Tests and Sandbox

• You can find the DreamPay API test environment at https://dev-api.dreampay.com.br
• You can find the DreamPay API test environment Open Api at https://dev-api.dreampay.com.br/docs/
• You can find the DreamPay Linkgenerator test environment at https://dev-linkgenerator.dreampay.com.br

Before accepting live payments, you can use the following test card numbers to test your integration.

These card numbers are only valid on our test platform, and will not result in a real transaction or transfer of funds.

Tokenized Test Cards

3DS Test Cards

To simulate error codes, simply send transactions with the values corresponding to the error codes, as shown in the table below:

Return Message

The following table shows the Transaction Statuses, that are defined by the FINAL NUMBER of each card, and the ReturnCode:

Test card 4110.1100.4359.7521, for example, will simulate "Payment made successfully".