Crear Enlace de Pago

post https://api-kosmos.ultrapayments.com.br/app/api/payment_links/create

Este endpoint está destinado a la creación de enlaces de pago estándar de la plataforma con un proceso de pago para que el cliente pague a través de Pix o Tarjeta de Crédito.

Body Params

amount

int32

required

Valor del pago en centavos sin comas ni puntos. (Max 9999999999).

currency

string

Defaults to BRL

Moneda en la que se creará el enlace de pago. Valores permitidos:
- BRL
- USD

maxNumberOfInstallments

int32

required

Número máximo de cuotas que el comprador puede seleccionar. (Max 12x).

maxInstallmentsNoInterest

int32

Cantidad de cuotas sin intereses. (Max 12x).

expiredLink

date

Fecha de expiración del enlace de pago.

nameCheckout

string

Nombre del enlace de pago. (Max 255 caracteres).

descriptionCheckout

string

Descripción del enlace de pago.

dueDateLink

date

Fecha de vencimiento del enlace de pago. En caso de que los atributos interestRateVariable e interestRateFixed estén completados, este campo es obligatorio.

interestRateVariable

int32

Tasa de interés variable cobrada mes a mes después de la fecha de vencimiento. Es obligatorio completar la propiedad dueDateLink al enviar valores en esta propiedad. (Max 99999).

interestRateFixed

int32

Valor de multa fija en caso de que se supere la fecha de vencimiento. Sin comas ni puntos. Es obligatorio completar la propiedad dueDateLink al enviar valores en esta propiedad. (Max 9999999999).

redirectUrl

string

URL para redireccionamiento del comprador después de la finalización del pago (Max 255 caracteres).
Ejemplo: https://ultrapayments.com.br

customer

object

required

Información del cliente que recibirá el enlace de pago.

splits

array of objects

División del Pago

splits

metadata

array of objects

El parámetro metadata permite a los usuarios adjuntar información adicional a una transacción. Esto puede incluir cualquier par de clave-valor que proporcione contexto o detalles adicionales sobre la transacción. El metadata no es utilizado por la API para procesar la transacción, pero puede ser útil para el registro del usuario o para la integración con otros sistemas.

metadata

discountType

string

Determina el tipo de descuento.

discount

int32

Monto de descuento, si discountType = PERCENTAGE, el descuento se aplicará como un porcentaje del valor final de la transacción, y si discountType = AMOUNT, el descuento se aplicará como un valor fijo.

Headers

Authorization

string

required

Clave de integración única generada por la Autenticación de Pagos (PayAuth) para el establecimiento.

Formato
Bearer <access_token>

Responses

Language


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api-kosmos.ultrapayments.com.br/app/api/payment_links/create \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Choose an example:

application/json

200200

401401