RecurrenciaCrear recurrencia

Crear recurrencia

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

Autenticación: Bearer · clave de API

Use la ruta v1/recurrency para crear un cobro que se repite en cada ciclo. En Pix Automático la recurrencia nace PENDING y espera que el pagador autorice. En tarjeta, la adquirente puede ya cobrar la primera cuota en la creación, y entonces nace ACTIVE o FAILED; si el cobro queda para después, nace PENDING y pasa a ACTIVE cuando se paga el primer cobro.

Cuerpo de la solicitud

Enviado en JSON.

amountintegerobligatorio
Importe cobrado en cada ciclo en centavos. Ejemplo: R$ 1,00.
currencystringobligatorio
Moneda de la recurrencia. Hoy solo BRL tiene método de recurrencia.
methodstringobligatorio
Método de recurrencia (PIXAUTOMATIC, CREDIT_CARD).
descriptionstringobligatorio
Descripción de la recurrencia. Va a la adquirente y el pagador la ve en el extracto y en sus avisos.
frequencystringobligatorio
Frecuencia del cobro (WEEKLY, MONTHLY, QUARTERLY, SEMIANNUALLY, ANNUALLY).
customerobjectobligatorio5 campos
Datos de quien está pagando la recurrencia.
- namestringobligatorio
  Nombre completo del pagador.
- taxIdstringobligatorio
  Documento del pagador.
- emailstringobligatorio
  Correo electrónico del pagador.
- phonestring
  Teléfono del pagador. Puede ser obligatorio según el procesador.
- addressobjectobligatorio8 campos
  Dirección de cobro.
  - 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.
externalRefstring
Referencia externa de la recurrencia.
notificationUrlstring
URL adonde se enviarán los webhooks de la recurrencia.
splitsarray of strings
Lista de IDs de splits. Ejemplo: ["split_id_1", "split_id_2"].
metadataobject10 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.
- memberProductUrlstring
  Página del producto del área de miembros que originó la compra.
- returnUrlstring
  URL de retorno después del pago.
- shopUrlstring
  Página de venta.
- referrerLinkstring
  URL de origen inmediato.
- extrastring
  Campo libre para metadatos adicionales.

Respuestas

200Recurrencia creada. El estado depende del medio y de si la adquirente cobró en el momento: PENDING, ACTIVE o FAILED.

403La tienda no tiene recurrencia habilitada para este medio o moneda.

422El importe está fuera del ticket mínimo o máximo configurado para la tienda.

messagestring
Mensaje descriptivo del error.
detailsobject
Detalles adicionales del error.

400Error de validación en el cuerpo de la solicitud.

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