Get payment by Id

Información completa del pago. Datos con los que fue creado y el estado actual del pago.

SecurityApi-Key
Request
path Parameters
id
required
string <= 255 characters

Identificador del pago

Responses
200

Operación exitosa. Devuelve un objeto JSON con la información de pago.

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.

Example: "https://khipu.com/payment/info/gqzdy6chjne9"
simplified_transfer_url
required
string

URL de pago simplificado.

Example: "https://app.khipu.com/payment/simplified/gqzdy6chjne9"
transfer_url
required
string

URL de pago normal.

Example: "https://khipu.com/payment/manual/gqzdy6chjne9"
app_url
required
string

URL para invocar el pago desde un dispositivo móvil usando la APP de Khipu.

Example: "khipu:///pos/gqzdy6chjne9"
ready_for_terminal
required
boolean

Es true si el pago ya cuenta con todos los datos necesarios para abrir directamente la aplicación de pagos Khipu.

Example: false
notification_token
required
string

Cadena de caracteres alfanuméricos que identifican unicamente al pago, es el identificador que el servidor de Khipu enviará al servidor del comercio cuando notifique que un pago está conciliado.

Example: "9dec8aa176c5223026919b3b5579a4776923e646ff3be686b9e6b62ec042e91f"
receiver_id
required
integer <int64>

Identificador único de una cuenta de cobro.

Example: 985101
conciliation_date
required
string <date-time>

Fecha y hora de conciliación del pago. Formato ISO-8601.

Example: "2017-03-01T13:00:00.000Z"
subject
required
string

Motivo del pago.

Example: "Test"
amount
required
number <double>

El monto del cobro.

Example: 1000
currency
required
string

El código de moneda en formato ISO-4217.

Example: "CLP"
status
required
string

Estado del pago, puede ser pending (el pagador aún no comienza a pagar), verifying (se está verificando el pago) o done, cuando el pago ya está confirmado.

Enum: "pending" "verifying" "done"
Example: "done"
status_detail
required
string

Detalle del estado del pago: pending (el pagador aún no comienza a pagar), normal (el pago fue verificado y fue cancelado por algún medio de pago estándar), marked-paid-by-receiver (el cobrador marcó el cobro como pagado por otro medio), rejected-by-payer (el pagador declaró que no pagará), marked-as-abuse (el pagador declaró que no pagará y que el cobro fue no solicitado), y reversed (el pago fue anulado por el comercio, el dinero fue devuelto al pagador).

Enum: "pending" "normal" "marked-paid-by-receiver" "rejected-by-payer" "marked-as-abuse" "reversed"
Example: "normal"
body
required
string

Detalle del cobro.

Example: "Test"
picture_url
required
string

URL con imagen del cobro.

Example: "https://micomercio.com/picture_url"
receipt_url
required
string

URL del comprobante de pago.

Example: "https://micomercio.com/order/receipt_url"
return_url
required
string

URL donde se redirige al pagador luego que termina el pago.

Example: "https://micomercio.com/order/return_url"
cancel_url
required
string

URL donde se redirige al pagador luego de que desiste hacer el pago.

Example: "https://micomercio.com/order/cancel_url"
notify_url
required
string

URL del webservice donde se notificará el pago.

Example: "https://micomercio.com/webhook/notify_url"
notify_api_version
required
string

Versión de la API de notificación.

Example: "3.0"
expires_date
required
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"
attachment_urls
required
Array of strings >= 0 items

Arreglo de URLs de archivos adjuntos al pago.

Example: ["https://micomercio.com/attachment1.pdf"]
bank
required
string

Nombre del banco seleccionado por el pagador.

Example: "Banco de Chile (Edwards Citi)"
bank_id
required
string

Identificador del banco seleccionado por el pagador.

Example: "dfFbF"
payer_name
required
string

Nombre del pagador.

Example: "Nombre Pagador"
payer_email
required
string <email>

Correo electrónico del pagador.

Example: "pagador@email.com"
personal_identifier
required
string

Identificador personal del pagador.

Example: "11.000.111-9"
bank_account_number
required
string

Número de cuenta bancaria del pagador.

Example: "001120490689"
out_of_date_conciliation
required
boolean

Es true si la conciliación del pago fue hecha luego de la fecha de expiración.

Example: true
transaction_id
required
string

Identificador del pago asignado por el cobrador.

Example: "zwo3wqz6uulcvajt"
custom
required
string

Campo genérico que asigna el cobrador al momento de hacer el pago.

Example: "<xml>...</xml>"
responsible_user_email
required
string

Correo electrónico de la persona responsable del pago.

Example: "responsible@email.com"
send_reminders
required
boolean

Es true cuando este es un cobro por correo electrónico y Khipu enviará recordatorios.

Example: true
send_email
required
boolean

Es true cuando Khipu enviará el cobro por correo electrónico.

Example: true
payment_method
required
string

Método de pago usado por el pagador, puede ser regular_transfer (transferencia normal) o simplified_transfer (transferencia simplificada).

Enum: "regular_transfer" "simplified_transfer" "not_available"
Example: "simplified_transfer"
funds_source
required
string

Origen de fondos usado por el pagador, puede ser debit para pago con débito, prepaid para pago con prepago, credit para pago con crédito, o vacío en el caso de que se haya pagado mediante transferencia bancaria.

Enum: "debit" "prepaid" "credit" "not-available" ""
Example: "debit"
discount
number <double>

Monto a descontar del valor pagado.

Example: 0
third_party_authorization_details
string

Ignorar este campo.

400

Bad request - Solicitud mal formada

401

Unauthorized - Credenciales no válidas o faltantes

403

Forbidden - Cliente no tiene privilegios

404

Not found - Recurso no disponible

500

Internal server error - Servidor no pudo completar la solicitud

get/v3/payments/{id}
Request samples
Response samples
application/json
{}