# Instant Payment API

The Khipu Instant Payment API (version 3.0) enables merchants to initiate, query, confirm, refund,  or delete real-time bank transfer payments. Key features include retrieving a list of available banks  with their limits, fees, and logos; creating payments by specifying a bank or letting users choose;  confirming or requesting a refund using the payment ID; and predicting a payment's status using machine  learning. Authentication is handled via a secret key in the x-api-key header, without requiring signatures,  and all communication is secured with extended validation SSL certificates.

Version: v3.0
License: Instant Payments API

## Servers

Production
```
https://payment-api.khipu.com
```

## Security

### Api-Key

Type: apiKey
In: header
Name: x-api-key

## Download OpenAPI description

[Instant Payment API](https://docs.khipu.com/_spec/@l10n/en/apis/v3/instant-payments/openapi.yaml)

## Other

### Get banks

 - [GET /v3/banks](https://docs.khipu.com/en/apis/v3/instant-payments/openapi/other/getbanks.md): This method obtains the list of banks that can be used to pay in this collection account.

### Confirm payment by Id

 - [POST /v3/payments/{id}/confirm](https://docs.khipu.com/en/apis/v3/instant-payments/openapi/other/postpaymentconfirmbyid.md): Warning: This feature is only available to customers who have contracted it independently.
To use it, please contact us at soporte@khipu.com
Confirm payment. Upon confirming payment, the funds will be delivered
to the merchant the next business day.


### Get payment by Id

 - [GET /v3/payments/{id}](https://docs.khipu.com/en/apis/v3/instant-payments/openapi/other/getpaymentbyid.md): This method obtains the complete payment information. Includes the current status of the payment.

### Delete payment by Id

 - [DELETE /v3/payments/{id}](https://docs.khipu.com/en/apis/v3/instant-payments/openapi/other/deletepaymentbyid.md): Delete a payment. Only applicable to payments with status .

### Create payment

 - [POST /v3/payments](https://docs.khipu.com/en/apis/v3/instant-payments/openapi/other/postpayment.md): Create a payment in Khipu and obtain the URLs to redirect the user to complete the payment.

### Refund payment by Id

 - [POST /v3/payments/{id}/refunds](https://docs.khipu.com/en/apis/v3/instant-payments/openapi/other/postpaymentrefundsbyid.md): Refunds all or part of the amount of a payment. This operation can only be carried out in businesses that collect in a Khipu account and before the corresponding funds are delivered.

### Get payment prediction

 - [GET /v3/predict](https://docs.khipu.com/en/apis/v3/instant-payments/openapi/other/getpredict.md): Prediction about the outcome of a payment, whether it will succeed or not. Additional information such as maximum possible transfer to a new recipient.

### Post receiver

 - [POST /v3/receivers](https://docs.khipu.com/en/apis/v3/instant-payments/openapi/other/postreceiver.md): Warning: This feature is only available to customers who have contracted it independently.
To use it, please contact us at soporte@khipu.com
Create a new collection account associated with an integrator.


### Get payment methods

 - [GET /v3/merchants/{id}/paymentMethods](https://docs.khipu.com/en/apis/v3/instant-payments/openapi/other/getmerchantpaymentmethodsbyid.md): Lists available payment methods for a given collection account.