Create PayIn

Create a new PayIn and generate a payment link. Supports multiple payment methods:

  • PSE (Pagos Seguros en Línea) for Colombia (COP)
    • Unique PayIns: Each PayIn is for a single transaction with a specific amount
    • Requires amount field
    • Requires bank_code field
  • SPEI for Mexico (MXN)
    • Reusable PayIns: The same PayIn can be used multiple times for different amounts
    • Does NOT require amount field (user specifies amount when paying)
    • Does NOT require bank_code field

User information (document_type_id, document_number, full_names, email) is obtained from the user record via user_id.

Authentication: Both x-api-key header and Authorization: Bearer <token> header are required.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Payload to create a payin. Structure varies by payment type (PSE, SPEI).

uuid
required

User identification - User fields will be fetched from this user

string

Amount for the payin (decimal with up to 2 decimal places). Required for PSE (unique PayIns with specific amount). Not required for SPEI (reusable PayIns where user specifies amount when paying).

string
enum
required

Currency code - COP for PSE, MXN for SPEI

Allowed:
string
enum
required

PayIn type - PSE for Colombia, SPEI for Mexico

Allowed:
string

Bank code - Required for PSE (Colombia), Not required for SPEI (Mexico). Use GET /v1/countries to get the list of available banks and their codes.

string
length ≤ 255

Optional subject/description for the payment

uri
required

Required callback URL for redirects after payment

settlement
object
required

Settlement configuration - defines where funds are settled.
For individual recipients, provide first_name and last_name. For business recipients, provide company_name.

Headers
string
required

API key for authentication

uuid
required

Idempotency key (must be a valid UUID)

Responses

401

Unauthorized

422

Validation Error

500

Internal Server Error

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json