API Reference

Complete reference of all Cashier API endpoints.

Base URL

https://cashier.flowpayment.net

Authentication

All API requests require authentication via API key:

X-API-Key: sk_live_your_api_key

Checkout Sessions

POST/api/v1/checkout

Create a new checkout session

GET/api/v1/checkout/{session_id}

Retrieve a checkout session

POST/api/v1/checkout/{session_id}/cancel

Cancel a checkout session

POST/api/v1/checkout/process

Process payment for a checkout session

Direct Payments

POST/cashier/cashier/payment

Create a direct payment (PIX or Card)

GET/cashier/cashier/status/{merchant_id}/{payment_id}

Get payment status

Webhooks

POST/api/v1/webhooks/sfpIncoming

SFP (PIX) webhook endpoint

POST/api/v1/webhooks/izipayIncoming

Izipay (Card) webhook endpoint

Response Codes

CodeStatusDescription
200OKRequest succeeded
201CreatedResource created successfully
400Bad RequestInvalid request parameters
401UnauthorizedInvalid or missing API key
403ForbiddenInsufficient permissions
404Not FoundResource not found
422UnprocessableValidation error or payment declined
500Server ErrorInternal server error

Payment Methods

PIX

PIX

Brazil instant payment

  • • Instant settlement
  • • Available 24/7
  • • QR code or copy-paste
  • • Provider: SFP
CC

Credit/Debit Card

Visa, Mastercard, etc.

  • • Installments support
  • • 3D Secure
  • • Major card brands
  • • Provider: Izipay

Payment Status Values

StatusDescriptionFinal?
pendingAwaiting customer actionNo
pending_3dsAwaiting 3D Secure verificationNo
processingBeing processed by providerNo
successPayment completedYes
failedPayment failedYes
cancelledCancelled by merchant/customerYes
expiredSession/payment expiredYes
refundedPayment refundedYes

Rate Limits

Endpoint TypeLimit
Create Payment100 requests/minute
Get Status300 requests/minute
Create Checkout100 requests/minute

Rate limits are per API key. Contact support if you need higher limits.