Docs
PTENES Sitio Crear cuenta

TransferenciasCrear Transferencia

Crear Transferencia

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

Autenticación: Bearer · clave de retiro

Para crear una transferencia, utilice la ruta v1/transfer. Esta ruta es compatible con transferencias vía PIX.

Importante: En lugar de utilizar el token estándar para realizar la solicitud, debe utilizar la Credencial de Retiro vía API, disponible en la página de Integraciones, en la tarjeta "Credenciales de Retiro vía API".

Cuerpo de la solicitud

Enviado en JSON.

  • amountintegerobligatorio

    Valor de la transferencia en centavos. R$ 1,00.

  • methodstringobligatorio

    Método de transferencia. Actualmente soportado: PIX.

  • externalRefstring

    Referencia externa asignada por el integrador.

  • notificationUrlstring

    URL donde se enviarán los webhooks de la transferencia.

  • pixobjectobligatorio2 campos

    Datos de la transferencia vía Pix.

    • pixKeystringobligatorio

      Clave Pix del receptor.

    • pixKeyTypestringobligatorio

      Tipo de clave Pix (CPF, CNPJ, EMAIL, PHONE, EVP, COPYPASTE).

Respuestas

200Objeto de respuesta retornado cuando la transferencia se crea o actualiza con éxito.
  • idstring

    Identificador único de la transferencia.

  • amountinteger

    Valor de la transferencia en centavos.

  • methodstring

    Método de transferencia utilizado (ej: PIX).

  • currencystring

    Código de moneda de la transferencia (ej: BRL).

  • statusstring

    Estado actual de la transferencia (IN_QUEUE, IN_ANALYSIS, APPROVED, PROCESSING, COMPLETED, REFUSED, FAILED).

  • messagestring

    Mensaje adicional asociado al estado de la transferencia.

  • externalRefstring

    Referencia externa asignada por el integrador.

  • notificationUrlstring

    URL configurada para recibir notificaciones de la transferencia.

  • approvedAtstring

    Fecha y hora en que la transferencia fue aprobada.

  • refusedAtstring

    Fecha y hora en que la transferencia fue rechazada.

  • cancelledAtstring

    Fecha y hora en que la transferencia fue cancelada.

  • paidAtstring

    Fecha y hora en que la transferencia fue pagada.

  • createdAtstring

    Fecha y hora de creación de la transferencia.

  • updatedAtstring

    Fecha y hora de la última actualización de la transferencia.

  • dataobject4 campos

    Datos específicos del método de transferencia.

    • methodstring

      Método de transferencia relacionado con los datos devueltos.

    • pixKeystring

      Clave Pix utilizada en la transferencia cuando el método es PIX.

    • e2estring

      End to End ID de la transferencia Pix.

    • pixKeyTypestring

      Tipo de clave Pix (CPF, CNPJ, EMAIL, PHONE, EVP).

400Error de validación al crear la transferencia.

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