PagosCrear Pago

Crear Pago

POST/v1/paymenthttps://api.securitypag.com

Autenticación: Bearer · clave de API

Para crear un pago, utilice la ruta v1/payment. Esta ruta es compatible con pagos mediante tarjeta de crédito, boleto bancario y PIX.

Formato de dirección: Los campos de dirección se renderizan automáticamente según el valor informado en country.

Si country = BR, se mostrará el formato brasileño con los siguientes campos: state, city, district, street, number, complement e zipCode.

Para otros países, se mostrará automáticamente el formato internacional con los siguientes campos: state, city, line1, line2 e zipCode.

Consejo: solo informe correctamente el país — los campos se ajustarán automáticamente.

Cuerpo de la solicitud

Enviado en JSON.

amountintegerobligatorio
Valor total del pago en centavos. Ejemplo: R$ 1,00.
currencystringobligatorio
Moneda del pago (ej: BRL, USD, EUR).
methodstringobligatorio
Método de pago (PIX, BOLETO, CREDIT_CARD).
descriptionstringobligatorio
Descripción del pago.
externalRefstring
Referencia externa del pago.
notificationUrlstring
URL donde se enviarán los webhooks del pago.
ipstring
Dirección IP del cliente.
payerobjectobligatorio4 campos
Datos del pagador.
- namestringobligatorio
  Nombre completo del pagador.
- taxIdstringobligatorio
  Documento del pagador.
- emailstring
  Correo electrónico del pagador.
- phonestring
  Teléfono del pagador. Puede ser obligatorio según el procesador.
itemsarray of objectsobligatorio4 campos
Lista de productos incluidos en el pago.
- quantityintegerobligatorio
  Cantidad del producto. Debe ser mayor que cero.
- namestringobligatorio
  Nombre del producto.
- priceintegerobligatorio
  Precio unitario en centavos.
- typestringobligatorio
  Tipo de producto [DIGITAL, PHYSICAL].
deliveryobject2 campos
Entrega do pedido, obrigatório caso o produto seja do tipo PHYSICAL
- feeintegerobligatorio
  Taxa de entrega do pedido em centavos (este valor não é adicionado ao amount). Exemplo: R$ 1,00.
- addressobjectobligatorio8 campos
  Dirección de entrega. El formato de la dirección depende del país informado. Si country = BR utilice el formato brasileño (district, street, number). Para otros países utilice el formato internacional (line1, line2).
  - countrystringobligatorio
    Código del país según el estándar ISO 3166-1 alpha-2 (ej: BR, US).
  - statestringobligatorio
    Estado o provincia (ej: SP, CA, NY). Obligatorio cuando country = BR.
  - citystringobligatorio
    Ciudad. Obligatorio cuando country = BR.
  - districtstringobligatorio
    Barrio o distrito. Obligatorio cuando country = BR.
  - streetstringobligatorio
    Nombre de la calle. Obligatorio cuando country = BR.
  - numberstringobligatorio
    Número de la dirección. Obligatorio cuando country = BR.
  - complementstring
    Complemento de la dirección (apartamento, bloque, unidad, etc).
  - zipCodestringobligatorio
    Código postal.
splitsarray of strings
Lista de IDs de splits. Ejemplo: ["split_id_1", "split_id_2"].
cardobject3 campos
Datos de la tarjeta cuando el método es CREDIT_CARD.
- tokenstringobligatorio
  Token de la tarjeta.
- installmentsintegerobligatorio
  Número de cuotas (1 a 12).
- billingAddressobject8 campos
  Dirección de facturación.
  - countrystringobligatorio
    Código del país según el estándar ISO 3166-1 alpha-2 (ej: BR, US).
  - statestringobligatorio
    Estado o provincia (ej: SP, CA, NY). Obligatorio cuando country = BR.
  - citystringobligatorio
    Ciudad. Obligatorio cuando country = BR.
  - districtstringobligatorio
    Barrio o distrito. Obligatorio cuando country = BR.
  - streetstringobligatorio
    Nombre de la calle. Obligatorio cuando country = BR.
  - numberstringobligatorio
    Número de la dirección. Obligatorio cuando country = BR.
  - complementstring
    Complemento de la dirección (apartamento, bloque, unidad, etc).
  - zipCodestringobligatorio
    Código postal.
boletoobject1 campos
Datos obligatorios cuando el método es BOLETO.
- billingAddressobject8 campos
  El formato de la dirección depende del país informado. Si country = BR utilice el formato brasileño (district, street, number). Para otros países utilice el formato internacional (line1, line2).
  - countrystringobligatorio
    Código del país según el estándar ISO 3166-1 alpha-2 (ej: BR, US).
  - statestringobligatorio
    Estado o provincia (ej: SP, CA, NY). Obligatorio cuando country = BR.
  - citystringobligatorio
    Ciudad. Obligatorio cuando country = BR.
  - districtstringobligatorio
    Barrio o distrito. Obligatorio cuando country = BR.
  - streetstringobligatorio
    Nombre de la calle. Obligatorio cuando country = BR.
  - numberstringobligatorio
    Número de la dirección. Obligatorio cuando country = BR.
  - complementstring
    Complemento de la dirección (apartamento, bloque, unidad, etc).
  - zipCodestringobligatorio
    Código postal.
metadataobject9 campos
Metadatos del pago para control y trazabilidad.
- providerstringobligatorio
  Origen responsable de la creación del pago.
- orderIdstringobligatorio
  Identificador único del pedido.
- sellerTaxIdstringobligatorio
  Documento fiscal del vendedor.
- sellerEmailstringobligatorio
  Correo electrónico del vendedor.
- checkoutUrlstring
  URL del checkout.
- returnUrlstring
  URL de retorno después del pago.
- shopUrlstring
  Página de venta.
- referrerLinkstring
  URL de origen inmediato.
- extrastring
  Campo libre para metadatos adicionales.
utmsobject7 campos
Parámetros UTM que identifican el origen del tráfico del pago.
- utmSourcestring
  Origen del tráfico que generó el acceso, como google, facebook o newsletter.
- utmMediumstring
  Medio o canal utilizado por la campaña, como cpc, email o social.
- utmCampaignstring
  Nombre de la campaña responsable del acceso, como black-friday-2026.
- utmContentstring
  Variación del anuncio o creativo que originó el acceso.
- utmTermstring
  Palabra clave asociada al anuncio o a la búsqueda que originó el acceso.
- srcstring
  Código de origen del tráfico, reenviado en la URL como src. Identifica de dónde vino el clic.
- sckstring
  Código secundario de seguimiento, reenviado en la URL como sck. Segmenta el origen dentro de la campaña.

Respuestas

200Objeto de respuesta devuelto cuando el pago se crea o consulta correctamente.

idstring
Identificador único del pago en el sistema.
amountintegerpredeterminado: 0
Valor total del pago en centavos.
methodstring
Método de pago utilizado (PIX, CREDIT_CARD, BOLETO).
currencystring
Código de la moneda utilizada (ej: BRL).
statusstring
Estado actual del pago (ej: PENDING, PROCESSING, PAID, REFUSED, REFUNDED, MED, CHARGEDBACK).
descriptionstring
Descripción del pago.
installmentsintegerpredeterminado: 1
Número de cuotas.
payerobject4 campos
Datos del pagador.
- namestring
  Nombre completo del pagador.
- taxIdstring
  Documento del pagador.
- emailstring
  Correo electrónico del pagador.
- phonestring
  Teléfono del pagador con código de área.
externalRefstring
Referencia externa del pago definida por el integrador.
orderIdstring
Identificador del pedido en el sistema del integrador.
notificationUrlstring
URL configurada para recibir notificaciones (webhooks).
paidAtstring
Fecha y hora en que el pago fue realizado.
refundedAtstring
Fecha y hora del reembolso, cuando aplique.
createdAtstring
Fecha y hora de creación del pago.
updatedAtstring
Fecha y hora de la última actualización.
dataobject8 campos
Datos específicos del método de pago.
- methodstring
  Método de pago relacionado con los datos devueltos.
- copypastestring
  Código PIX copia y pega (cuando el método es PIX).
- messagestring
  Mensaje de respuesta del operador de tarjeta.
- cardHolderstring
  Nombre impreso en la tarjeta.
- cardNumberstring
  Número de tarjeta enmascarado.
- cardExpMonthstring
  Mes de vencimiento de la tarjeta.
- cardExpYearstring
  Año de vencimiento de la tarjeta.
- barcodestring
  Código de barras del boleto.
splitsarray of objects5 campos
Configuración de split de pago.
- amountintegerpredeterminado: 0
  Monto destinado al receptor del split en centavos.
- currencystring
  Moneda del split.
- percentinteger
  Porcentaje del split (ej: 100 = 100%).
- storeIdstring
  Identificador de la tienda o receptor.
- splitIdstring
  Identificador del split, cuando exista.
itemsarray of objects4 campos
Lista de productos incluidos en el pago.
- quantityinteger
  Cantidad del producto. Debe ser mayor que cero.
- namestring
  Nombre del producto.
- priceinteger
  Precio unitario en centavos.
- typestring
  Tipo de producto [DIGITAL, PHYSICAL].
metadataobject9 campos
Metadatos del pago utilizados para seguimiento y control.
- providerstring
  Origen responsable de la creación del pago.
- orderIdstring
  Identificador único del pedido.
- sellerTaxIdstring
  Documento fiscal del vendedor.
- sellerEmailstring
  Correo electrónico del vendedor.
- checkoutUrlstring
  URL del checkout donde se inició el pago.
- returnUrlstring
  URL de redirección después del pago.
- shopUrlstring
  Página de venta u oferta de origen.
- referrerLinkstring
  URL de origen inmediato del usuario.
- extrastring
  Campo libre para metadatos adicionales.
utmsobject7 campos
Parámetros UTM que identifican el origen del tráfico del pago.
- utmSourcestring
  Origen del tráfico que generó el acceso.
- utmMediumstring
  Medio o canal utilizado por la campaña.
- utmCampaignstring
  Nombre de la campaña responsable del acceso.
- utmContentstring
  Variación del anuncio o creativo que originó el acceso.
- utmTermstring
  Palabra clave asociada al anuncio o a la búsqueda que originó el acceso.
- srcstring
  Código de origen del tráfico (parámetro src) reenviado en la URL.
- sckstring
  Código secundario de seguimiento (parámetro sck) reenviado en la URL.

400Objeto de respuesta devuelto cuando la solicitud contiene datos inválidos.

¿Algo mal en esta página? Habla con nosotros