Create Pay-in (Brazil PIX)

POST/v1/br/payinspayin:create

Create a PIX pay-in. You may send an optional Idempotency-Key header to safely retry the same request.

Request fields

Field	Type	Required	Description
`amount`	`string` (numeric)	Yes	Pay-in amount in BRL, 2 decimal places. 10.00–15000.00.
`paymentMethodCode`	`string`	Yes	`"PIX"` (default).
`returnUrl`	`string` (HTTPS URL)	Yes	Where the customer returns after payment. Forwarded to the provider.
`customer`	`object`	Yes	Customer info
`customer.name`	`string`	Yes	Customer name
`customer.email`	`string`	Yes	Customer email
`customer.phone`	`string`	Yes	Customer phone (e.g. `+5511999999999`)
`customer.deviceId`	`string`	Yes	Device id
`goodsInfo`	`object`	Yes	Product / order info
`goodsInfo.name`	`string`	Yes	Product or order name
`goodsInfo.id`	`string`	No	Product or order id
`goodsInfo.price`	`string`	No	Product price

Example

Request


{
  "amount": "100.00",
  "paymentMethodCode": "PIX",
  "returnUrl": "https://merchant.example.com/checkout/return",
  "customer": {
    "name": "Ana Souza",
    "email": "ana@example.com",
    "phone": "+5511999999999",
    "deviceId": "dev-123"
  },
  "goodsInfo": {
    "name": "Order #4821"
  }
}

cURL

curl -X POST https://api.transacty.ai/v1/br/payins \
  -H "X-Transacty-Key: $TRANSACTY_KEY" \
  -H "X-Transacty-Timestamp: $TS" \
  -H "X-Transacty-Signature: $SIG" \
  -H "Content-Type: application/json" \
  -d '{
  "amount": "100.00",
  "paymentMethodCode": "PIX",
  "returnUrl": "https://merchant.example.com/checkout/return",
  "customer": {
    "name": "Ana Souza",
    "email": "ana@example.com",
    "phone": "+5511999999999",
    "deviceId": "dev-123"
  },
  "goodsInfo": {
    "name": "Order #4821"
  }
}'

Response


{
  "transactionId": "f7c2f6d1-96df-4980-a514-7854726f52a0",
  "status": "pending",
  "amount": "100.00",
  "platformOrderId": "2026062907000000018",
  "paymentInfo": {
    "content": "00020126580014BR.GOV.BCB.PIX…",
    "type": "code",
    "expiredTime": "20260630172055"
  },
  "expiresAt": "2026-06-29T11:35:55.681Z",
  "currency": "BRL",
  "fees": {
    "platformFee": "2.00",
    "feeType": "payin",
    "feeStatus": "estimated"
  },
  "netAmount": "98.00",
  "totalWalletDebit": null
}

Response fields

Field	Type	Description
`transactionId`	`string`	Transaction identifier — use for status polling and support
`status`	`string`	Usually `pending` until the customer pays
`amount`	`string`	Requested pay-in amount in BRL
`currency`	`string`	`BRL`
`platformOrderId`	`string`	Provider-side order reference (support / escalation)
`paymentInfo`	`object`	What you show the payer
`paymentInfo.content`	`string`	PIX payload — copy-and-paste code, URL, HTML, or JSON depending on `type`
`paymentInfo.type`	`string`	`url`, `code`, `html`, or `json` — how to render `content`
`paymentInfo.expiredTime`	`string`	Provider-side expiry (often `YYYYMMDDHHmmss`)
`expiresAt`	`string` (ISO datetime)	When this pay-in session expires
`fees`	`object`	Transacty service fee for this pay-in
`fees.platformFee`	`string`	Fee amount charged for the service
`fees.feeType`	`string`	`payin`
`fees.feeStatus`	`string`	`estimated` at create; `applied` on success
`netAmount`	`string`	Estimated BRL credited after `platformFee`
`totalWalletDebit`	`string \| null`	`null` on pay-in create

Customer checkout: render paymentInfo according to type. For PIX, type: "code" means show the copy-and-paste string and/or generate a QR from it. Money is not credited until the pay-in confirms — treat pending as awaiting payment.