Skip to main content
POST
This is the recommended PayIn endpoint. The legacy v1 endpoint (POST /api/v1/payin) is deprecated.
Initialize a PayIn transaction using API v2 (POST /api/v2/payin). The response includes payment_url, payment_information, or both depending on the payment method and request fields. See PayIn API and Colombia PayIn for method-specific examples (e.g. PSE checkout vs direct).

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): COP, PEN, MXN, GTQ, or HNL.
string
required
Two-letter country code (ISO 3166-1 alpha-2): CO, PE, MX, GT, or HN. Must match the merchant country and currency.
string
required
Payment method. See Country-Specific Information for available payment methods.
string
required
Transaction description or purpose.
object
required
integer
Payment link expiration time in minutes
string
URL for receiving webhook notifications
string
URL to redirect after payment completion

Response

string
Unique transaction identifier (TumiPay ticket)
string
Transaction creation timestamp
string
Hosted checkout URL when the method uses Checkout or Hybrid mode
object
Provider payment data when the method uses Direct or Hybrid mode
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
enum<string>
required

ISO 3166-1 alpha-2 country code

Available options:
CO,
PE,
MX,
GT,
HN
Example:

"CO"

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

Response

Transaction created

code
string
status
string
message
string
data
object