Skip to main content
POST
This endpoint is deprecated. Use POST /api/v2/payin for all new integrations. PayIn v2 supports checkout, direct, and hybrid payment experiences without separate backoffice configuration.
Initialize a PayIn transaction using the legacy v1 API. This version always returns a hosted payment_url for the customer to complete payment. Direct and hybrid flows (PSE without redirect, EFECTY instructions, BREB keys, etc.) are available only in PayIn v2.

Migration to v2

See PayIn API (v2) and Colombia PayIn for method-specific v2 examples.

Required Headers

string
required
Your merchant authentication token
string
required
Basic authentication key
string
required
Must be application/json

Request Body Parameters

string
required
Your unique transaction reference
number
required
Transaction amount in the specified currency.
string
required
Three-letter currency code (ISO 4217), e.g. COP, PEN, MXN.
string
required
Two-letter country code (ISO 3166-1 alpha-2), e.g. CO, PE, MX.
string
required
Payment method. See Country-Specific Information.
string
required
Transaction description or purpose.
object
required
Customer identification and contact details (legal_doc, legal_doc_type, phone_code, phone_number, email, full_name).
integer
Payment link expiration time in minutes
string
required
URL for receiving webhook notifications
string
required
URL to redirect after payment completion

Response

string
Unique transaction identifier
string
Hosted checkout URL to redirect the customer
object
Echo of request metadata (reference, amount, currency, payment_method, urls)

Authorizations

Token-Top
string
header
required
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json
reference
string
required
amount
number
required
currency
string
required
Example:

"COP"

country
string
required
Example:

"CO"

payment_method
string
required
description
string
required
customer_data
object
required
ipn_url
string<uri>
required
redirect_url
string<uri>
required
expiration_time
integer

Response

Transaction created

code
string
status
string
message
string
data
object