Get payment by Id

This method obtains the complete payment information. Includes the current status of the payment.

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

Payment identifier

Responses
200

Successful operation. Returns a JSON object with the payment information.

Response Schema: application/json
payment_id
required
string

Unique identifier of the payment, it is a 12-character alphanumeric string. Because this identifier is unique, it can be used, for example, to avoid processing a repeated notification. (Khipu waits for a code 200 when notifying a payment, if this does not occur it retries for up to two days).

Example: "gqzdy6chjne9"
payment_url
required
string

Main payment URL, if the user has not previously chosen a payment method, the options are shown.

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

Simplified payment URL.

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

Normal payment URL.

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

URL to invoke payment from a mobile device using the Khipu APP.

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

It is true if the payment already has all the necessary data to directly open the Khipu payment application.

Example: false
notification_token
required
string

String of alphanumeric characters that uniquely identify the payment, it is the identifier that the Khipu server will send to the merchant server when notifying that a payment is reconciled.

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

Unique identifier of a collection account.

Example: 985101
conciliation_date
required
string <date-time>

Date and time of payment reconciliation. ISO-8601 format.

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

Text to summarize the charge.

Example: "Test"
amount
required
number <double>

The amount of the charge.

Example: 1000
currency
required
string

The currency code in ISO-4217 format.

Example: "CLP"
status
required
string

Payment status, it can be pending (the payer has not yet started paying), verifying (the payment is being verified) or done, when the payment is already confirmed.

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

Detail of the payment status: pending (the payer has not yet started paying), normal (the payment was verified and was canceled by some standard payment method), marked-paid-by-receiver (the merchant marked the charge as paid), rejected-by-payer (the payer declared that they will not pay), marked-as-abuse (the payer declared that they will not pay and that the charge was unsolicited), and reversed (the payment was canceled by the merchant, the money was returned to the payer).

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

Payment details.

Example: "Test"
picture_url
required
string

URL with image of the payment.

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

URL of the payment receipt.

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

URL where the payer is redirected after the payment is completed.

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

URL where the payer is redirected after they give up making the payment.

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

URL of the webservice where the payment will be notified.

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

Notification API version.

Example: "3.0"
expires_date
required
string <date-time>

Maximum date to execute the payment (in ISO-8601 format). The client may make several payment attempts until said date. Each attempt has an individual period of 3 hours for its execution.

Example: "2023-12-31T15:45:00-04:00"
attachment_urls
required
Array of strings >= 0 items

Array of URLs of files attached to the payment.

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

Name of the bank selected by the payer.

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

Identifier of the bank selected by the payer.

Example: "dfFbF"
payer_name
required
string

Payer's name.

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

Payer email.

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

Personal identifier of the payer.

Example: "11.000.111-9"
bank_account_number
required
string

Payer's bank account number.

Example: "001120490689"
out_of_date_conciliation
required
boolean

It is true if the payment reconciliation was made after the expiration date.

Example: true
transaction_id
required
string

Payment identifier assigned by the merchant.

Example: "zwo3wqz6uulcvajt"
custom
required
string

Generic field assigned by the merchant at the time of making the payment.

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

Email of the person responsible for the payment.

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

It is true when this is an email collection and Khipu will send reminders.

Example: true
send_email
required
boolean

It is true when Khipu will send the payment by email.

Example: true
payment_method
required
string

Payment method used by the payer, it can be regular_transfer or simplified_transfer.

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

Source of funds used by the payer, it can be debit for payment with debit, prepaid for payment with prepaid, credit for payment with credit, or empty in case it has been paid by bank transfer.

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

Amount to be deducted from the value paid.

Example: 0
third_party_authorization_details
string

Disregard this field.

400

Bad request

401

Unauthorized - Invalid or missing credentials

403

Forbidden

404

Not found - Resource not available

500

Internal server error

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