### GET /v3/merchants/{id}/paymentMethods Source: https://docs.khipu.com/apis/v3/instant-payments/openapi/other/getmerchantpaymentmethodsbyid Retrieves the list of available payment methods for a collector account. ```APIDOC ## GET /v3/merchants/{id}/paymentMethods ### Description Obtiene el listado de medios de pago disponible para una cuenta de cobrador. ### Method GET ### Endpoint /v3/merchants/{id}/paymentMethods ### Parameters #### Path Parameters - **id** (number) - Required - Identificador de la cuenta de cobro ### Response #### Success Response (200) - **paymentMethods** (array) - Required - Arreglo con métodos de pago disponibles. - **paymentMethods.id** (string) - Required - Identificador del medio de pago. Example: "simplified_transfer" - **paymentMethods.name** (string) - Required - Nombre del medio de pago. Example: "simplified_transfer" - **paymentMethods.logo_url** (string) - Required - URL del logo sugerido para mostrar. Example: "https://s3.amazonaws.com/static.khipu.com/buttons/2015/150x50-transparent.png" ``` -------------------------------- ### GET /v3/receivers/children Source: https://docs.khipu.com/apis/v3/instant-payments/openapi/other/getreceivers Retrieves a list of collection accounts associated with an integrator. This feature is only available for clients who have contracted it independently. Contact support@khipu.com to enable it. ```APIDOC ## GET /v3/receivers/children ### Description Obtain the list of collection accounts associated with an integrator. ### Method GET ### Endpoint /v3/receivers/children ### Query Parameters - **offset** (integer) - Optional - Number of records to skip for pagination. - **max** (integer) - Optional - Maximum number of records to return. Example: 100 - **sort** (string) - Optional - Field by which to sort the results. Enum: "id", "name", "date_created" - **order** (string) - Optional - Direction of the sorting. Enum: "asc", "desc" ### Response #### Success Response (200) - **receivers** (array, required) - List of collection accounts associated with the integrator. - **receivers.id** (integer, required) - Unique identifier of the collection account. Example: 302026 - **receivers.name** (string, required) - Name of the collection account. Example: "Cobrador 20260311115756" - **receivers.date_created** (string, required) - Creation date of the collection account. Example: "2026-03-11T14:57:56Z" - **receivers.disabled** (boolean, required) - Indicates if the collection account is disabled. - **receivers.can_collect** (boolean, required) - Indicates if the collection account can receive payments. Example: true - **total** (integer, required) - Total number of collection accounts associated with the integrator. Example: 150 #### Response Example ```json { "receivers": [ { "id": 302026, "name": "Cobrador 20260311115756", "date_created": "2026-03-11T14:57:56Z", "disabled": false, "can_collect": true } ], "total": 150 } ``` ``` -------------------------------- ### GET /v3/banks Source: https://docs.khipu.com/apis/v3/instant-payments/openapi/other/getbanks Retrieves a list of banks that can be used for payments in a collection account. ```APIDOC ## GET /v3/banks ### Description This method retrieves the list of banks that can be used to pay in this collection account. ### Method GET ### Endpoint /v3/banks ### Parameters ### Request Body ### Request Example ### Response #### Success Response (200) - **banks** (array, required) - Array with the list of banks. - **banks.bank_id** (string, required) - Identifier of the bank. Example: "SDdGj" - **banks.name** (string, required) - Name of the bank. Example: "Banco Estado" - **banks.message** (string, required) - Message with bank specific details. Example: "Tarifa de $300 de transferencia a otros bancos, usando CuentaRUT." - **banks.min_amount** (number, required) - Minimum amount the bank accepts in a payment. Example: 1000 - **banks.type** (string, required) - Type of bank. Enum: "Persona", "Empresa" - **banks.parent** (string, required) - Identifier of the parent bank (if a bank has personal and business banking, the first will be the parent of the second). - **banks.logo_url** (string) - URL of the bank's logo. Example: "https://s3.amazonaws.com/static.khipu.com/logos/bancos/chile/estado-icon.png" #### Response Example { "banks": [ { "bank_id": "SDdGj", "name": "Banco Estado", "message": "Tarifa de $300 de transferencia a otros bancos, usando CuentaRUT.", "min_amount": 1000, "type": "Persona", "parent": null, "logo_url": "https://s3.amazonaws.com/static.khipu.com/logos/bancos/chile/estado-icon.png" } ] } ``` -------------------------------- ### Get Banks Source: https://docs.khipu.com/apis/v3/instant-payments/openapi.md Retrieves a list of available banks for making payments, including details like limits, fees, and logos. ```APIDOC ## GET /v3/banks ### Description This method obtains the list of banks that can be used to pay in this collection account. ### Method GET ### Endpoint /v3/banks ### Parameters #### Query Parameters None ### Request Example None ### Response #### Success Response (200) - **banks** (array) - List of available banks with their details. #### Response Example ```json { "banks": [ { "id": "1", "name": "Banco de Chile", "short_name": "BC", "logo_url": "https://example.com/logos/banco_chile.png", "min_amount": 1000, "max_amount": 1000000, "fee_percentage": 0.5, "fee_fixed": 100 } ] } ``` ``` -------------------------------- ### Get Payment by ID Source: https://docs.khipu.com/apis/v3/instant-payments/openapi.md Retrieves complete information about a payment, including creation details and its current status. ```APIDOC ## GET /v3/payments/{id} ### Description Retrieves complete information about a payment, including the data with which it was created and its current status. ### Method GET ### Endpoint /v3/payments/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the payment to retrieve. ### Request Example None ### Response #### Success Response (200) - **payment_id** (string) - The unique identifier of the payment. - **status** (string) - The current status of the payment (e.g., "pending", "paid", "failed"). - **amount** (number) - The amount of the payment. - **currency** (string) - The currency of the payment. - **created_at** (string) - The timestamp when the payment was created. - **bank_details** (object) - Details about the bank used for the payment (if applicable). #### Response Example ```json { "payment_id": "pay_12345", "status": "paid", "amount": 50000, "currency": "CLP", "created_at": "2023-10-27T10:00:00Z", "bank_details": { "bank_name": "Banco de Chile", "account_number": "123456789" } } ``` ``` -------------------------------- ### GET /v3/payments/{id} Source: https://docs.khipu.com/apis/v3/instant-payments/openapi/other/getpaymentbyid.md Retrieves comprehensive payment information, including creation details and current status, using the payment's unique ID. ```APIDOC ## GET /v3/payments/{id} ### Description Información completa del pago. Datos con los que fue creado y el estado actual del pago. ### Method GET ### Endpoint /v3/payments/{id} ### Parameters #### Path Parameters - **id** (string) - Required - Identificador del pago ``` -------------------------------- ### GET /v3/predict - Payment Prediction Source: https://docs.khipu.com/apis/v3/instant-payments/openapi/other/getpredict.md Predicts the outcome of a payment and provides information on maximum transfer amounts. ```APIDOC ## GET /v3/predict ### Description Predicción acerca del resultado de un pago, si podrá o no funcionar. Información adicional como máximo posible de transferir a un nuevo destinatario. ### Method GET ### Endpoint /v3/predict ### Query Parameters - **payer_email** (string) - Required - Correo electrónico del pagador - **bank_id** (string) - Required - Identificador del banco de origen - **amount** (string) - Required - Monto del pago - **currency** (string) - Required - Moneda en formato ISO-4217 ### Response #### Success Response (200) - **new_destinatary_max_amount** (number) - Monto máximo para transferir a un nuevo destinatario. - **max_amount** (number) - El monto máximo posible para transferir. - **result** (string) - El resultado de la predicción. Enum: "ok", "new_destinatary_amount_exceeded", "max_amount_exceeded", "new_destinatary_cool_down", "not_available_account" - **cool_down_date** (string) - Fecha de término para la restricción de monto en formato ISO-8601 #### Response Example ```json { "new_destinatary_max_amount": 100000, "max_amount": 5000000, "result": "ok", "cool_down_date": "2024-06-21T11:23:09.123Z" } ``` ``` -------------------------------- ### Get Receivers Source: https://docs.khipu.com/apis/v3/instant-payments/openapi.md Retrieves a list of collection accounts associated with an integrator. This function is only available for specific clients and requires contacting support. ```APIDOC ## GET /v3/receivers/children ### Description Retrieves the list of collection accounts associated with an integrator. This function is only available for clients who have contracted it independently. Contact support@khipu.com for access. ### Method GET ### Endpoint /v3/receivers/children ### Parameters None ### Request Example None ### Response #### Success Response (200) - **receivers** (array) - A list of collection accounts associated with the integrator. #### Response Example ```json { "receivers": [ { "receiver_id": "rec_abc123", "name": "Collection Account 1", "status": "active" }, { "receiver_id": "rec_def456", "name": "Collection Account 2", "status": "inactive" } ] } ``` ``` -------------------------------- ### Get Payment Prediction Source: https://docs.khipu.com/apis/v3/instant-payments/openapi.md Provides a prediction about the outcome of a payment, indicating whether it is likely to succeed. It may also offer additional information, such as the maximum amount that can be transferred to a new recipient. ```APIDOC ## GET /v3/predict ### Description Prediction about the outcome of a payment, whether it will work or not. Additional information such as the maximum possible to transfer to a new recipient. ### Method GET ### Endpoint /v3/predict ### Parameters #### Query Parameters - **amount** (number) - Required - The amount of the payment to predict. - **currency** (string) - Required - The currency of the payment. - **recipient_bank_id** (string) - Optional - The ID of the recipient's bank. ### Request Example None (Parameters are passed as query parameters). ### Response #### Success Response (200) - **prediction** (string) - The predicted outcome (e.g., "success", "failure"). - **confidence_score** (number) - The confidence score of the prediction. - **max_transfer_amount** (number) - The maximum amount that can be transferred (if applicable). #### Response Example ```json { "prediction": "success", "confidence_score": 0.95, "max_transfer_amount": 100000 } ``` ``` -------------------------------- ### Create Payment Source: https://docs.khipu.com/apis/v3/instant-payments/openapi.md Creates a payment in Khipu and provides URLs for redirecting the user to complete the payment process. ```APIDOC ## POST /v3/payments ### Description Creates a payment in Khipu and obtains the URLs for redirecting the user to complete the payment. ### Method POST ### Endpoint /v3/payments ### Parameters #### Request Body - **amount** (number) - Required - The amount of the payment. - **currency** (string) - Required - The currency of the payment (e.g., "CLP"). - **bank_id** (string) - Optional - The ID of the bank to use for the payment. If not specified, the user can choose. - **return_url** (string) - Required - The URL to redirect the user to after payment completion. - **transaction_id** (string) - Optional - A unique identifier for the transaction from your system. ### Request Example ```json { "amount": 50000, "currency": "CLP", "bank_id": "1", "return_url": "https://your-merchant.com/payment-success", "transaction_id": "order_abc123" } ``` ### Response #### Success Response (200) - **payment_id** (string) - The unique identifier of the created payment. - **payment_url** (string) - The URL to redirect the user to complete the payment. #### Response Example ```json { "payment_id": "pay_12345", "payment_url": "https://payment.khipu.com/pay?token=xyz789" } ``` ``` -------------------------------- ### POST /v3/payments Source: https://docs.khipu.com/apis/v3/instant-payments/openapi/other/postpayment.md Creates a payment in Khipu and obtains URLs for user redirection to complete the payment. ```APIDOC ## POST /v3/payments ### Description Creates a payment in Khipu and obtains URLs for user redirection to complete the payment. ### Method POST ### Endpoint /v3/payments ### Parameters #### Request Body - **amount** (number) - Required - The amount of the charge. Without thousands separator and using '.' as decimal separator. Up to 4 decimal places, depending on the currency. - **currency** (string) - Required - The currency code in ISO-4217 format. Enum: "CLP", "CLF", "ARS", "PEN", "MXN", "USD", "EUR", "BOB", "COP" - **subject** (string) - Required - Reason for the charge. - **transaction_id** (string) - Optional - Your own transaction identifier. Ex: invoice or purchase order number. - **custom** (string) - Optional - Parameter to send custom transaction information. Ex: XML document with shopping cart details. - **body** (string) - Optional - Description of the charge. - **bank_id** (string) - Optional - Identifier of the bank to use for the payment. - **return_url** (string) - Optional - The URL to send the customer to while the payment is being verified. - **cancel_url** (string) - Optional - The URL to send the customer to if they decide not to complete the transaction. - **picture_url** (string) - Optional - A URL of a picture of your product or service. - **notify_url** (string) - Optional - The web service address that Khipu will use to notify when the payment is reconciled. - **contract_url** (string) - Optional - The URL of the PDF file with the contract to be signed through this payment. The payer must be enabled for this service and the `fixed_payer_personal_identifier` field is mandatory. - **notify_api_version** (string) - Optional - Notification API version to receive web service notifications. - **expires_date** (string) - Optional - Maximum date to execute the payment (in ISO-8601 format). The customer can make multiple payment attempts until this date. Each attempt has an individual deadline of 3 hours for execution. - **send_email** (boolean) - Optional - If true, a collection request will be sent to the email specified in `payer_email`. - **payer_name** (string) - Optional - Payer's name. It is mandatory when `send_email` is true. - **payer_email** (string) - Optional - Payer's email. It is mandatory when `send_email` is true. - **send_reminders** (boolean) - Optional - If true, collection reminders will be sent. - **responsible_user_email** (string) - Optional - Email address of the person responsible for this collection, must correspond to a Khipu user with permissions to collect using this collection account. - **fixed_payer_personal_identifier** (string) - Optional - Personal identifier. If specified, it can only be paid using that identifier. - **integrator_fee** (string) - Optional - Fee for the integrator. Only valid if the collection account has an associated integrator account. - **collect_account_uuid** (string) - Optional - For collection accounts with more than one own account. Allows choosing the account where the transfer should occur. - **confirm_timeout_date** (string) - Optional - Collection reconciliation date. It is also the final date to be able to refund the collection. ISO-8601 format. - **mandatory_payment_method** (string) - Optional - The collection can only be paid using the specified payment method. Possible values for this field are found in the `id` field of the response of the `/api/3.0/merchants/paymentMethods` endpoint. - **psp_client_merchant_name** (string) - Optional - The final merchant name for whom a payment service provider processes a payment. Required for PSP client transactions; not applicable for others. In case of PSP of PSPs, these must be entered separated by '->'. ### Request Example ```json { "amount": 1000, "currency": "CLP", "subject": "Cobro de prueba", "transaction_id": "zwo3wqz6uulcvajt", "custom": "...", "body": "Cobro de orden de compra #123-abcdef", "bank_id": "SDdGj", "return_url": "https://micomercio.com/order/return_url", "cancel_url": "https://micomercio.com/order/cancel_url", "picture_url": "https://micomercio.com/picture_url", "notify_url": "https://micomercio.com/webhook/notify_url", "contract_url": "https://micomercio.com/contract_url", "notify_api_version": "3.0", "expires_date": "2023-12-31T15:45:00-04:00", "send_email": true, "payer_name": "Nombre Pagador", "payer_email": "pagador@email.com", "send_reminders": true, "responsible_user_email": "responsible@email.com", "fixed_payer_personal_identifier": "11.000.111-9", "integrator_fee": "100", "collect_account_uuid": "007367340234", "confirm_timeout_date": "2017-03-01T13:00:00Z", "mandatory_payment_method": "simplified_transfer", "psp_client_merchant_name": "PSP 1->PSP 2->Client Name" } ``` ### Response #### Success Response (200) - **amount** (number) - The amount of the charge. - **currency** (string) - The currency code in ISO-4217 format. - **subject** (string) - Reason for the charge. - **transaction_id** (string) - Your own transaction identifier. - **url** (string) - URL to redirect the user to complete the payment. - **payment_id** (string) - Unique identifier for the payment. - **state** (string) - Current state of the payment. #### Response Example ```json { "amount": 1000, "currency": "CLP", "subject": "Cobro de prueba", "transaction_id": "zwo3wqz6uulcvajt", "url": "https://khipu.com/pay/abcdef12345", "payment_id": "abcdef12345", "state": "PENDING" } ``` ``` -------------------------------- ### POST /v3/payments/{id}/refunds Source: https://docs.khipu.com/apis/v3/instant-payments/openapi/other/postpaymentrefundsbyid Reembolsa total o parcialmente el monto de un pago. Esta operación solo se puede realizar en los comercios que recauden en cuenta Khipu y antes de la rendición de los fondos correspondientes. ```APIDOC ## POST /v3/payments/{id}/refunds ### Description Reembolsa total o parcialmente el monto de un pago. Esta operación solo se puede realizar en los comercios que recauden en cuenta Khipu y antes de la rendición de los fondos correspondientes. ### Method POST ### Endpoint /v3/payments/{id}/refunds ### Parameters #### Path Parameters - **id** (string) - Required - Identificador del pago #### Request Body - **amount** (number) - Optional - El monto a devolver. Sin separador de miles y usando '.' como separador de decimales. Hasta 4 lugares decimales, dependiendo de la moneda. Si se omite el reembolso se hará por el total del monto del pago. ### Request Example ```json { "amount": 1000 } ``` ### Response #### Success Response (200) - **message** (string) - Required - Mensaje a desplegar al usuario. #### Response Example ```json { "message": "Message." } ``` ``` -------------------------------- ### Payment Response (200 OK) Source: https://docs.khipu.com/apis/v3/instant-payments/openapi/other/getpaymentbyid.md This section describes the fields returned in a successful JSON response (HTTP 200 OK) after a payment is processed via the Khipu API v3. These fields provide all necessary information about the payment and its transaction. ```APIDOC ## Payment Response (200 OK) ### Description Details of the fields returned in a successful JSON response (HTTP 200 OK) after a payment is processed via the Khipu API v3. ### Method N/A (This describes a response structure, not a specific request method) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response #### Success Response (200) - **payment_id** (string, required) - Unique identifier for the payment, an alphanumeric string of 12 characters. Example: "gqzdy6chjne9" - **payment_url** (string, required) - Main URL for the payment. If the user has not previously chosen a payment method, options will be displayed. Example: "https://khipu.com/payment/info/gqzdy6chjne9" - **simplified_transfer_url** (string, required) - Simplified payment URL. Example: "https://app.khipu.com/payment/simplified/gqzdy6chjne9" - **transfer_url** (string, required) - Normal payment URL. Example: "https://khipu.com/payment/manual/gqzdy6chjne9" - **app_url** (string, required) - URL to invoke the payment from a mobile device using the Khipu APP. Example: "khipu:///pos/gqzdy6chjne9" - **ready_for_terminal** (boolean, required) - True if the payment has all the necessary data to directly open the Khipu payment application. - **notification_token** (string, required) - Alphanumeric string uniquely identifying the payment, used by Khipu's server to notify the merchant's server when a payment is reconciled. Example: "9dec8aa176c5223026919b3b5579a4776923e646ff3be686b9e6b62ec042e91f" - **receiver_id** (integer, required) - Unique identifier for a collection account. Example: 985101 - **conciliation_date** (string, required) - Date and time of payment reconciliation in ISO-8601 format. Example: "2017-03-01T13:00:00.000Z" - **subject** (string, required) - Reason for the payment. Example: "Test" - **amount** (number, required) - The amount of the charge. Example: 1000 - **currency** (string, required) - The currency code in ISO-4217 format. Example: "CLP" - **status** (string, required) - Payment status. Enum: "pending", "verifying", "done". - **status_detail** (string, required) - Detail of the payment status. Enum: "pending", "normal", "marked-paid-by-receiver", "rejected-by-payer", "marked-as-abuse", "reversed". - **body** (string, required) - Detail of the charge. Example: "Test" - **picture_url** (string, required) - URL with an image of the charge. Example: "https://micomercio.com/picture_url" - **receipt_url** (string, required) - URL of the payment receipt. Example: "https://micomercio.com/order/receipt_url" - **return_url** (string, required) - URL to redirect the payer after payment completion. Example: "https://micomercio.com/order/return_url" - **cancel_url** (string, required) - URL to redirect the payer if they decide not to proceed with the payment. Example: "https://micomercio.com/order/cancel_url" - **notify_url** (string, required) - URL of the webservice where the payment will be notified. Example: "https://micomercio.com/webhook/notify_url" - **notify_api_version** (string, required) - Notification API version. Example: "3.0" - **expires_date** (string, required) - Maximum date to execute the payment (ISO-8601 format). Example: "2023-12-31T15:45:00-04:00" - **attachment_urls** (array, required) - Array of URLs for files attached to the payment. Example: ["https://micomercio.com/attachment1.pdf"] - **bank** (string, required) - Name of the bank selected by the payer. Example: "Banco de Chile (Edwards Citi)" - **bank_id** (string, required) - Identifier of the bank selected by the payer. Example: "dfFbF" - **payer_name** (string, required) - Name of the payer. Example: "Nombre Pagador" - **payer_email** (string, required) - Email address of the payer. Example: "pagador@email.com" - **personal_identifier** (string, required) - Personal identifier of the payer. Example: "11.000.111-9" - **bank_account_number** (string, required) - Bank account number of the payer. Example: "001120490689" - **out_of_date_conciliation** (boolean, required) - True if the payment reconciliation was done after the expiration date. #### Response Example ```json { "payment_id": "gqzdy6chjne9", "payment_url": "https://khipu.com/payment/info/gqzdy6chjne9", "simplified_transfer_url": "https://app.khipu.com/payment/simplified/gqzdy6chjne9", "transfer_url": "https://khipu.com/payment/manual/gqzdy6chjne9", "app_url": "khipu:///pos/gqzdy6chjne9", "ready_for_terminal": false, "notification_token": "9dec8aa176c5223026919b3b5579a4776923e646ff3be686b9e6b62ec042e91f", "receiver_id": 985101, "conciliation_date": "2017-03-01T13:00:00.000Z", "subject": "Test", "amount": 1000, "currency": "CLP", "status": "done", "status_detail": "normal", "body": "Test", "picture_url": "https://micomercio.com/picture_url", "receipt_url": "https://micomercio.com/order/receipt_url", "return_url": "https://micomercio.com/order/return_url", "cancel_url": "https://micomercio.com/order/cancel_url", "notify_url": "https://micomercio.com/webhook/notify_url", "notify_api_version": "3.0", "expires_date": "2023-12-31T15:45:00-04:00", "attachment_urls": ["https://micomercio.com/attachment1.pdf"], "bank": "Banco de Chile (Edwards Citi)", "bank_id": "dfFbF", "payer_name": "Nombre Pagador", "payer_email": "pagador@email.com", "personal_identifier": "11.000.111-9", "bank_account_number": "001120490689", "out_of_date_conciliation": false } ``` ``` -------------------------------- ### Payment Response (200 OK) Source: https://docs.khipu.com/apis/v3/instant-payments/openapi/other/postpayment.md Details the fields returned in a successful payment response, including identifiers, URLs, and status. ```APIDOC ## Response 200 fields (application/json) ### Description Details the fields returned in a successful payment response. ### Success Response (200) - **payment_id** (string, required) - 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** (string, required) - 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** (string, required) - URL de pago simplificado. Example: "https://app.khipu.com/payment/simplified/gqzdy6chjne9" - **transfer_url** (string, required) - URL de pago normal. Example: "https://khipu.com/payment/manual/gqzdy6chjne9" - **app_url** (string, required) - URL para invocar el pago desde un dispositivo móvil usando la APP de Khipu. Example: "khipu:///pos/gqzdy6chjne9" - **ready_for_terminal** (boolean, required) - Es true si el pago ya cuenta con todos los datos necesarios para abrir directamente la aplicación de pagos Khipu. ### Response Example { "payment_id": "gqzdy6chjne9", "payment_url": "https://khipu.com/payment/info/gqzdy6chjne9", "simplified_transfer_url": "https://app.khipu.com/payment/simplified/gqzdy6chjne9", "transfer_url": "https://khipu.com/payment/manual/gqzdy6chjne9", "app_url": "khipu:///pos/gqzdy6chjne9", "ready_for_terminal": true } ``` -------------------------------- ### POST /v3/payments/{id}/confirm Source: https://docs.khipu.com/apis/v3/instant-payments/openapi/other/postpaymentconfirmbyid Confirms a payment by its ID. Upon confirmation, the payment will be settled on the next business day. This function is only available for clients who have contracted it independently. Contact soporte@khipu.com for access. ```APIDOC ## POST /v3/payments/{id}/confirm ### Description Confirms a payment by its ID. Upon confirmation, the payment will be settled on the next business day. This function is only available for clients who have contracted it independently. Contact soporte@khipu.com for access. ### Method POST ### Endpoint /v3/payments/{id}/confirm ### Parameters #### Path Parameters - **id** (string) - Required - Identificador del pago ### Request Body This endpoint does not require a request body. ### Response #### Success Response (200) - **message** (string) - Required - Mensaje a desplegar al usuario. Example: "Message." #### Response Example ```json { "message": "Message." } ``` #### Error Responses - **400**: Bad Request - **401**: Unauthorized - **403**: Forbidden - **404**: Not Found - **500**: Internal Server Error ``` -------------------------------- ### POST /v3/receivers Source: https://docs.khipu.com/apis/v3/instant-payments/openapi/other/postreceiver Creates a new payment account (receiver) associated with an integrator. This endpoint requires comprehensive details about the account administrator, business, and contact person. ```APIDOC ## POST /v3/receivers ### Description Creates a new payment account (receiver) associated with an integrator. This endpoint requires comprehensive details about the account administrator, business, and contact person. **Warning**: This function is only available for clients who have contracted it independently. To use it, please contact us at soporte@khipu.com. ### Method POST ### Endpoint /v3/receivers ### Parameters #### Request Body - **admin_first_name** (string) - Required - First name of the administrator of the payment account to be created. - **admin_last_name** (string) - Required - Last name of the administrator of the payment account to be created. - **admin_email** (string) - Required - Email address of the administrator of the payment account to be created. - **country_code** (string) - Required - ISO 3166-1 two-character alphanumeric code of the country for the payment account to be created. - **business_identifier** (string) - Required - Tax identifier of the collector associated with the payment account to be created. - **business_category** (string) - Required - Tax category or tax line of the collector associated with the payment account to be created. - **business_name** (string) - Required - Tax name of the collector associated with the payment account to be created. - **business_phone** (string) - Required - Phone number of the collector associated with the payment account to be created. - **business_address_line_1** (string) - Required - Address of the collector for the payment account to be created. - **business_address_line_2** (string) - Optional - Second line of the address of the collector for the payment account to be created. - **business_address_line_3** (string) - Optional - Third line of the address of the collector for the payment account to be created. - **contact_full_name** (string) - Required - Full name of the collector's contact person. - **contact_job_title** (string) - Required - Job title of the collector's contact person. - **contact_email** (string) - Required - Email address of the collector's contact person. - **contact_phone** (string) - Required - Phone number of the collector's contact person. - **bank_account_bank_id** (string) - Optional - Identifier of the bank. - **bank_account_type** (string) - Optional - Account type. It is mandatory if the alternative trusted integrator model is used. - **bank_account_identifier** (string) - Optional - Personal identifier of the bank account owner. - **bank_account_name** (string) - Optional - Name of the bank account. - **bank_account_number** (string) - Optional - Bank account number. - **notify_url** (string) - Optional - Default URL for the webservice where the payment will be notified. - **rendition_url** (string) - Optional - URL for the webservice where the rendition will be notified. ### Request Example ```json { "admin_first_name": "Nombre", "admin_last_name": "Apellido", "admin_email": "admin@email.com", "country_code": "CL", "business_identifier": "99.999.999-9", "business_category": "VENTA AL POR MAYOR DE FRUTAS Y VERDURAS", "business_name": "Nombre Tributario", "business_phone": "+56988887777", "business_address_line_1": "Calle principal 1111", "business_address_line_2": "Oficina 3-A", "business_address_line_3": "Santiago", "contact_full_name": "Nombre Contacto", "contact_job_title": "Tesorero", "contact_email": "contacto@email.com", "contact_phone": "+56955553333", "bank_account_bank_id": "SDdGj", "bank_account_type": "Cuenta Corriente", "bank_account_identifier": "11.333.555-7", "bank_account_name": "Alias Cuenta", "bank_account_number": "00347909823", "notify_url": "http://micomercio.com/account/notify_url", "rendition_url": "http://micomercio.com/account/rendition_url" } ``` ### Response #### Success Response (200) - **receiver_id** (string) - Required - Unique identifier of the payment account. - **secret** (string) - Required - Secret key of the payment account, used to sign all requests. - **api_key** (string) - Optional - API key of the created payment account. #### Response Example ```json { "receiver_id": "934568", "secret": "b2025dc47a29a04592fa3c1191110370db0e208c", "api_key": "d6ec59c7-e299-4704-840d-300442546982" } ``` ``` -------------------------------- ### Post Receiver Source: https://docs.khipu.com/apis/v3/instant-payments/openapi.md Creates a new collection account associated with an integrator. This function is only available for specific clients and requires contacting support. It requires user account details, billing information, and contact information. ```APIDOC ## POST /v3/receivers ### Description Creates a new collection account associated with an integrator. This function is only available for clients who have contracted it independently. Contact support@khipu.com for access. Requires user account details, billing information, and contact information. ### Method POST ### Endpoint /v3/receivers ### Parameters #### Request Body - **user_account_details** (object) - Required - Details of the user's account. - **name** (string) - Required - Full name. - **email** (string) - Required - Email address. - **billing_information** (object) - Required - Billing details. - **company_name** (string) - Required - Company name. - **rut** (string) - Required - RUT number. - **contact_information** (object) - Required - Contact details. - **phone** (string) - Required - Phone number. ### Request Example ```json { "user_account_details": { "name": "Juan Perez", "email": "juan.perez@example.com" }, "billing_information": { "company_name": "My Business Inc.", "rut": "12345678-9" }, "contact_information": { "phone": "+56912345678" } } ``` ### Response #### Success Response (200) - **receiver_id** (string) - The unique identifier of the created receiver. - **status** (string) - The status of the receiver creation. #### Response Example ```json { "receiver_id": "rec_abc123", "status": "created" } ``` ``` -------------------------------- ### Error Responses Source: https://docs.khipu.com/apis/v3/instant-payments/openapi/other/postpayment.md Details the possible error response codes for Khipu API v3 payment endpoints. ```APIDOC ## Error Responses ### Description Details the possible error response codes for Khipu API v3 payment endpoints. ### Response Codes - **400 Bad Request**: Indicates a problem with the request parameters or body. - **401 Unauthorized**: Indicates that authentication failed or is missing. - **403 Forbidden**: Indicates that the authenticated user does not have permission to perform the action. - **404 Not Found**: Indicates that the requested resource could not be found. - **500 Internal Server Error**: Indicates an unexpected error on the server side. ``` -------------------------------- ### Transaction Details Parameters Source: https://docs.khipu.com/apis/v3/instant-payments/openapi/other/getpaymentbyid.md Parameters required for processing a transaction. ```APIDOC ## Transaction Details Parameters ### Description This section outlines the parameters required for processing a transaction, including identifiers, user information, and payment-related settings. ### Parameters #### Request Body - **transaction_id** (string) - Required - Identificador del pago asignado por el cobrador. Example: "zwo3wqz6uulcvajt" - **custom** (string) - Required - Campo genérico que asigna el cobrador al momento de hacer el pago. Example: "..." - **responsible_user_email** (string) - Required - Correo electrónico de la persona responsable del pago. Example: "responsible@email.com" - **send_reminders** (boolean) - Required - Es true cuando este es un cobro por correo electrónico y Khipu enviará recordatorios. Example: true - **send_email** (boolean) - Required - Es true cuando Khipu enviará el cobro por correo electrónico. Example: true - **payment_method** (string) - Required - 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" - **funds_source** (string) - Required - 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", "" - **discount** (number) - Optional - Monto a descontar del valor pagado. - **third_party_authorization_details** (string) - Optional - Ignorar este campo. ### Response #### Error Responses - **Response 400 fields**: Bad Request - **Response 401 fields**: Unauthorized - **Response 403 fields**: Forbidden - **Response 404 fields**: Not Found - **Response 500 fields**: Internal Server Error ``` -------------------------------- ### Refund Payment by ID Source: https://docs.khipu.com/apis/v3/instant-payments/openapi.md Refunds a payment, either partially or fully. This operation is only available for merchants collecting in a Khipu account and before funds are settled. ```APIDOC ## POST /v3/payments/{id}/refunds ### Description Refunds the amount of a payment, either totally or partially. This operation can only be performed on merchants that collect in a Khipu account and before the settlement of the corresponding funds. ### Method POST ### Endpoint /v3/payments/{id}/refunds ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the payment to refund. #### Request Body - **amount** (number) - Optional - The amount to refund. If not specified, the entire payment amount will be refunded. ### Request Example ```json { "amount": 25000 } ``` ### Response #### Success Response (200) - **refund_id** (string) - The unique identifier of the refund transaction. - **status** (string) - The status of the refund operation. #### Response Example ```json { "refund_id": "ref_abc123", "status": "processed" } ``` ``` -------------------------------- ### Confirm Payment by ID Source: https://docs.khipu.com/apis/v3/instant-payments/openapi.md Confirms a payment by its ID. This function is only available for specific clients and requires contacting support. Confirmed payments are settled on the next business day. ```APIDOC ## POST /v3/payments/{id}/confirm ### Description Confirms a payment by its ID. This function is only available for clients who have contracted it independently. Contact support@khipu.com for access. Upon confirmation, the payment will be settled on the next business day. ### Method POST ### Endpoint /v3/payments/{id}/confirm ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the payment to confirm. ### Request Example None (This endpoint does not require a request body). ### Response #### Success Response (200) - **status** (string) - Indicates the success of the confirmation operation. #### Response Example ```json { "status": "confirmed" } ``` ``` -------------------------------- ### DELETE /v3/payments/{id} Source: https://docs.khipu.com/apis/v3/instant-payments/openapi/other/deletepaymentbyid.md Deletes a payment by its ID. Only pending payments can be deleted. This operation cannot be undone. ```APIDOC ## DELETE /v3/payments/{id} ### Description Deletes a payment by its ID. Only pending payments can be deleted. This operation cannot be undone. ### Method DELETE ### Endpoint /v3/payments/{id} ### Parameters #### Path Parameters - **id** (string) - Required - Identificador del pago ### Response #### Success Response (200) - **message** (string) - Required - Mensaje a desplegar al usuario. Example: "Message." ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.