--- updatedAt: 2025-06-12T21:08:20.000Z agentTools: projectIndex: https://docs.beeteller.com/llms.txt --- # Pix # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "merchant-api-v30", "version": "3.0-latam" }, "servers": [ { "url": "https://api-test.beeteller.com/gtw/3.0" } ], "security": [ {} ], "paths": { "/payment/#pix": { "post": { "summary": "Pix", "description": "", "operationId": "create-pix-order", "parameters": [ { "name": "Authorization", "in": "header", "description": "Your token generated in authentication step. Using Bearer prefix", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "value", "currency", "type", "payer" ], "properties": { "value": { "type": "number", "description": "The gross amount you will receive after the customer pays the order", "default": 150, "format": "float" }, "currency": { "type": "string", "description": "The currency from the value field. If \"USD\" is used as currency, the \"currencyTo\" field will be required.", "default": "BRL", "enum": [ "BRL", "USD" ] }, "type": { "type": "string", "description": "Payment method", "default": "PIX", "enum": [ "PIX" ] }, "payer": { "type": "object", "description": "Customer's data from the one who will pay the order", "required": [ "name", "documentType", "documentNumber", "email" ], "properties": { "name": { "type": "string", "description": "Customer's full name", "default": "Jose Silva" }, "documentType": { "type": "string", "description": "Customer's document type", "default": "CPF", "enum": [ "CPF", "CNPJ" ] }, "documentNumber": { "type": "string", "description": "The customer's document number. It must match with document type and be a valid one, otherwise the order creation will be rejected.", "default": "83825321282" }, "email": { "type": "string", "description": "Customer's valid email", "default": "jose@beeteller.com" } } }, "merchantReference": { "type": "string", "description": "With up to 64 characters, this field is optional and allows you to provide an internal reference of your own.", "default": "ABC12356789" }, "urlWebhook": { "type": "string", "description": "Optional URL which we'll use to send you a callback for created order" }, "successUrl": { "type": "string", "description": "URL to redirect your customer after he finished the order." }, "cancelUrl": { "type": "string", "description": "URL to redirect your customer after he cancels the order." }, "checkoutName": { "type": "string", "description": "Custom name of your company that your customer will see on our checkout page." }, "currencyTo": { "type": "string", "description": "The currency your customer will use to pay the order. It's required only if the currency is \"USD\"", "default": "BRL", "enum": [ "BRL" ] } } } } } }, "responses": { "201": { "description": "201", "content": { "application/json": { "examples": { "created order": { "value": { "id": "8ab36228-9870-49d6-99e0-eb24cf554962", "currency": "BRL", "value": 100, "paidValue": 0, "feeValue": 1, "netValue": 99, "type": "PIX", "payer": { "name": "Payer Name", "email": "payer@beeteeller.com" }, "merchantReference": "MyReference#4931283", "currencyTo": "BRL", "checkoutName": "Merchant Name", "status": "PENDING", "createdAt": "2023-08-16T21:43:49.218854-03:00", "paidAt": null, "cancellationReason": "", "payment": { "url": "https://checkout-sandbox.beeteller.com/pix/8ab36228-9870-49d6-99e0-eb24cf554962" }, "submissionUrl": "https://checkout-sandbox.beeteller.com/doc-submission/0ded1789-8929-45f2-b85a-7aadd2405b95" } } }, "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8ab36228-9870-49d6-99e0-eb24cf554962" }, "currency": { "type": "string", "example": "BRL" }, "value": { "type": "integer", "example": 100, "default": 0 }, "paidValue": { "type": "integer", "example": 0, "default": 0 }, "feeValue": { "type": "integer", "example": 1, "default": 0 }, "netValue": { "type": "integer", "example": 99, "default": 0 }, "type": { "type": "string", "example": "PIX" }, "payer": { "type": "object", "properties": { "name": { "type": "string", "example": "Payer Name" }, "email": { "type": "string", "example": "payer@beeteeller.com" } } }, "merchantReference": { "type": "string", "example": "MyReference#4931283" }, "currencyTo": { "type": "string", "example": "BRL" }, "checkoutName": { "type": "string", "example": "Merchant Name" }, "status": { "type": "string", "example": "PENDING" }, "createdAt": { "type": "string", "example": "2023-08-16T21:43:49.218854-03:00" }, "paidAt": {}, "cancellationReason": { "type": "string", "example": "" }, "payment": { "type": "object", "properties": { "url": { "type": "string", "example": "https://checkout-sandbox.beeteller.com/pix/8ab36228-9870-49d6-99e0-eb24cf554962" } } } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Missing required fields": { "value": "{\n \"errors\": {\n \"value\": \"Required field.\",\n \"currency\": \"Required field.\",\n \"type\": \"Required field.\",\n \"documentType\": \"Required field.\",\n \"documentNumber\": \"Required field.\",\n \"email\": \"Required field.\",\n \"name\": \"Required field.\"\n }\n}" }, "Invalid fields": { "value": "{\n \"errors\": {\n \"value\": \"The value must be a valid number and higher than zero\",\n \"currency\": \"Invalid currency\",\n \"type\": \"The only possible values are BANK_SLIP, TRANSFER, PICPAY, PIX, TED, CASH and EFT\",\n \"merchantReference\": \"The max length is 64 characters\",\n \"urlWebhook\": \"Invalid URL content\",\n \"successUrl\": \"Invalid URL content\",\n \"email\": \"Invalid e-mail.\",\n \"documentNumber\": \"Invalid document number\",\n \"documentType\": \"Invalid document type\"\n }\n}" }, "Payment method not allowed": { "value": "{\n \"errors\": {\n \"type\": \"Invalid payment type or not allowed in the country\"\n }\n}" } }, "schema": { "oneOf": [ { "title": "Missing required fields", "type": "object", "properties": { "errors": { "type": "object", "properties": { "value": { "type": "string", "example": "Required field." }, "currency": { "type": "string", "example": "Required field." }, "type": { "type": "string", "example": "Required field." }, "documentType": { "type": "string", "example": "Required field." }, "documentNumber": { "type": "string", "example": "Required field." }, "email": { "type": "string", "example": "Required field." }, "name": { "type": "string", "example": "Required field." } } } } }, { "title": "Invalid fields", "type": "object", "properties": { "errors": { "type": "object", "properties": { "value": { "type": "string", "example": "The value must be a valid number and higher than zero" }, "currency": { "type": "string", "example": "Invalid currency" }, "type": { "type": "string", "example": "The only possible values are BANK_SLIP, TRANSFER, PICPAY, PIX, TED, CASH and EFT" }, "merchantReference": { "type": "string", "example": "The max length is 64 characters" }, "urlWebhook": { "type": "string", "example": "Invalid URL content" }, "successUrl": { "type": "string", "example": "Invalid URL content" }, "email": { "type": "string", "example": "Invalid e-mail." }, "documentNumber": { "type": "string", "example": "Invalid document number" }, "documentType": { "type": "string", "example": "Invalid document type" } } } } }, { "title": "Payment method not allowed", "type": "object", "properties": { "errors": { "type": "object", "properties": { "type": { "type": "string", "example": "Invalid payment type or not allowed in the country" } } } } } ] } } } }, "403": { "description": "403", "content": { "application/json": { "examples": { "Forbidden": { "value": "{\n \"detail\": \"Você não tem permissão para executar essa ação.\"\n}" } }, "schema": { "type": "object", "properties": { "detail": { "type": "string", "example": "Você não tem permissão para executar essa ação." } } } } } } }, "deprecated": false } } }, "x-readme": { "headers": [], "explorer-enabled": true, "proxy-enabled": true }, "x-readme-fauxas": true } ```