PayIn API
POST Initiate PayIn (v1 — deprecated)
deprecated
Legacy PayIn endpoint. Always returns a hosted payment_url. Deprecated — use POST /api/v2/payin for new integrations.
POST
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/jsonRequest 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
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Body
application/json