API v1 reference

Find the API operation and the access it requires.

Browse the operation index generated from the published OpenAPI contract, then review the schema and authentication mode for the call you need. Use the companion guides for request formatting, retries and signed events.

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.

Platform Core

Merchant and platform operations

Versioned API resources under https://api.rebatecardx.com/api/v1, including the three current API-key operations.

Download Platform OpenAPI
Shopify

Embedded app operations

Shopify Admin session-token and signed app-event routes used by the public embedded app.

Download Shopify OpenAPI
Webhook ingress

Provider-to-platform delivery

Signed approved-provider and commerce-provider ingress on hooks.rebatecardx.com.

Download ingress OpenAPI
Outbound webhooks

Platform-to-merchant events

Tenant lifecycle events delivered to an approved public HTTPS endpoint. This is separate from provider ingress.

Read the outbound webhook guide

Authentication 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.

BoundaryOperationsIntended caller
Public13Unauthenticated discovery and explicitly public resource flows.
API key3Approved server-to-server merchant integrations.
Session cookie174First-party merchant, cardholder and administration portals.
Developer access remains reviewed

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.

MethodPathPurpose
POST/ordersIngest an order
POST/orders/{id}/refundsRecord an order refund
POST/orders/{id}/returnsRecord 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.

Payloads

JSON and explicit schemas

Amounts use integer USD cents, timestamps use UTC and identifiers are opaque.

Response envelopes
Retries

Idempotent mutations

Documented mutations retain a completed result and reject key reuse with a changed payload.

Idempotency rules
Updates

Optimistic concurrency

Versioned resources use ETag and If-Match to prevent stale writes.

Concurrency guide
Failures

Stable error codes

Use the error code for program logic and retain the request ID for diagnostics.

Error reference

Generated 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
POST/admin/access/invitations

Invite an internal administrator

Session

GET/admin/access/members

List internal administrators

Session

GET/admin/access/reviews

List access reviews

Session

GET/admin/audit-events

List append-only audit events

Session

GET/admin/audit-events/{id}

Read one append-only audit event with technical identifiers

Session

GET/admin/campaigns

List campaign approvals

Session

PATCH/admin/campaigns/{id}/approvals/{approvalId}

Decide a campaign approval

Session

GET/admin/cards

List masked cards

Session

GET/admin/dashboard

Read the operations dashboard

Session

GET/admin/disputes

List disputes

Session

GET/admin/disputes/{disputeId}/evidence/{evidenceId}/content

Download dispute evidence

Session

PATCH/admin/disputes/{id}

Update a dispute

Session

GET/admin/disputes/{id}/evidence

List dispute evidence

Session

GET/admin/dlq

List dead-letter entries

Session

GET/admin/dlq/{id}

Read dead-letter recovery eligibility

Session

POST/admin/dlq/{id}/resolve

Resolve a terminal global issuing recovery dead letter

Session

POST/admin/dlq/{id}/retry

Retry controlled global issuing work from retained encrypted payload

Session

GET/admin/email/attempts

List transactional-email delivery attempts

Session

POST/admin/email/attempts/{messageId}/resolve

Resolve an uncertain transactional-email attempt

Session

POST/admin/email/attempts/{messageId}/retry

Retry a confirmed failed transactional email

Session

GET/admin/email/dead-letters

List transactional-email dead letters

Session

GET/admin/email/lifecycle-events

List Cloudflare Email lifecycle events

Session

GET/admin/email/readiness

Read transactional-email lifecycle readiness

Session

GET/admin/email/suppressions

List blocked transactional-email recipients

Session

POST/admin/email/suppressions/{recoveryHandle}/recover

Clear a transactional-email recipient suppression

Session

GET/admin/funding

List funding activity

Session

POST/admin/global-issuing/transactions/{id}/reconcile-suspense

Reconcile an unlinked issuing return

Session

GET/admin/global-issuing/transactions/{id}/reconciliation-candidates

List eligible reconciliation source transactions

Session

GET/admin/identity-verifications

List provider-managed identity verifications

Session

GET/admin/identity-verifications/{id}

Read a provider-managed identity verification

Session

POST/admin/identity-verifications/{id}/reconcile

Reconcile identity verification state with the provider

Session

POST/admin/identity-verifications/{id}/retry

Retry failed identity processing

Session

GET/admin/kyc-aml-cases

List legacy KYC history

Session

GET/admin/ledger

List ledger projections

Session

GET/admin/merchant-reviews

List merchant reviews

Session

GET/admin/merchant-reviews/{id}

Read a merchant review and KYB profile

Session

PATCH/admin/merchant-reviews/{id}

Recommend or decide a merchant review

Session

POST/admin/merchant-reviews/{id}/claim

Claim a queued merchant review

Session

GET/admin/merchant-reviews/{id}/documents

List merchant review documents

Session

GET/admin/merchant-reviews/{id}/history

List merchant review audit history

Session

PATCH/admin/merchant-reviews/{reviewId}/documents/{documentId}

Decide a merchant review document

Session

GET/admin/merchant-reviews/{reviewId}/documents/{documentId}/content

Download a merchant review document

Session

GET/admin/merchants

List merchants

Session

PATCH/admin/merchants/{id}/issuing-environment

Switch the merchant issuing environment

Session

GET/admin/recipients

List masked recipients

Session

GET/admin/reconciliation

List reconciliation runs

Session

GET/admin/reports

List internal reports

Session

POST/admin/reports

Request an internal report

Session

GET/admin/reports/{id}/download

Download an internal report

Session

GET/admin/risk/cases

List risk cases

Session

PATCH/admin/risk/cases/{id}

Update a risk case

Session

GET/admin/settlements

List settlements

Session

GET/admin/shopify/app-events

List Shopify App Event billing delivery state

Session

POST/admin/shopify/app-events/{id}/retry

Retry an exhausted Shopify App Event with its permanent idempotency key

Session

POST/admin/shopify/app-events/{id}/write-off

Record an audited write-off for an exhausted Shopify App Event

Session

GET/admin/shopify/webhook-inbox

List Shopify webhook delivery and installation-generation state

Session

POST/admin/shopify/webhook-inbox/{id}/retry

Retry a failed retained Shopify webhook delivery

Session

GET/admin/support/tickets

List support tickets

Session

PATCH/admin/support/tickets/{id}

Update a support ticket

Session

GET/admin/support/tickets/{id}/replies

List support ticket replies

Session

GET/admin/system

Read system configuration status

Session

GET/admin/transactions

List transactions

Session

GET/admin/ui-settings

Read personal administrator interface settings

Session

PATCH/admin/ui-settings

Update personal administrator interface settings

Session

GET/admin/webhook-deliveries

List webhook deliveries

Session

Authentication10 operations
POST/auth/password/forgot

Request a password reset code

Public

POST/auth/password/reset

Complete a password reset

Public

GET/auth/session

Read the current session

Session

POST/auth/sign-in

Start a standalone session or step-up challenge

Public

POST/auth/sign-out

End the current session

Session

POST/auth/step-up/{id}/verify

Verify a sign-in step-up challenge

Public

POST/auth/verify-email

Verify a merchant email challenge

Public

POST/auth/verify-email/resend

Resend a merchant email challenge

Public

POST/cardholder/access/exchange

Exchange a private email link and card_access Turnstile proof for a 15-minute program-scoped session

Public

POST/cardholder/access/renew

Replace an expired 30-day email link by sending a new link only to its original recipient

Public

Awards6 operations
GET/awards

List awards

Session

GET/awards/{id}

Read an award

Session

POST/awards/{id}/contact

Complete prepaid cardholder contact

Session

POST/awards/{id}/send-claim

Queue an award claim email

Session

POST/orders/{id}/evaluate

Evaluate an order for an award

Session

GET/recipients

List masked recipients

Session

Campaigns8 operations
GET/campaigns

List campaigns

Session

POST/campaigns

Create a campaign

Session

GET/campaigns/{id}

Read a campaign

Session

PATCH/campaigns/{id}

Update a campaign

Session

POST/campaigns/{id}/approvals

Record a campaign approval

Session

POST/campaigns/{id}/submit

Submit a campaign for approval

Session

GET/campaigns/{id}/versions

List campaign versions

Session

GET/public/campaigns/{id}

Read public campaign terms

Public

Cardholder18 operations
GET/cardholder/cards

List cardholder cards

Session

POST/cardholder/cards/{id}/close

Request permanent card closure

Session

POST/cardholder/cards/{id}/embed-session

Create an issuing-provider card session or exchange a Marqeta UX Toolkit DPoP proof after step-up

Session

GET/cardholder/disputes

List cardholder disputes

Session

POST/cardholder/disputes

Open a cardholder dispute

Session

GET/cardholder/disputes/{disputeId}/evidence/{evidenceId}/content

Download cardholder dispute evidence

Session

GET/cardholder/disputes/{id}/evidence

List cardholder dispute evidence

Session

POST/cardholder/disputes/{id}/evidence

Attach cardholder dispute evidence

Session

GET/cardholder/privacy

Read cardholder privacy choices

Session

PATCH/cardholder/privacy

Update cardholder privacy choices

Session

GET/cardholder/profile

Read the cardholder profile

Session

PATCH/cardholder/profile

Update the cardholder profile

Session

GET/cardholder/support/tickets

List cardholder support tickets

Session

POST/cardholder/support/tickets

Create a cardholder support ticket

Session

GET/cardholder/support/tickets/{id}/replies

List cardholder ticket replies

Session

POST/cardholder/support/tickets/{id}/replies

Reply to a cardholder ticket

Session

GET/cardholder/transactions

List cardholder transactions

Session

GET/cardholder/wallet

Read cards, award buckets and transactions only for the email-authorized issuing program

Session

Cards3 operations
POST/awards/{id}/issue

Issue an approved award card

Session

GET/cards

List masked cards

Session

GET/transactions

List transactions

Session

Developer7 operations
GET/api-keys

List API keys

Session

POST/api-keys

Create an API key

Session

DELETE/api-keys/{id}

Revoke an API key

Session

GET/webhook-endpoints

List webhook endpoints

Session

POST/webhook-endpoints

Create a webhook endpoint

Session

PATCH/webhook-endpoints/{id}

Update a webhook endpoint

Session

GET/webhook-endpoints/{id}/deliveries

List webhook deliveries

Session

Disputes5 operations
GET/disputes

List disputes

Session

POST/disputes

Open a dispute

Session

GET/disputes/{disputeId}/evidence/{evidenceId}/content

Download dispute evidence

Session

GET/disputes/{id}/evidence

List dispute evidence

Session

POST/disputes/{id}/evidence

Attach dispute evidence

Session

Funding5 operations
GET/funding

List funding requests

Session

POST/funding

Create a funding request for an enrolled issuing program

Session

GET/funding-sources

List funding sources

Session

POST/funding-sources

Create a funding source for an enrolled issuing program

Session

GET/ledger

Read projected ledger balances

Session

Integrations2 operations
GET/integrations

List commerce integrations

Session

POST/integrations

Create a commerce integration

Session

Issuing Companies29 operations
GET/admin/global-issuing/account-holders

List global cardholder program accounts

Session

GET/admin/global-issuing/book-transfers

List issuing-provider book-transfer operations

Session

GET/admin/global-issuing/buckets

List merchant-isolated award funding buckets

Session

GET/admin/global-issuing/cards

List global cards, authorization readiness, and transition ownership

Session

POST/admin/global-issuing/cards/{id}/recover-transition

Reconcile an abandoned automatic card transition or permanent closure with operator evidence

Session

GET/admin/global-issuing/enrollments

List global program merchant enrollments

Session

POST/admin/global-issuing/enrollments

Enroll a merchant in the active global issuing program

Session

PATCH/admin/global-issuing/enrollments/{id}

Change enrollment state or priority for new eligible awards

Session

POST/admin/global-issuing/enrollments/{id}/recover

Block a merchant and recover its available awards

Session

GET/admin/global-issuing/programs

List global issuing programs

Session

POST/admin/global-issuing/programs

Create a draft global issuing program

Session

GET/admin/global-issuing/programs/{id}

Read one global issuing program

Session

PATCH/admin/global-issuing/programs/{id}

Approve, activate, reconfigure, or disable a global issuing program

Session

POST/admin/global-issuing/programs/{id}/verify

Verify exact issuing-provider program resources

Session

GET/admin/global-issuing/readiness

Read global issuing readiness and operational totals

Session

GET/admin/global-issuing/transactions

List global card transactions and merchant allocations

Session

GET/admin/global-issuing/webhook-subscriptions

List issuing-provider event subscriptions

Session

POST/admin/global-issuing/webhook-subscriptions

Store encrypted issuing-provider webhook authentication

Session

PATCH/admin/global-issuing/webhook-subscriptions/{id}

Rotate or disable issuing-provider webhook authentication

Session

GET/admin/issuing-companies

List issuing companies and environment connections

Session

POST/admin/issuing-companies

Add an issuing company to the adapter catalog

Session

PATCH/admin/issuing-companies/{id}

Update issuing-company identity and methodology metadata

Session

POST/admin/issuing-companies/{id}/environments

Configure an issuing-company environment

Session

PATCH/admin/issuing-companies/environments/{id}

Update an issuing-company environment

Session

POST/admin/issuing-companies/environments/{id}/credentials

Replace write-only issuing-company environment credentials

Session

POST/admin/issuing-companies/environments/{id}/verify

Verify issuing-company credentials and activate the environment

Session

GET/admin/issuing-companies/program-assignments

List issuing-company program assignments

Session

POST/admin/issuing-companies/program-assignments

Request an issuing-company program assignment

Session

PATCH/admin/issuing-companies/program-assignments/{id}

Approve, reconfigure, or disable an issuing-company program assignment

Session

KYB7 operations
GET/compliance

Read compliance status

Session

GET/merchant/kyb

Read the KYB application

Session

PUT/merchant/kyb

Save the KYB application

Session

GET/merchant/kyb/documents

List KYB documents

Session

POST/merchant/kyb/documents

Upload a KYB document

Session

GET/merchant/kyb/documents/{id}/content

Download a KYB document

Session

POST/merchant/kyb/submit

Submit the KYB application

Session

Merchant5 operations
GET/dashboard

Read the merchant dashboard

Session

GET/merchant

Read the merchant profile and operational issuing programs

Session

PATCH/merchant

Update the merchant profile

Session

GET/settings

Read tenant settings

Session

PATCH/settings

Update tenant settings

Session

Orders5 operations
GET/orders

List orders

Session

POST/orders

Ingest an order

API key

GET/orders/{id}

Read an order

Session

POST/orders/{id}/refunds

Record an order refund

API key

POST/orders/{id}/returns

Record an order return

API key

Reports3 operations
GET/reports

List reports

Session

POST/reports

Request a report export

Session

GET/reports/{id}/download

Download a report export

Session

Risk1 operation
GET/risk/cases

List merchant risk cases

Session

Support4 operations
GET/support/tickets

List support tickets

Session

POST/support/tickets

Create a support ticket

Session

GET/support/tickets/{id}/replies

List ticket replies

Session

POST/support/tickets/{id}/replies

Reply to a support ticket

Session

System4 operations
GET/

Discover the API contract and developer resources

Public

GET/health

Read API health

Public

GET/openapi

Read this OpenAPI document

Public

GET/status

Read dependency status

Public

Team3 operations
GET/members

List tenant members

Session

POST/members

Invite a tenant member

Session

PATCH/members/{memberId}

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.