Contract overview
Choose the contract for the direction of your integration.
Platform calls, embedded Shopify app operations, provider ingress and outbound merchant events are distinct surfaces. Begin with the one your system actually uses rather than assuming a single credential applies to all four.
Merchant and platform operations
Versioned API resources under https://api.rebatecardx.com/api/v1, including the three current API-key operations.
Embedded app operations
Shopify Admin session-token and signed app-event routes used by the public embedded app.
Download Shopify OpenAPIProvider-to-platform delivery
Signed approved-provider and commerce-provider ingress on hooks.rebatecardx.com.
Platform-to-merchant events
Tenant lifecycle events delivered to an approved public HTTPS endpoint. This is separate from provider ingress.
Read the outbound webhook guideAuthentication boundaries
Most Core operations are first-party session routes.
The public OpenAPI document covers the full platform contract, not only third-party API-key operations. A developer key cannot call a route marked session-cookie.
| Boundary | Operations | Intended caller |
|---|---|---|
| Public | 13 | Unauthenticated discovery and explicitly public resource flows. |
| API key | 3 | Approved server-to-server merchant integrations. |
| Session cookie | 174 | First-party merchant, cardholder and administration portals. |
Public documentation does not create a credential or authorize a tenant. Contact us to request developer access.
Current API-key surface
Three server-to-server writes use orders:write.
| Method | Path | Purpose |
|---|---|---|
| POST | /orders | Ingest an order |
| POST | /orders/{id}/refunds | Record an order refund |
| POST | /orders/{id}/returns | Record an order return |
Each operation requires Authorization: Bearer <RBX_API_KEY>, Content-Type: application/json and an Idempotency-Key. Request schemas for the order, refund and return bodies are explicit in OpenAPI.
Core conventions
Read the operation together with its platform mechanics.
JSON and explicit schemas
Amounts use integer USD cents, timestamps use UTC and identifiers are opaque.
Response envelopesIdempotent mutations
Documented mutations retain a completed result and reject key reuse with a changed payload.
Idempotency rulesOptimistic concurrency
Versioned resources use ETag and If-Match to prevent stale writes.
Stable error codes
Use the error code for program logic and retain the request ID for diagnostics.
Error referenceGenerated operation index
190 Core operations across 19 domains.
Paths are relative to the versioned server URL. Expand a group to find its methods, paths, purpose and authentication mode. Use the corresponding OpenAPI schema for the request and response fields; a summary is not a substitute for the schema.
Admin65 operations
Invite an internal administrator
Session
List internal administrators
Session
List access reviews
Session
List append-only audit events
Session
Read one append-only audit event with technical identifiers
Session
List campaign approvals
Session
Decide a campaign approval
Session
List masked cards
Session
Read the operations dashboard
Session
List disputes
Session
Download dispute evidence
Session
Update a dispute
Session
List dispute evidence
Session
List dead-letter entries
Session
Read dead-letter recovery eligibility
Session
Resolve a terminal global issuing recovery dead letter
Session
Retry controlled global issuing work from retained encrypted payload
Session
List transactional-email delivery attempts
Session
Resolve an uncertain transactional-email attempt
Session
Retry a confirmed failed transactional email
Session
List transactional-email dead letters
Session
List Cloudflare Email lifecycle events
Session
Read transactional-email lifecycle readiness
Session
List blocked transactional-email recipients
Session
Clear a transactional-email recipient suppression
Session
List funding activity
Session
Reconcile an unlinked issuing return
Session
List eligible reconciliation source transactions
Session
List provider-managed identity verifications
Session
Read a provider-managed identity verification
Session
Reconcile identity verification state with the provider
Session
Retry failed identity processing
Session
List legacy KYC history
Session
List ledger projections
Session
List merchant reviews
Session
Read a merchant review and KYB profile
Session
Recommend or decide a merchant review
Session
Claim a queued merchant review
Session
List merchant review documents
Session
List merchant review audit history
Session
Decide a merchant review document
Session
Download a merchant review document
Session
List merchants
Session
Switch the merchant issuing environment
Session
List masked recipients
Session
List reconciliation runs
Session
List internal reports
Session
Request an internal report
Session
Download an internal report
Session
List risk cases
Session
Update a risk case
Session
List settlements
Session
List Shopify App Event billing delivery state
Session
Retry an exhausted Shopify App Event with its permanent idempotency key
Session
Record an audited write-off for an exhausted Shopify App Event
Session
List Shopify webhook delivery and installation-generation state
Session
Retry a failed retained Shopify webhook delivery
Session
List support tickets
Session
Update a support ticket
Session
List support ticket replies
Session
Read system configuration status
Session
List transactions
Session
Read personal administrator interface settings
Session
Update personal administrator interface settings
Session
List webhook deliveries
Session
Authentication10 operations
Request a password reset code
Public
Complete a password reset
Public
Read the current session
Session
Start a standalone session or step-up challenge
Public
End the current session
Session
Verify a sign-in step-up challenge
Public
Verify a merchant email challenge
Public
Resend a merchant email challenge
Public
Exchange a private email link and card_access Turnstile proof for a 15-minute program-scoped session
Public
Replace an expired 30-day email link by sending a new link only to its original recipient
Public
Awards6 operations
List awards
Session
Read an award
Session
Complete prepaid cardholder contact
Session
Queue an award claim email
Session
Evaluate an order for an award
Session
List masked recipients
Session
Campaigns8 operations
List campaigns
Session
Create a campaign
Session
Read a campaign
Session
Update a campaign
Session
Record a campaign approval
Session
Submit a campaign for approval
Session
List campaign versions
Session
Read public campaign terms
Public
Cardholder18 operations
List cardholder cards
Session
Request permanent card closure
Session
Create an issuing-provider card session or exchange a Marqeta UX Toolkit DPoP proof after step-up
Session
List cardholder disputes
Session
Open a cardholder dispute
Session
Download cardholder dispute evidence
Session
List cardholder dispute evidence
Session
Attach cardholder dispute evidence
Session
Read cardholder privacy choices
Session
Update cardholder privacy choices
Session
Read the cardholder profile
Session
Update the cardholder profile
Session
List cardholder support tickets
Session
Create a cardholder support ticket
Session
List cardholder ticket replies
Session
Reply to a cardholder ticket
Session
List cardholder transactions
Session
Read cards, award buckets and transactions only for the email-authorized issuing program
Session
Cards3 operations
Issue an approved award card
Session
List masked cards
Session
List transactions
Session
Developer7 operations
List API keys
Session
Create an API key
Session
Revoke an API key
Session
List webhook endpoints
Session
Create a webhook endpoint
Session
Update a webhook endpoint
Session
List webhook deliveries
Session
Disputes5 operations
List disputes
Session
Open a dispute
Session
Download dispute evidence
Session
List dispute evidence
Session
Attach dispute evidence
Session
Funding5 operations
List funding requests
Session
Create a funding request for an enrolled issuing program
Session
List funding sources
Session
Create a funding source for an enrolled issuing program
Session
Read projected ledger balances
Session
Integrations2 operations
List commerce integrations
Session
Create a commerce integration
Session
Issuing Companies29 operations
List global cardholder program accounts
Session
List issuing-provider book-transfer operations
Session
List merchant-isolated award funding buckets
Session
List global cards, authorization readiness, and transition ownership
Session
Reconcile an abandoned automatic card transition or permanent closure with operator evidence
Session
List global program merchant enrollments
Session
Enroll a merchant in the active global issuing program
Session
Change enrollment state or priority for new eligible awards
Session
Block a merchant and recover its available awards
Session
List global issuing programs
Session
Create a draft global issuing program
Session
Read one global issuing program
Session
Approve, activate, reconfigure, or disable a global issuing program
Session
Verify exact issuing-provider program resources
Session
Read global issuing readiness and operational totals
Session
List global card transactions and merchant allocations
Session
List issuing-provider event subscriptions
Session
Store encrypted issuing-provider webhook authentication
Session
Rotate or disable issuing-provider webhook authentication
Session
List issuing companies and environment connections
Session
Add an issuing company to the adapter catalog
Session
Update issuing-company identity and methodology metadata
Session
Configure an issuing-company environment
Session
Update an issuing-company environment
Session
Replace write-only issuing-company environment credentials
Session
Verify issuing-company credentials and activate the environment
Session
List issuing-company program assignments
Session
Request an issuing-company program assignment
Session
Approve, reconfigure, or disable an issuing-company program assignment
Session
KYB7 operations
Read compliance status
Session
Read the KYB application
Session
Save the KYB application
Session
List KYB documents
Session
Upload a KYB document
Session
Download a KYB document
Session
Submit the KYB application
Session
Merchant5 operations
Read the merchant dashboard
Session
Read the merchant profile and operational issuing programs
Session
Update the merchant profile
Session
Read tenant settings
Session
Update tenant settings
Session
Orders5 operations
List orders
Session
Ingest an order
API key
Read an order
Session
Record an order refund
API key
Record an order return
API key
Reports3 operations
List reports
Session
Request a report export
Session
Download a report export
Session
Risk1 operation
List merchant risk cases
Session
Support4 operations
List support tickets
Session
Create a support ticket
Session
List ticket replies
Session
Reply to a support ticket
Session
System4 operations
Discover the API contract and developer resources
Public
Read API health
Public
Read this OpenAPI document
Public
Read dependency status
Public
Team3 operations
List tenant members
Session
Invite a tenant member
Session
Update a tenant member
Session
Support boundary
Report a request without exposing a secret.
Provide the environment, HTTP method, path, timestamp, error code and request ID. You may include your own non-sensitive source identifier. Never send the bearer key, signing secret, raw card data or an unredacted customer payload.