La dirección URL del archivo PDF con el contrato a firmar mediante este pago. El cobrador debe estar habilitado para este servicio y el campo fixed_payer_personal_identifier es obligatorio.
Example: "https://micomercio.com/contract_url"
notify_api_version
string <= 255 characters
Versión de la API de notificaciones para recibir avisos por web-service.
Example: "3.0"
expires_date
string <date-time>
Fecha máxima para ejecutar el pago (en formato ISO-8601). El cliente podrá realizar varios intentos de pago hasta dicha fecha. Cada intento tiene un plazo individual de 3 horas para su ejecución.
Example: "2023-12-31T15:45:00-04:00"
send_email
boolean
Si es true, se enviará una solicitud de cobro al correo especificado en payer_email.
Example: false
payer_name
string <= 255 characters
Nombre del pagador. Es obligatorio cuando send_email es true.
Example: "Nombre Pagador"
payer_email
string <email> <= 255 characters
Correo del pagador. Es obligatorio cuando send_email es true.
Example: "pagador@email.com"
send_reminders
boolean
Si es true, se enviarán recordatorios de cobro.
Example: true
responsible_user_email
string <email> <= 255 characters
Correo electrónico del responsable de este cobro, debe corresponder a un usuario Khipu con permisos para cobrar usando esta cuenta de cobro.
Example: "responsible@email.com"
fixed_payer_personal_identifier
string <= 255 characters
Identificador personal. Si se especifica, solo podrá ser pagado usando ese identificador.
Example: "11.000.111-9"
integrator_fee
string <= 16 characters
Comisión para el integrador. Sólo es válido si la cuenta de cobro tiene una cuenta de integrador asociada.
Example: "100"
collect_account_uuid
string <= 255 characters
Para cuentas de cobro con más cuenta propia. Permite elegir la cuenta donde debe ocurrir la transferencia.
Example: "007367340234"
confirm_timeout_date
string <date-time>
Fecha de rendición del cobro. Es también la fecha final para poder reembolsar el cobro. Formato ISO-8601.
Example: "2017-03-01T13:00:00Z"
mandatory_payment_method
string <= 255 characters
El cobro sólo se podrá pagar utilizando el medio de pago especificado. Los posibles valores para este campo se encuentran en el campo id de la respuesta del endpoint /api/3.0/merchants/paymentMethods.
Example: "simplified_transfer"
psp_client_merchant_name
string [ 3 .. 255 ] characters
Nombre del comercio final para quien un proveedor de servicios de pago procesa un pago. Requerido para transacciones de clientes PSP; no aplicable para otros. En caso de tratarse de un PSP de PSP, estos deben ingresarse separados por '->'.
Example: "PSP 1->PSP 2->Client Name"
Responses
200
Operación exitosa. Devuelve un objeto JSON con la información del pago creado.
Response Schema: application/json
payment_id
required
string
Identificador único del pago, es una cadena alfanumérica de 12 caracteres. Como este identificador es único, se puede usar, por ejemplo, para evitar procesar una notificación repetida. (Khipu espera un código 200 al notificar un pago, si esto no ocurre se reintenta hasta por dos días).
Example: "gqzdy6chjne9"
payment_url
required
string
URL principal del pago, si el usuario no ha elegido previamente un método de pago se le muestran las opciones.