/
BA
banqzinc
Search skmtc…
⌘K
Docs
Sign in
Docs
History
Schema
Generate
Retired
Filter operations
Account Information
10
Admin
13
Agreement
2
Auth
4
Bank Predictions
1
Banks
9
Branding
14
Command Palette
2
Countries
3
CrossBorder
5
Customer Bank Accounts
4
Customers
3
Dashboard
1
Default Rates
3
Embedded
8
Evidence
1
Go Live
2
Invoice
10
Legal
1
Legal Entities
11
Merchant Bank Account Payment Schemes
1
Merchant Bank Accounts
6
Merchant Documents
2
Merchant Invitations
4
Merchant Rates
3
Merchants
16
post
/api/v1/merchants/register
Self-service merchant registration for users with global:user role
get
/api/v1/merchants
Get all merchants
post
/api/v1/merchants
Create a new merchant
get
/api/v1/merchants/{id}
Get a merchant by ID
put
/api/v1/merchants/{id}
Update a merchant by ID
post
/api/v1/merchants/{id}/generate-secret
Generate a client secret for a merchant
post
/api/v1/merchants/{id}/revoke-secret
Revoke a client secret for a merchant
patch
/api/v1/merchants/{id}/activation-status
Update the activation status of a merchant
patch
/api/v1/merchants/{id}/mode
Update the mode of a merchant (live/sandbox)
patch
/api/v1/merchants/{id}/settings/multi-account
Update the multi-account allowed setting for a merchant
put
/api/v1/merchants/{id}/refund-retention-rate
Update the refund retention rate for a merchant
post
/api/v1/admin/dev/merchants/{merchantId}/promote-to-live
Dev-only: flip a sandbox merchant to live mode and re-flag every one of its payment_requests as live (test_transaction=false, provider_environment=live). Refused in production. Idempotent.
post
/api/v1/admin/dev/merchants/{merchantId}/revert-to-sandbox
Dev-only: revert a merchant back to sandbox mode and re-flag every one of its payment_requests as test. Refused in production. Idempotent.
post
/api/v1/admin/dev/merchants/{merchantId}/cross-border-enrollments/{provider}/reset
Dev-only: tear down the merchant's cross-border enrollment + every virtual account from a fake provider. Use after `/admin/reset` on the fake provider so core can re-enroll cleanly. Refused in production or if the provider is not registered as fake.
post
/api/v1/admin/dev/merchants/{merchantId}/refund-account/clear-activity
Dev-only: wipe all transactions on the merchant's fake-provider refund account and reset its balance to 0. Use for a clean demo slate without tearing down enrollment. Refused in production or for non-fake providers.
post
/api/v1/admin/dev/merchants/{merchantId}/refund-account/simulate-top-up
Dev-only: simulate an inbound wire onto the merchant refund account via the merchant's fake cross-border provider. Refused in production. Refused if the merchant is not enrolled with a fake provider, so it can never trigger a real TransferMate call.
Onboarding
3
Partner Invitations
4
Partners
6
Payment
1
Payment Links
6
Payment Schemes
1
Payments
8
Payout
6
Post-Processor Logs
2
Provider Configuration
4
Refund Resolution Links
4
Refunds
1
Seeds
2
Shareholder Documents
2
Shareholder Invitations
7
Shopify Orders
3
Transaction Updates (Token)
3
Transactions
14
User Invitations
2
Users
10
Webhook
3
Webhooks
5
Merchants
Copy
Copy Markdown
Copy Markdown
Copying…
Copied
Copy failed
Changes to Update the refund retention rate for a merchant
put
/api/v1/merchants/{id}/refund-retention-rate
Jun 17, 2026
b372e7d5563d
Revision changes
info
endpoint added
Nov 2, 2025
919eb7a392aa
Revision changes
breaking
api path removed without deprecation