/
BR
breeze
/
Breeze API
Search skmtc…
⌘K
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Checked 1mo ago · Updated 1mo ago
Details
Filter operations
Customers
5
get
Get a customer by query
post
Create a customer
get
Get a customer by ID
post
Update a customer
post
Offboard a customer
Direct Payment
5
post
Create a payment
get
Get a payment
post
Resume payment after merchant 3DS
get
List a customer's saved payment methods
delete
Remove a customer's saved payment method
Disputes
1
get
List disputes
Entitlements
1
get
List entitlements
Fraud Reports
2
get
List fraud reports
get
Get a fraud report by ID
Headless KYC
4
get
Get a KYC request by customer reference ID
post
Submit KYC for a customer (via image URL)
get
Get a KYC request by ID
post
Submit KYC for a customer (via image upload)
Headless Payout
1
post
Create a headless payout
Invoices
1
get
Get an invoice by ID
Liquidation Addresses
5
get
List liquidation addresses
post
Create a liquidation address
get
Get a liquidation address by ID
get
List liquidation address transactions
get
Get a liquidation address transaction by ID
Offramp
4
post
Create an offramp request
get
Get an offramp request by ID
post
Cancel an offramp request
post
Release an offramp request
Payment Pages
7
get
List payment pages
post
Create a payment page
get
Get a payment page by ID
post
Expire a payment page
post
Initiate a refund
get
Get a refund by ID
get
Get all payment attempts for a specific page ID
Payout Pages
6
get
List payout pages
post
Create a payout page
get
Get a payout page by ID
post
Release a payout page
post
Cancel a payout page
post
Sandbox confirm a payout page
Products
4
get
List products
post
Create a product
get
Get a product by ID
post
Create a price for a product
Risk
1
get
Get the current risk status for a customer email
Statements
2
get
List statements
get
Download a statement
Subscriptions
5
get
List subscriptions
post
Create a subscription
get
Get a subscription by ID
post
Cancel a subscription
get
Get a subscription by client reference ID
Tax
1
get
Get tax rate for merchant
Webhooks
Webhooks
3
post
Payment succeeded
post
Payout page status update
post
Refund status update
Customers
Get a customer by query
Retrieves a customer by reference ID or email.
get
/v1/customers
Query parameters
referenceId
string
email
string
email
Response
Success
object
required
The matching customer
status
'SUCCEEDED'
required
data
GetCustomerByQueryResponse
required
Changes