Raffle System

create order

POST

/v1/orders

order

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/v1/orders' \
--header 'Content-Type: application/json' \
--data-raw '{
    "raffleId": "a0b21c43-a1c3-455d-873e-65f5d69879d4",
    "userId": "f42312f3-3c11-42c4-a921-9583969fdb01",
    "quotaQuantity": 100,
    "paymentMethod": "PIX",
    "referral": "33d889cb-2cdc-4df2-a9f3-d4289fb52dc5",
    "buyerName": "Isabel Costa",
    "cpf": "25881911008",
    "paymentProviderName": "pay2m",
    "phone": "41998562314"
}'

Response Example

201 - Success

{
    "id": 26,
    "status": "PENDING",
    "paymentMethod": "PIX",
    "paymentProviderName": "pay2m",
    "referral": "33d889cb-2cdc-4df2-a9f3-d4289fb52dc5",
    "priceByQuota": "9.95",
    "quotaQuantity": 150,
    "totalValue": "1492",
    "createdAt": "2025-01-02T16:29:47.569Z",
    "qrCodeId": "F09D23261985855B6D841887F7C7EE8D71E",
    "qrCodeContent": "00020101021226860014br.gov.bcb.pix2564qrcode.fitbank.com.br/QR/cob/F09D23261985855B6D841887F7C7EE8D71E5204000053039865802BR5925PAY2M SOLUCOES FINANCEIRA6005Natal61085906439062070503***630485FC"
}

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

raffleId

integer

required

userId

integer

required

quotaQuantity

number

required

>= 1

paymentMethod

enum<string>

required

Allowed values:

PIXCREDIT_CARDBILLTRANSFERFREE

referral

string

optional

buyerName

string

required

cpf

string

required

>= 11 characters<= 11 characters

Match pattern:

^\d{11}$

paymentProviderName

enum<string>

required

Allowed values:

pay2mpagguefree campaign

Examples

Responses

🟢201Created

application/json

Body

integer

required

status

enum<string>

required

Allowed values:

PAIDPENDINGCANCELED

paymentMethod

enum<string>

required

Allowed values:

PIXCREDIT_CARDBILLTRANSFERFREE

paymentProviderName

enum<string>

required

Allowed values:

pay2mpagguefreeCampaign

referral

string | null

required

priceByQuota

string

required

quotaQuantity

integer

required

createdAt

string <date>

required

qrCodeId

string

required

qrCodeContent

string

required

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

create order withou payment method

get orders