pix_create_payment
Creates a PIX payment for Brazilian customers. Returns a payment URL and a QR code value. Customer must have a CPF number (Brazilian tax ID).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| amount | Yes | Payment amount in BRL (e.g. 50.00). | |
| pix_key | Yes | ifthenpay PIX key. | |
| order_id | Yes | Unique order identifier in your system (max 25 characters). | |
| description | No | Short description or reference for the payment (max 200 characters). | |
| customer_cpf | Yes | Customer CPF number (Brazilian tax ID), digits only (e.g. 74026594025). | |
| redirect_url | Yes | URL to redirect the customer after payment. Check payment status via the status API after redirect. | |
| customer_city | No | Customer city. | |
| customer_name | Yes | Full name of the customer (max 150 characters). | |
| customer_email | Yes | Customer email address. | |
| customer_phone | Yes | Customer phone number including country code (e.g. +5585912345678). | |
| customer_state | No | Customer state (e.g. CE, SP). | |
| customer_address | No | Customer street address. | |
| customer_zip_code | No | Customer postal/ZIP code. |