Raffle System
  1. order
Raffle System
  • Raffles
    • authentication
      • admin login
      • user login
    • awarded-boxes
      • getAll
      • open awarded box
      • create
      • getAll by raffleId
      • delete
    • awarded-boxes-combo
      • create
      • getAll by raffleId
      • update
      • delete
    • tracking
      • get tracking info
    • pay2m-api
      • access token generation
      • generate billing qr code
      • consult qr code
      • list webhook
      • register/update webhook
      • delete webhook
    • provider-api
      • auth login
      • create pix static
      • get webhooks
      • create webhook
      • get balance
      • get extracts
      • edit webhook
      • delete webhook
      • get webhook details
      • restore webhook
    • winner
      • get quota prize winners
    • general
      • update settings
      • get settings
      • create notifications
      • get notifications
      • get notification by id
      • update notification
      • delete notification
      • create faq
      • get faqs
      • get faq by id
      • update faq
      • delete faq
    • metrics
      • get sales by day for raffle
      • get top buyers by raffle
      • get general metrics
      • get last orders
      • get raffle percentage of sales
      • get orders summary
      • get badges
      • get sell bar
      • get fake sold quotas percentage
      • create fake sold quotas percentage
      • update fake sold quotas percentage
    • payments
      • get payment providers
      • create/update payment provider
      • get payment provider by name
      • get pix payments
      • get my pix payments
      • get pix payment details
    • order
      • create order withou payment method
        POST
      • create order
        POST
      • get orders
        GET
      • get orders by raffle id
        GET
      • get my orders
        GET
      • get order details
        GET
      • pay order
        PATCH
      • cancel order
        PATCH
    • lucky-numbers
      • get lucky numbers by raffleId
      • get lucky numbers by orderId
    • raffle
      • toggle awarded boxes visualization
      • toggle awarded boxes winners visualization
      • toggle acumulative combo
      • update category
      • delete category
      • create raffle category
      • get categories
      • create raffle
      • get raffles
      • get raffle details
      • delete raffle
      • update raffle
      • get winners
      • get winner details
      • get winner info
      • create winner
      • upload file
    • user
      • create user
      • get users
      • update user
      • get user details
      • delete user
      • get user by phone
      • get profile
      • create customer
      • update customer
  1. order

create order withou payment method

POST
/v1/orders/without-payment-gateway
order
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/v1/orders/without-payment-gateway' \
--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 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
id
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
Previous
get pix payment details
Next
create order
Built with