Endpoint catalog
Browse every operation in the current Paybytoken Core API contract.
This catalog is generated from the versioned Core API contract and currently contains 111 paths and 125 operations. Use the resource guides for workflow decisions and this page to verify the exact method, path, authentication boundary, and operation ID.
The Operator API is included for contract completeness but is restricted to Paybytoken operations. Merchant integrations must not call /admin/v1 endpoints.
Merchant API
Server-to-server resources owned by a merchant account. Authenticate with a test or live secret key.
Settlement
| Method | Endpoint | Authentication | Operation ID | Description |
|---|---|---|---|---|
GET | /api/v1/settlement_assets | Paybytoken secret API key | listPlatformSettlementAssets | List assets enabled for Settlement collection |
POST | /api/v1/settlement_accounts | Paybytoken secret API key | createPlatformSettlementAccount | Create a Settlement Account |
GET | /api/v1/settlement_accounts/{accountId} | Paybytoken secret API key | retrievePlatformSettlementAccount | Retrieve a Settlement Account |
GET | /api/v1/settlement_accounts/{accountId}/balances | Paybytoken secret API key | listPlatformSettlementBalances | List exact-asset Settlement balances |
GET | /api/v1/settlement_accounts/{accountId}/settlement_policy | Paybytoken secret API key | retrievePlatformSettlementPolicy | Retrieve the account's settlement policy |
PUT | /api/v1/settlement_accounts/{accountId}/settlement_policy | Paybytoken secret API key | upsertPlatformSettlementPolicy | Configure the account's preview-only daily settlement policy |
GET | /api/v1/settlement_accounts/{accountId}/settlement_policy/preview | Paybytoken secret API key | previewPlatformSettlementPolicy | Preview today's settlement decision without moving funds |
POST | /api/v1/settlement_accounts/{accountId}/platform_funding_transfers | Paybytoken secret API key | createPlatformFundingTransfer | Fund a Settlement Account from a Core merchant balance |
GET | /api/v1/settlement_accounts/{accountId}/platform_funding_transfers/{transferId} | Paybytoken secret API key | retrievePlatformFundingTransfer | Retrieve a Core-owned Settlement funding transfer |
POST | /api/v1/settlement_accounts/{accountId}/funding_destinations | Paybytoken secret API key | createPlatformSettlementFundingDestination | Create persistent Settlement collection instructions |
GET | /api/v1/settlement_accounts/{accountId}/funding_destinations/{destinationId} | Paybytoken secret API key | retrievePlatformSettlementFundingDestination | Retrieve Settlement collection instructions |
GET | /api/v1/conversion_instruments | Paybytoken secret API key | listPlatformConversionInstruments | List enabled Settlement conversion routes |
POST | /api/v1/settlement_accounts/{accountId}/conversion_quotes | Paybytoken secret API key | createPlatformConversionQuote | Create an executable Settlement conversion quote |
GET | /api/v1/settlement_accounts/{accountId}/conversion_quotes/{quoteId} | Paybytoken secret API key | retrievePlatformConversionQuote | Retrieve a Settlement conversion quote |
POST | /api/v1/settlement_accounts/{accountId}/conversion_quotes/{quoteId}/accept | Paybytoken secret API key | acceptPlatformConversionQuote | Accept a Settlement conversion quote |
GET | /api/v1/settlement_accounts/{accountId}/conversion_orders/{orderId} | Paybytoken secret API key | retrievePlatformConversionOrder | Retrieve a Settlement conversion order |
POST | /api/v1/settlement_accounts/{accountId}/beneficiaries | Paybytoken secret API key | createPlatformSettlementBeneficiary | Create a wallet beneficiary for Settlement Transfers |
GET | /api/v1/settlement_accounts/{accountId}/beneficiaries/{beneficiaryId} | Paybytoken secret API key | retrievePlatformSettlementBeneficiary | Retrieve a Settlement beneficiary |
POST | /api/v1/settlement_accounts/{accountId}/settlement_quotes | Paybytoken secret API key | createPlatformSettlementQuote | Create an executable Settlement Transfer quote |
GET | /api/v1/settlement_accounts/{accountId}/settlement_quotes/{quoteId} | Paybytoken secret API key | retrievePlatformSettlementQuote | Retrieve a Settlement Transfer quote |
POST | /api/v1/settlement_accounts/{accountId}/settlement_quotes/{quoteId}/accept | Paybytoken secret API key | acceptPlatformSettlementQuote | Accept a Settlement Transfer quote |
GET | /api/v1/settlement_accounts/{accountId}/settlement_transfers/{transferId} | Paybytoken secret API key | retrievePlatformSettlementTransfer | Retrieve a Settlement Transfer |
Payment Method Configurations
| Method | Endpoint | Authentication | Operation ID | Description |
|---|---|---|---|---|
GET | /api/v1/payment_method_configurations/default | Paybytoken secret API key | retrieveDefaultPaymentMethodConfiguration | Retrieve the default payment method configuration |
PUT | /api/v1/payment_method_configurations/default | Paybytoken secret API key | updateDefaultPaymentMethodConfiguration | Update the default payment method configuration |
Checkout Sessions
| Method | Endpoint | Authentication | Operation ID | Description |
|---|---|---|---|---|
GET | /api/v1/checkout_sessions | Paybytoken secret API key | listCheckoutSessions | List Checkout Sessions |
POST | /api/v1/checkout_sessions | Paybytoken secret API key | createCheckoutSession | Create a Checkout Session |
GET | /api/v1/checkout_sessions/{id} | Paybytoken secret API key | retrieveCheckoutSession | Retrieve a Checkout Session |
POST | /api/v1/checkout_sessions/{id}/confirm | Paybytoken secret API key | confirmCheckoutSession | Confirm a Checkout Session |
Payment Links
| Method | Endpoint | Authentication | Operation ID | Description |
|---|---|---|---|---|
GET | /api/v1/payment_links | Paybytoken secret API key | listPaymentLinks | List Payment Links |
POST | /api/v1/payment_links | Paybytoken secret API key | createPaymentLink | Create a Payment Link |
GET | /api/v1/payment_links/{id} | Paybytoken secret API key | retrievePaymentLink | Retrieve a Payment Link |
GET | /api/v1/payment_links/{id}/analytics | Paybytoken secret API key | retrievePaymentLinkAnalytics | Retrieve Payment Link analytics |
GET | /api/v1/payment_links/{id}/analytics/export | Paybytoken secret API key | exportPaymentLinkAnalytics | Export Payment Link analytics |
POST | /api/v1/payment_links/{id}/activate | Paybytoken secret API key | activatePaymentLink | Activate a Payment Link |
POST | /api/v1/payment_links/{id}/deactivate | Paybytoken secret API key | deactivatePaymentLink | Deactivate a Payment Link without canceling existing Checkout Sessions |
Payment Requests
| Method | Endpoint | Authentication | Operation ID | Description |
|---|---|---|---|---|
GET | /api/v1/payment_requests | Paybytoken secret API key | listPaymentRequests | List Payment Requests |
POST | /api/v1/payment_requests | Paybytoken secret API key | createPaymentRequest | Create a draft Payment Request |
GET | /api/v1/payment_requests/{id} | Paybytoken secret API key | retrievePaymentRequest | Retrieve a Payment Request |
PATCH | /api/v1/payment_requests/{id} | Paybytoken secret API key | updatePaymentRequest | Update a draft Payment Request |
POST | /api/v1/payment_requests/{id}/finalize | Paybytoken secret API key | finalizePaymentRequest | Finalize and publish a Payment Request |
POST | /api/v1/payment_requests/{id}/cancel | Paybytoken secret API key | cancelPaymentRequest | Cancel an open Payment Request |
GET | /api/v1/payment_requests/{id}/payments | Paybytoken secret API key | listPaymentRequestPayments | List Payment Request payment allocations |
Customers
| Method | Endpoint | Authentication | Operation ID | Description |
|---|---|---|---|---|
GET | /api/v1/customers | Paybytoken secret API key | listCustomers | List merchant customers |
POST | /api/v1/customers | Paybytoken secret API key | createCustomer | Create a merchant customer |
GET | /api/v1/customers/{customerId} | Paybytoken secret API key | retrieveCustomer | Retrieve a merchant customer |
PATCH | /api/v1/customers/{customerId} | Paybytoken secret API key | updateCustomer | Update customer status or metadata |
Customer Deposits
| Method | Endpoint | Authentication | Operation ID | Description |
|---|---|---|---|---|
GET | /api/v1/deposit-assets | Paybytoken secret API key | listDepositAssets | List supported customer-deposit assets |
GET | /api/v1/customers/{customerId}/deposit-accounts | Paybytoken secret API key | listCustomerDepositAccounts | List customer deposit accounts |
POST | /api/v1/customers/{customerId}/deposit-accounts | Paybytoken secret API key | createCustomerDepositAccount | Create or retrieve an EVM deposit account |
GET | /api/v1/customers/{customerId}/deposit-accounts/{depositAccountId} | Paybytoken secret API key | retrieveCustomerDepositAccount | Retrieve a customer deposit account |
GET | /api/v1/customers/{customerId}/deposit-accounts/{depositAccountId}/addresses | Paybytoken secret API key | listCustomerDepositAddresses | List persistent address slots |
GET | /api/v1/customers/{customerId}/deposit-accounts/{depositAccountId}/addresses/{addressId} | Paybytoken secret API key | retrieveCustomerDepositAddress | Retrieve a persistent address slot |
PATCH | /api/v1/customers/{customerId}/deposit-accounts/{depositAccountId}/addresses/{addressId} | Paybytoken secret API key | updateCustomerDepositAddress | Update an address label or restriction |
PUT | /api/v1/customers/{customerId}/deposit-accounts/{depositAccountId}/addresses/{addressId}/chains/{chain} | Paybytoken secret API key | activateCustomerDepositAddressChain | Activate another EVM chain on the same address |
GET | /api/v1/deposits | Paybytoken secret API key | listCustomerDeposits | List merchant customer deposits |
GET | /api/v1/deposits/{depositId} | Paybytoken secret API key | retrieveCustomerDeposit | Retrieve a customer deposit |
GET | /api/v1/customers/{customerId}/deposits | Paybytoken secret API key | listDepositsForCustomer | List one customer's deposits |
GET | /api/v1/customers/{customerId}/balances | Paybytoken secret API key | listCustomerBalances | List a customer's chain and asset balances |
Customer Withdrawals
| Method | Endpoint | Authentication | Operation ID | Description |
|---|---|---|---|---|
GET | /api/v1/withdrawal-assets | Paybytoken secret API key | listCustomerWithdrawalAssets | List supported customer-withdrawal assets and fee policies |
GET | /api/v1/customers/{customerId}/withdrawals | Paybytoken secret API key | listCustomerWithdrawals | List a customer's cryptocurrency withdrawals |
POST | /api/v1/customers/{customerId}/withdrawals | Paybytoken secret API key | createCustomerWithdrawal | Create a withdrawal from a customer's cryptocurrency balance |
GET | /api/v1/customers/{customerId}/withdrawals/{withdrawalId} | Paybytoken secret API key | retrieveCustomerWithdrawal | Retrieve a customer cryptocurrency withdrawal |
Payment Intents
| Method | Endpoint | Authentication | Operation ID | Description |
|---|---|---|---|---|
POST | /api/v1/payment_intents | Paybytoken secret API key | createPaymentIntent | Create a PaymentIntent |
GET | /api/v1/payment_intents/{paymentIntentId} | Paybytoken secret API key | retrievePaymentIntent | Retrieve a PaymentIntent |
POST | /api/v1/payment_intents/{paymentIntentId}/confirm | Paybytoken secret API key | confirmPaymentIntent | Confirm a merchant-authorized PaymentIntent |
POST | /api/v1/payment_intents/{paymentIntentId}/capture | Paybytoken secret API key | capturePaymentIntent | Capture a manually authorized customer-balance PaymentIntent |
POST | /api/v1/payment_intents/{paymentIntentId}/cancel | Paybytoken secret API key | cancelPaymentIntent | Cancel a PaymentIntent and release any customer-balance authorization |
Refunds
| Method | Endpoint | Authentication | Operation ID | Description |
|---|---|---|---|---|
POST | /api/v1/refunds | Paybytoken secret API key | createRefund | Create a Refund |
GET | /api/v1/refunds/{refundId} | Paybytoken secret API key | retrieveRefund | Retrieve a Refund |
Paybytoken Pay Hosted
| Method | Endpoint | Authentication | Operation ID | Description |
|---|---|---|---|---|
POST | /api/v1/consumer_payment_sessions | Paybytoken secret API key | createConsumerPaymentSession | Create a hosted Paybytoken Pay payment session |
GET | /api/v1/consumer_payment_sessions/{id} | Paybytoken secret API key | retrieveConsumerPaymentSession | Retrieve a merchant-owned hosted payment session |
POST | /api/v1/consumer_payment_sessions/{id}/cancel | Paybytoken secret API key | cancelConsumerPaymentSession | Cancel a pending hosted payment session |
Paybytoken Pay Linking
| Method | Endpoint | Authentication | Operation ID | Description |
|---|---|---|---|---|
POST | /api/v1/consumer_link_sessions | Paybytoken secret API key | createConsumerLinkSession | Create a hosted Paybytoken Account link session |
GET | /api/v1/consumer_link_sessions/{id} | Paybytoken secret API key | retrieveConsumerLinkSession | Retrieve a merchant-owned consumer link session |
POST | /api/v1/consumer_link_sessions/{id}/cancel | Paybytoken secret API key | cancelConsumerLinkSession | Cancel a pending consumer link session |
Public checkout API
Customer-facing resolution and checkout-session creation for public collection links. These endpoints do not accept merchant credentials.
Payment Requests
| Method | Endpoint | Authentication | Operation ID | Description |
|---|---|---|---|---|
GET | /public/v1/payment_requests/{publicToken} | None | resolvePublicPaymentRequest | Resolve a public Payment Request |
POST | /public/v1/payment_requests/{publicToken}/checkout_sessions | None | createPublicPaymentRequestCheckoutSession | Start a Checkout Session for a Payment Request |
Payment Links
| Method | Endpoint | Authentication | Operation ID | Description |
|---|---|---|---|---|
GET | /public/v1/payment_links/{publicToken} | None | resolvePublicPaymentLink | Resolve a public Payment Link template |
POST | /public/v1/payment_links/{publicToken}/checkout_sessions | None | createPublicPaymentLinkCheckoutSession | Start a Checkout Session from a Payment Link |
POST | /public/v1/payment_links/{publicToken}/visits | None | recordPublicPaymentLinkVisit | Record an anonymous Payment Link visit |
Consumer API
Paybytoken Pay account, linking, balance, payment, deposit, and withdrawal operations authorized by a consumer session.
Paybytoken Pay Consumer
| Method | Endpoint | Authentication | Operation ID | Description |
|---|---|---|---|---|
POST | /consumer/v1/auth/challenges | None | createConsumerAuthChallenge | Request a Paybytoken Pay sign-in code |
POST | /consumer/v1/auth/challenges/{challengeId}/verify | None | verifyConsumerAuthChallenge | Verify a single-use Paybytoken Pay sign-in code |
POST | /consumer/v1/auth/refresh | None | refreshConsumerSession | Rotate a Paybytoken Pay consumer session |
POST | /consumer/v1/auth/logout | Paybytoken Pay consumer access token | logoutConsumerSession | Revoke the current Paybytoken Pay consumer session |
GET | /consumer/v1/account | Paybytoken Pay consumer access token | retrieveConsumerAccount | Retrieve the authenticated Paybytoken Account |
GET | /consumer/v1/balances | Paybytoken Pay consumer access token | listConsumerBalances | List exact-asset Paybytoken balances owned by the consumer |
PUT | /consumer/v1/deposit-addresses/{addressIndex} | Paybytoken Pay consumer access token | putConsumerDepositAddress | Provision or retrieve a consumer-owned EVM deposit address slot |
GET | /consumer/v1/deposit-addresses | Paybytoken Pay consumer access token | listConsumerDepositAddresses | List deposit address slots owned by the consumer |
GET | /consumer/v1/deposits | Paybytoken Pay consumer access token | listConsumerDeposits | List stablecoin deposits owned by the consumer |
GET | /consumer/v1/payment-intents/{paymentIntentId} | Paybytoken Pay consumer access token | previewConsumerPaymentIntent | Preview an exact Paybytoken Pay purchase |
POST | /consumer/v1/payment-intents/{paymentIntentId}/confirm | Paybytoken Pay consumer access token | confirmConsumerPaymentIntent | Authorize and settle a Paybytoken Pay purchase |
GET | /consumer/v1/transactions | Paybytoken Pay consumer access token | listConsumerTransactions | List the authenticated consumer's Paybytoken transaction history |
POST | /consumer/v1/funding-sessions | Paybytoken Pay consumer access token | createConsumerFundingSession | Start an exact-output Base ETH to USDC balance top-up |
GET | /consumer/v1/funding-sessions/{fundingSessionId} | Paybytoken Pay consumer access token | retrieveConsumerFundingSession | Retrieve a consumer funding session |
GET | /consumer/v1/funding-sessions/active | Paybytoken Pay consumer access token | listActiveConsumerFundingSessions | Resume the authenticated consumer's active funding session |
POST | /consumer/v1/funding-sessions/{fundingSessionId}/submit | Paybytoken Pay consumer access token | submitConsumerFundingTransaction | Attach the submitted Base ETH transaction for status tracking |
GET | /consumer/v1/withdrawal-assets | Paybytoken Pay consumer access token | listConsumerWithdrawalAssets | List enabled Paybytoken Pay withdrawal assets and fee policy |
POST | /consumer/v1/withdrawal-authorizations | Paybytoken Pay consumer access token | createConsumerWithdrawalAuthorization | Send a step-up code bound to one exact withdrawal request |
GET | /consumer/v1/withdrawals | Paybytoken Pay consumer access token | listConsumerWithdrawals | List withdrawals owned by the consumer |
POST | /consumer/v1/withdrawals | Paybytoken Pay consumer access token | createConsumerWithdrawal | Consume a step-up authorization and reserve a consumer withdrawal |
GET | /consumer/v1/withdrawals/{withdrawalId} | Paybytoken Pay consumer access token | retrieveConsumerWithdrawal | Retrieve one consumer-owned withdrawal |
GET | /consumer/v1/payment-sessions/{paymentSessionId} | Paybytoken Pay consumer access token | previewConsumerPaymentSession | Preview a hosted Paybytoken Pay payment |
POST | /consumer/v1/payment-sessions/{paymentSessionId}/confirm | Paybytoken Pay consumer access token | confirmConsumerPaymentSession | Confirm the hosted payment as the authenticated consumer |
POST | /consumer/v1/payment-sessions/{paymentSessionId}/decline | Paybytoken Pay consumer access token | declineConsumerPaymentSession | Decline the hosted payment handoff |
GET | /consumer/v1/link-sessions/{linkSessionId} | Paybytoken Pay consumer access token | previewConsumerLinkSession | Preview the merchant link consent |
POST | /consumer/v1/link-sessions/{linkSessionId}/approve | Paybytoken Pay consumer access token | approveConsumerLinkSession | Approve and create the merchant-specific account link |
POST | /consumer/v1/link-sessions/{linkSessionId}/decline | Paybytoken Pay consumer access token | declineConsumerLinkSession | Decline the merchant link consent |
GET | /consumer/v1/merchant-links | Paybytoken Pay consumer access token | listConsumerMerchantLinks | List the authenticated consumer's merchant links |
POST | /consumer/v1/merchant-links/{linkId}/revoke | Paybytoken Pay consumer access token | revokeConsumerMerchantLink | Revoke one consumer-owned merchant link |
Operator API
Restricted support and readiness operations for Paybytoken operators. These are not merchant integration endpoints.
Paybytoken Pay Operations
| Method | Endpoint | Authentication | Operation ID | Description |
|---|---|---|---|---|
GET | /admin/v1/paybytoken_pay/controls | Paybytoken administrator access token | listPaybytokenPayControls | List exact-asset Paybytoken Pay launch controls |
PUT | /admin/v1/paybytoken_pay/controls/{ownerType}/{ownerId}/{chain}/{currency} | Paybytoken administrator access token | upsertPaybytokenPayControl | Enable, disable, or block one exact-asset owner |
GET | /admin/v1/paybytoken_pay/support-actions | Paybytoken administrator access token | listPaybytokenPaySupportActions | List audited Paybytoken Pay support mutations |
GET | /admin/v1/paybytoken_pay/consumer-accounts/{consumerAccountId} | Paybytoken administrator access token | retrievePaybytokenPayConsumerOverview | Retrieve a business-state consumer support overview |
PATCH | /admin/v1/paybytoken_pay/consumer-accounts/{consumerAccountId} | Paybytoken administrator access token | updatePaybytokenPayConsumer | Restrict or update the KYC state of a Paybytoken Account |
GET | /admin/v1/paybytoken_pay/funding-sessions | Paybytoken administrator access token | listConsumerFundingSessionsForSupport | Inspect consumer ETH funding and canonical USDC settlement evidence |
POST | /admin/v1/paybytoken_pay/funding-sessions/{fundingSessionId}/reconcile | Paybytoken administrator access token | reconcileConsumerFundingSession | Link a confirmed consumer deposit to an uncorrelated funding session |
GET | /admin/v1/paybytoken_pay/consumer-accounts/{consumerAccountId}/transactions | Paybytoken administrator access token | listPaybytokenPayConsumerTransactionsForSupport | Investigate one consumer's canonical business transactions |
GET | /admin/v1/paybytoken_pay/readiness | Paybytoken administrator access token | retrievePaybytokenPayReadiness | Inspect mode-bound Paybytoken Pay launch readiness |
Settlement Operations
| Method | Endpoint | Authentication | Operation ID | Description |
|---|---|---|---|---|
POST | /admin/v1/platform_funding_reconciliation/runs | Paybytoken administrator access token | createPlatformFundingReconciliationRun | Compare a bounded batch of Core and Settlement funding evidence |
GET | /admin/v1/platform_funding_reconciliation/findings | Paybytoken administrator access token | listPlatformFundingReconciliationFindings | List cross-ledger differences and repair status |
GET | /admin/v1/platform_funding_reconciliation/metrics | Paybytoken administrator access token | retrievePlatformFundingReconciliationMetrics | Inspect active cross-ledger findings and failed scans |
GET | /admin/v1/platform_funding_reconciliation/overview | Paybytoken administrator access token | retrievePlatformFundingReconciliationOverview | Inspect scheduler health, SLOs, findings, runs, and operator alerts |
GET | /admin/v1/platform_funding_reconciliation/findings/{findingId}/actions | Paybytoken administrator access token | listPlatformFundingReconciliationActions | List the immutable operator history for a finding |
POST | /admin/v1/platform_funding_reconciliation/findings/{findingId}/actions | Paybytoken administrator access token | createPlatformFundingReconciliationAction | Acknowledge, annotate, or close a reconciliation finding |
POST | /admin/v1/platform_funding_reconciliation/findings/{findingId}/repair | Paybytoken administrator access token | repairPlatformFundingReconciliationFinding | Retry an idempotent cross-ledger credit and verify fresh evidence |
Did this page answer your question?
Your feedback helps us improve the integration path.