Create a invioce order

POST

/create

Determine order creation success based on HTTP status codes:
200: Returns existing order information
201: Creation successful
400: Parameter error
401: Account or IP unavailable
500: Server status error
503: Server status error
See error codes for details
**When creating a new order, the successful HTTP status code is 201.
When mchOrderNo already exists, the HTTP status code will be 200. In both cases, order information will be returned.

Request

Header Params

Body Params application/json

Example

{
    "mchOrderNo": "string",
    "amount": 0,
    "notifyUrl": "string",
    "name": "string",
    "phone": "string",
    "email": "string",
    "subject": "string",
    "body": "string",
    "successUrl": "string",
    "accountType": 0,
    "extra": {
        "appName": "string",
        "description": "string"
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location '/create' \
--header 'X-Account: b5373276-3924-4fbb-8845-acd15e910543' \
--header 'X-Signature;' \
--header 'Content-Type: application/json' \
--data '{
    "mchOrderNo": "string",
    "amount": 0,
    "notifyUrl": "string",
    "name": "string",
    "phone": "string",
    "email": "string",
    "subject": "string",
    "body": "string",
    "successUrl": "string",
    "accountType": 0,
    "extra": {
        "appName": "string",
        "description": "string"
    }
}'

Responses

🟢200成功

application/json

Bodyapplication/json

Example

{
    "orderNo": "PRV22024022404251971044557674252",
    "mchOrderNo": "TEST20240224122518275969617",
    "orderAmount": 2000,
    "amount": 1992,
    "fee": 8,
    "reference": "00020101021226900014br.gov.bcb.pix2568pix.sicoob.com.br/qr/payload/v2/33f69fa0-ba58-4fd7-85cf-5d57489bd2e95204000053039865802BR5919BRUNO DE SOUZA REGO6013Nao_informado62070503***63043945",
    "status": 2,
    "url": "https://pix.potawallet.com?param=uznHf4cH1wJ-0uxs6ppvnOn9rGAUpvzHnr9EJU5IoEQpwApX3kyXzaDFNfn6L_Ne",
    "expiresAt": 1708921080,
    "createdAt": 1708748719
}

Modified at 2026-02-10 13:24:01

Voucher Inquiry

Create a payment order