DreamPay API - Integración Web

Integre DreamPay en su sitio web para comenzar a aceptar pagos en línea de sus clientes titulares de tarjetas de crédito brasileñas.

Nuestro checkout estándar proporciona todas las funcionalidades esenciales para integrar DreamPay Checkout en el lado cliente de su aplicación. Disponible solo para integraciones web.

1. Pre-requisitos

Para utilizar la API de DreamPay para integración web necesita tener una cuenta de socio. Si aún no tiene una, regístrese en https://linkgenerator.dreampay.com.br

2. URL's de la API

• La API de DreamPay está disponible en https://api.dreampay.com.br/
• La documentación Open Api de DreamPay está disponible en https://api.dreampay.com.br/docs/

3. Autenticación de la API

La autenticación se realiza enviando en el header de todas las solicitudes la clave "ApiKey" cuyo valor se encuentra en la página de perfil de su cuenta.

4. Pasos del flujo

a. Generar enlace de pago

Como primer paso para integrar los pagos DreamPay en su flujo de checkout, necesita generar un enlace de pago haciendo una solicitud POST a /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"
}

El establishmentID es el número de 4 dígitos que se encuentra en su contrato, consultando los Términos y Condiciones en la página de perfil.

b. Enviar cliente a la página de pago

Como segundo paso, debe redirigir a su cliente al enlace de pago recibido en el paso anterior. Puede abrirlo en una ventana modal, un iframe o en una nueva ventana.

c. Mostrar resultado del pago

El resultado del pago se muestra en la página de pago DreamPay. Puede proporcionar una returnUrl para redirigir al cliente a una página de "Gracias" o "Mi cuenta" para una mejor experiencia.

• Puede verificar el estado del pago haciendo una solicitud GET a /api/PaymentLinks/{id}
• Puede proporcionar una callbackUrl para recibir la confirmación del pago.

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

Puede obtener la lista de todos los enlaces de pago generados haciendo una solicitud GET a /api/PaymentLinks/establishment/{establishmentId}

5. Otros métodos disponibles

a. Lista de enlaces de pago

Puede obtener la lista de todos los enlaces de pago generados haciendo una solicitud GET a /api/PaymentLinks/establishment/{establishmentId}

b. Verificar estado del enlace de pago

Puede verificar el estado del pago haciendo una solicitud GET a /api/PaymentLinks/{id}

6. Pruebas y Sandbox

• El entorno de pruebas de la API DreamPay está disponible en https://dev-api.dreampay.com.br
• La documentación Open Api del entorno de pruebas está disponible en https://dev-api.dreampay.com.br/docs/
• El Linkgenerator del entorno de pruebas está disponible en https://dev-linkgenerator.dreampay.com.br

Antes de aceptar pagos reales, puede utilizar los siguientes números de tarjeta de prueba para probar su integración.

Estos números de tarjeta solo son válidos en nuestra plataforma de pruebas y no resultarán en una transacción real ni transferencia de fondos.

Tarjetas de Prueba Tokenizadas

Tarjetas de Prueba 3DS

Para simular códigos de error, simplemente envíe transacciones con los valores correspondientes a los códigos de error, como se muestra en la tabla a continuación:

Mensaje de Retorno

La siguiente tabla muestra los Estados de las Transacciones, definidos por el NÚMERO FINAL de cada tarjeta, y el ReturnCode:

La tarjeta de prueba 4110.1100.4359.7521, por ejemplo, simulará "Payment made successfully".