Skip to main content
POST
Process a PIX payment

Authorizations

X-API-Key
string
header
required

Company API key. Send in the X-API-Key header.

Headers

x-client-id
string
required

Client identifier for the company in the request.

Example:

"client_abc123"

Body

application/json
merchant_order_id
string
required
Example:

"ORD-2026-12345"

amount
integer
required

Amount in cents

Example:

15000

currency
string
required
Example:

"BRL"

customer
object
required
gateway_first_try
string | null

Gateway slug to attempt first. Falls back to routing rules if not set.

Example:

"pagarme"

expires_in
integer | null

Seconds until PIX expires (min 60)

Example:

3600

splits
object[] | null

Optional split rules. Each entry directs a portion of the amount to a sub-account.

Response

PIX order created

status
string
Example:

"pending"

transaction_id
string
Example:

"01hvxyz..."

amount
integer
Example:

15000

message
string
Example:

"PIX generated successfully."

payment_method
string
Example:

"pix"

merchant_order_id
string | null
Example:

"ORD-2026-12345"

idempotency_key
string | null
plugtopay_request_time
string | null
Example:

"0.05s"

total_request_time
string | null
Example:

"0.8s"

gateways_request_time
string | null
Example:

"0.75s"

created_at
string<date-time> | null
updated_at
string<date-time> | null
transactions
object[]
customer
object | null
webhook
object | null
pix
object | null