How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Accrue Savings

Accrue Merchant API

The Accrue Merchant API is a JSON:API-based REST API for embedding Accrue's stored-value wallet into a merchant experience — creating and funding wallets, running payment intents and payments (authorize, capture, cancel, complete, refund, increase authorization), onboarding users through KYC and identity verification, managing counterparties and payouts, issuing rewards and gifts, and subscribing to twenty webhook topics. Published as OpenAPI 3.1 with 82 operations across production and sandbox environments.

Documentation Provider Profile APIs.io OpenAPI GitHub

This API exposes 82 operations across 64 paths, organized into 17 resource areas, and defines 295 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against 2 base URLs: https://merchant-api.accruesavings.com, https://merchant-api-sandbox.accruesavings.com.

82 operations 64 paths 295 schemas 4 DELETE38 GET6 PATCH34 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://merchant-api.accruesavings.com
Resource Areas
17

Paths & Operations 82

Across 64 paths, the API surfaces 82 operations — 4 DELETE, 38 GET, 6 PATCH, 34 POST. They span 17 resource areas, including PaymentIntents, Payments, Simulations, Wallets, Users, Identity Verification, Widgets, Sweepstakes, and 9 more. Each is listed below with its method, path, parameters, and response codes.

PaymentIntents 4

Payment Intents represent a commitment to pay a specified amount, allowing for a structured process to handle payments from initiation to completion. This resource serves as a pro…

POST
/api/v1/payment-intents
Create a Payment Intent
createPaymentIntent 2 params body → 201400403404
GET
/api/v1/payment-intents
List Payment Intents
listPaymentIntents 9 params → 200400
GET
/api/v1/payment-intents/{paymentIntentId}
Get a Payment Intent
getPaymentIntent 4 params → 200404
POST
/api/v1/payment-intents/{paymentIntentId}/authorize
Authorize Payment
authorizePayment 3 params body → 201402403
Payments 10

Payments are the realization of payment intents, representing the actual transfer or authorization of funds. This resource encapsulates the details of completed transactions, incl…

POST
/api/v1/payments
Create Payment
createPayment 2 params body → 200400402
GET
/api/v1/payments
List Payments
listPayments 10 params → 200400
GET
/api/v1/payments/{paymentId}
Get a Payment
getPayment 4 params → 200404
PATCH
/api/v1/payments/{paymentId}
Update a payment
updatePayment 3 params body → 200404
GET
/api/v1/payments/{paymentId}/card
Get Virtual Debit Card
getVirtualDebitCard 3 params → 200400403
POST
/api/v1/payments/{paymentId}/capture
Capture Payment
capturePayment 3 params body → 200402
PATCH
/api/v1/payments/{paymentId}/increase-authorization
Increase Authorization Amount
increaseAuthorization 3 params body → 200402
POST
/api/v1/payments/{paymentId}/cancel
Cancel Payment
cancelPayment 4 params → 200400404
POST
/api/v1/payments/{paymentId}/complete
Complete Payment
completePayment 4 params → 200402
POST
/api/v1/payments/{paymentId}/refund
Refund Payment
refund 3 params body → 200400
Simulations 12

Simulations are used to simulate payments authorizations and captures for Card Rails (Virtual Debit Cards).

POST
/api/v1/simulation/{paymentId}/card/auth
Simulate Card Authorization
simulateCardAuthorization 3 params body → 201400404
GET
/api/v1/simulation/{paymentId}/card/auth
Get Authorization Request List
getAuthorizationRequestList 3 params → 200404
POST
/api/v1/simulation/{paymentId}/card/capture
Simulate Card Capture
simulateCardCapture 3 params body → 201400404
GET
/api/v1/simulation/{paymentId}/card/capture
Get Captures List
getCapturesList 9 params → 200404
POST
/api/v1/simulation/{paymentId}/card/auth-capture
Simulate Card Authorization/Capture
simulateCardAuthorizationCapture 3 params body → 200400
POST
/api/v1/simulation/wallets/{walletId}/backup-linked-account
Create Demo Backup Payment Method
createDemoBackupPaymentMethod 3 params body → 200201404
POST
/api/v1/simulation/wallets/{walletId}/clear-pending/{type}
Clear Pending Transactions
clearPendingTransactions 4 params → 204400404
GET
/api/v1/simulation/wallets/{walletId}/barcodes
List Wallet Barcodes
listWalletBarcodes 4 params → 200404
POST
/api/v1/simulation/wallets/{walletId}/barcodes
Generate Wallet Barcode
generateWalletBarcode 3 params body → 201400404
GET
/api/v1/simulation/barcodes/{lookUpId}
Get Wallet Barcode
getWalletBarcode 3 params → 200400404
POST
/api/v1/simulation/wallets/{walletId}/fail-transaction
Fail Pending Transaction
failPendingTransaction 3 params body → 204400404
POST
/api/v1/simulation/counterparties/{counterpartyId}/deposits
Simulate Counterparty Deposit
simulateCounterpartyDeposit 3 params body → 204400404
Wallets 9

Wallets are where users save money and collect rewards for future payments to merchants. Each wallet is linked to a specific merchant and tracks the balance of deposits and reward…

GET
/api/v1/wallets/:walletId
Get Wallet
getWallet 4 params → 200400404500
GET
/api/v1/wallets/barcode/{lookUpId}
Get Wallet by Barcode
getWalletByBarcode 4 params → 200400404
POST
/api/v1/wallets
Create Wallet
createWallet 2 params body → 201400500
GET
/api/v1/wallets/:walletId/balance
Get Wallet Balance
getWalletBalance 7 params → 200400404500
GET
/api/v1/wallets/
List Wallets
listWallets 7 params → 200400500
POST
/api/v1/wallets/:walletId/transactions
Create One-Time Deposit
createOneTimeDeposit 3 params body → 201400404500
GET
/api/v1/wallets/:walletId/transactions
List Transactions
listTransactions 6 params → 200400404500
POST
/api/v1/wallets/:walletId/withdraw
Closed-Loop Withdraw
closedLoopWithdraw 3 params body → 201400404500
GET
/api/v1/wallets/:walletId/transactions/:transactionId
Get Transaction
getTransaction 4 params → 200400404500
Users 5

Users represent the end users and are the parent container of Wallets. A user is automatically created when the end-user signs into the Accrue product through various different me…

GET
/api/v1/users
List Users
listUsers 7 params → 200400500
POST
/api/v1/users
Create User
createUser 2 params body → 201400409500
PATCH
/api/v1/users/:userReference/attached-profile
Update User
updateUser 3 params body → 204400500
GET
/api/v1/users/:userId
Get User
getUser 3 params → 200400404500
POST
/api/v1/users/:userId/disclosures/kyc
Accept KYC Disclosure Documents
acceptKycDisclosureDocuments 3 params → 204400404500
Identity Verification 3

Identity Verification provides knowledge-based authentication for sensitive account changes. Use these endpoints to challenge a user with profile and wallet questions, then apply…

POST
/api/v1/users/:userIdentifier/identity-verification/challenges
Create Identity Verification Challenge
createIdentityVerificationChallenge 3 params → 200400403404500
POST
/api/v1/users/:userIdentifier/identity-verification/challenges/:challengeId/submissions
Submit Identity Verification Challenge
submitIdentityVerificationChallenge 4 params body → 200400404500
POST
/api/v1/users/:userIdentifier/identity-verification/profile-updates
Apply Verified Profile Update
applyVerifiedProfileUpdate 3 params body → 200400404500
Widgets 6

Widgets are components that are embedded into applications to enrich the user experience. Some of those require additional data loaded through API endpoints. Learn more about the…

GET
/api/v1/widgets/wallet/{walletId}
Get Wallet Widget Data
getWalletWidgetData 5 params → 200400
GET
/api/v1/widgets/wallet
Find Wallet Widget Data
findWalletWidgetData 7 params → 200400
GET
/api/v1/widgets/payment-intent/{paymentIntentId}/linked-account
Get Linked Account Widget Data
getLinkedAccountWidgetData 3 params → 200400500
GET
/api/v2/widgets/wallet/{walletId}
Get Wallet Widget Data (V2)
getWalletWidgetDataV2 5 params → 200400
GET
/api/v2/widgets/wallet
Find Wallet Widget Data (V2)
findWalletWidgetDataV2 7 params → 200400
POST
/api/v1/widgets/session
Create Widget Session
createWidgetSession 2 params body → 200400
Sweepstakes 1

Sweepstakes campaigns give users the chance to win prizes by participating in merchant-sponsored promotions. Each campaign is linked to a specific merchant and tracks user entries…

POST
/api/v1/sweepstakes/{sweepstakesId}/results
Add Sweepstakes Results
addSweepstakesResults 3 params body → 201400500
Rewards 5

Partner-issued rewards let trusted integrations credit customer wallets or create pre-issued rewards for recipients identified by phone number. When a recipient has an active wall…

POST
/api/v1/rewards
Issue Reward
issueReward 2 params body → 200400409500
GET
/api/v1/rewards
List Issued Rewards
listIssuedRewards 6 params → 200400500
GET
/api/v1/rewards/{id}
Get Issued Reward by ID
getIssuedRewardById 3 params → 200400500
PATCH
/api/v1/rewards/{id}
Update Reward
updateReward 3 params body → 200400404409500
DELETE
/api/v1/rewards/{id}
Cancel Reward
cancelReward 3 params → 204404409500
Gifts 1

Gifts expose remaining spendable balance for a scanned lookUpId. Point-of-sale remaining lookup is GET /api/v1/gifts/{lookUpId}. Spend still uses payment intents with the same sca…

GET
/api/v1/gifts/{lookUpId}
Get Gift by lookUpId
getGiftByLookUpId 3 params → 200400404
Banking 4

Banking APIs provide KYC (Know Your Customer) verification functionality to enable users to comply with financial regulations when using banking features. These endpoints manage i…

POST
/api/v1/users/:userId/kyc/application
Create KYC Application
createKycApplication 3 params body → 200400500
GET
/api/v1/users/:userId/kyc/status
Get KYC Status
getKycStatus 3 params → 200400500
POST
/api/v1/users/:userId/kyc/document-verification-link
Get Document Verification Link
getDocumentVerificationLink 3 params body → 200400500
POST
/api/v1/users/:userId/kyc/document-verification/complete
Complete Document Verification
completeDocumentVerification 3 params → 200400500
Counterparties 7

Counterparties define bank accounts where funds are settled for captured payments. Settlement details live on externalBankAccount. There can be multiple counterparties.

POST
/api/v1/counterparties
Create Counterparty
createCounterparty 2 params body → 201400409500
GET
/api/v1/counterparties/
List Counterparties
listCounterparties 2 params → 200401500
GET
/api/v1/counterparties/:counterpartyId
Get Counterparty
getCounterparty 3 params → 200404500
PATCH
/api/v1/counterparties/:counterpartyId
Update Counterparty
updateCounterparty 3 params body → 200400404500
DELETE
/api/v1/counterparties/:counterpartyId
Delete Counterparty
deleteCounterparty 3 params → 204404409500
POST
/api/v1/counterparties/:counterpartyId/payouts
Create Counterparty Payout
createCounterpartyPayout 3 params body → 201400404500
GET
/api/v1/counterparties/:counterpartyId/payouts
List Counterparty Payouts
listCounterpartyPayouts 12 params → 200404500
CounterpartyTransfers 3

Counterparty Transfers represent movements of funds between two counterparties owned by the same partner. Use these endpoints to initiate, list, and retrieve counterparty-to-count…

POST
/api/v1/counterparty-transfers
Create Counterparty Transfer
createCounterpartyTransfer 2 params body → 201400403404
GET
/api/v1/counterparty-transfers/
List Counterparty Transfers
listCounterpartyTransfers 9 params → 200400
GET
/api/v1/counterparty-transfers/:counterpartyTransferId
Get Counterparty Transfer
getCounterpartyTransfer 3 params → 200404
LinkedAccounts 2

Linked Accounts represent payment methods that users have connected to their Accrue account. These accounts can be used for funding payments or topping up the wallet.

GET
/api/v1/users/:userId/linked-accounts
Get Linked Accounts for User
getLinkedAccounts 3 params → 200400404500
DELETE
/api/v1/users/:userId/linked-accounts/:linkedAccountId
Remove a Linked Account
deleteLinkedAccount 4 params → 204400403404409
ExternalTransactions 3

External transactions are records of transfers that happened outside the Accrue system. E.g. purchases in an online shop using a non-Accrue payment method.

POST
/api/v1/external-transactions
Add External Transactions
addExternalTransactions 2 params body → 200400500
GET
/api/v1/external-transactions
List External Transactions
listExternalTransactions 7 params → 200400500
GET
/api/v1/external-transactions/{externalTransactionId}
Get an External Transaction
getExternalTransaction 3 params → 200404500
Webhooks 5

Webhook management APIs

POST
/api/v1/webhooks
Create a webhook
createWebhook 2 params body → 201400
GET
/api/v1/webhooks
Get webhooks
getWebhooks 4 params → 200400
GET
/api/v1/webhooks/{webhookId}
Get a webhook
getWebhook 3 params → 200404
PATCH
/api/v1/webhooks/{webhookId}
Update a webhook
updateWebhook 3 params body → 200400404
DELETE
/api/v1/webhooks/{webhookId}
Delete a webhook
deleteWebhook 3 params → 204404
WebhookEvents 2

Webhook Event management APIs

GET
/api/v1/webhook-events
List Webhook Events
listWebhookEvents 6 params → 200400500
GET
/api/v1/webhook-events/{webhookEventId}
Get a webhook event
getWebhookEvent 3 params → 200404500

Schemas 295

The contract defines 295 schemas that model the data the API accepts and returns. The most detailed are BankApplicationLite (11 properties), CounterpartyPayoutEventAttributes (10 properties), CounterpartyIncomingPaymentEventAttributes (8 properties), WebhookEventQueryValidationErrorResponse (6 properties). Each schema is shown below with its type and property counts.

PaymentIntentBalanceInformation
object
Balance for this payment intent. available is the remaining spendable amount in cents (gift remaining for a gift lookUpId, or wallet available for a wallet).
3 properties 3 required
CreatePaymentIntentResponse
object
1 property 1 required
CreatePaymentIntentInvalidResponse
object
6 properties 6 required
CreatePaymentIntentWalletAccessDeniedResponse
object
6 properties 6 required
CreatePaymentIntentWalletNotFoundResponse
object
6 properties 6 required
CreatePaymentIntent
object
CreatePaymentIntent
3 properties 3 required
PaymentIntent
object
A transaction
4 properties 4 required
GetPaymentIntentResponse
object
2 properties 2 required
PaymentIntentNotFoundResponse
object
6 properties 5 required
ListPaymentIntentsResponse
object
2 properties 2 required
PaymentIntentQueryValidationErrorResponse
object
6 properties 6 required
AuthorizePaymentResponse
object
2 properties 2 required
AuthorizePaymentIntentFailedResponse
object
6 properties 6 required
AuthorizePaymentIntentForbiddenResponse
object
6 properties 6 required
AuthorizePaymentIntent
object
AuthorizePaymentIntent
4 properties 3 required
CreatePaymentResponse
object
3 properties 3 required
PaymentValidationResponse
object
6 properties 6 required
CreatePayment
object
CreatePayment
3 properties 3 required
Payment
object
A payment
5 properties 5 required
GetPaymentResponse
object
2 properties 2 required
PaymentAccessCheckNotFoundResponse
object
6 properties 5 required
VirtualDebitCard
object
A virtual debit card
4 properties 4 required
GetVirtualDebitCardResponse
object
1 property 1 required
InvalidPaymentIntentForCardDetailsResponse
object
6 properties 6 required
InvalidPaymentForCardDetailsResponse
object
6 properties 6 required
PaymentNotFoundForCardDetailsResponse
object
6 properties 6 required
WalletNotReadyForPaymentResponse
object
6 properties 6 required
GetVirtualDebitCardErrorResponse
ForbiddenForCardDetailsResponse
object
6 properties 6 required
ListPaymentsResponse
object
2 properties 2 required
PaymentQueryValidationErrorResponse
object
6 properties 6 required
CapturePaymentResponse
object
3 properties 3 required
CapturePayment
object
CapturePayment
3 properties 3 required
IncreasePaymentAuthorizationResponse
object
3 properties 3 required
IncreaseAuthorization
object
IncreaseAuthorization
3 properties 3 required
CancelPaymentResponse
object
3 properties 3 required
CancelPaymentErrorResponse
object
6 properties 6 required
PaymentNotFoundResponse
object
6 properties 6 required
CompletePaymentResponse
object
3 properties 3 required
Refund
object
A refund
3 properties 3 required
Capture
object
A capture included in the refund response
3 properties 3 required
Client
object
A client included in the refund response
3 properties 3 required
RefundPaymentResponse
object
4 properties 4 required
RefundValidationResponse
object
6 properties 6 required
RefundPayment
object
RefundPayment
3 properties 3 required
PaymentResponse
object
1 property 1 required
SimulationCardAuthorizationValidationResponse
object
6 properties 6 required
SimulationCardNotSupportedResponse
object
6 properties 6 required
SimulateCardErrorResponse
SimulationPaymentNotFoundResponse
object
6 properties 6 required
SimulateCardAuthorization
object
SimulateCardAuthorization
3 properties 3 required
AuthorizationRequest
object
AuthorizationRequest
3 properties 3 required
ListAuthorizationRequestsResponse
object
1 property 1 required
SimulateCardCapture
object
SimulateCardCapture
3 properties 3 required
CardCapture
object
CardCapture
3 properties 3 required
CardCapturesRequestsResponse
object
1 property 1 required
SimulateCardAuthorizationCapture
object
SimulateCardAuthorizationCapture
3 properties 3 required
DemoBackupPaymentMethod
object
Demo Backup Payment Method
3 properties 3 required
CreateDemoBackupPaymentMethodResponse
object
1 property 1 required
InvalidTransactionTypeResponse
object
6 properties 6 required
WalletNotFoundForSimulationResponse
object
6 properties 6 required
WalletBarcode
object
WalletBarcode
3 properties 3 required
ListWalletBarcodesResponse
object
1 property 1 required
GenerateWalletBarcodeResponse
object
1 property 1 required
GenerateBarcodeValidationResponse
object
6 properties 6 required
GenerateWalletBarcode
object
Generate Wallet Barcode request
3 properties 3 required
GetWalletBarcodeResponse
object
1 property 1 required
BarcodeExpiredOrInvalidResponse
object
6 properties 6 required
BarcodeNotFoundResponse
object
6 properties 6 required
InvalidTransactionResponse
object
6 properties 6 required
FailPendingTransactionRequest
object
Fail Pending Transaction request
3 properties 3 required
CounterpartyDepositSimulationValidationResponse
object
6 properties 6 required
CounterpartyNotFoundForSimulationResponse
object
6 properties 6 required
SimulateCounterpartyDeposit
object
SimulateCounterpartyDeposit
3 properties 3 required
Wallet
object
A wallet
4 properties 4 required
GetWalletResponse
object
2 properties 2 required
GetWalletErrorResponse
object
6 properties 6 required
WalletNotFoundResponse
object
6 properties 6 required
UnexpectedErrorForWalletResponse
object
6 properties 6 required
GetWalletByBarcodeResponse
object
2 properties 2 required
WalletBarcodeExpiredOrInvalidResponse
object
6 properties 6 required
WalletForBarcodeNotFoundResponse
object
6 properties 6 required
CreateWalletResponse
object
1 property 1 required
WalletUserNotFoundResponse
object
6 properties 6 required
WalletAlreadyExistsResponse
object
6 properties 6 required
PhoneNumberBannedForWalletResponse
object
6 properties 6 required
MerchantIsDisabledForWalletResponse
object
6 properties 6 required
InvalidIdentifierForWalletResponse
object
6 properties 6 required
InvalidUuidSyntaxForWalletResponse
object
6 properties 6 required
CreateWalletErrorResponse
GetWalletBalanceResponse
object
1 property 1 required
MultipleWalletsFoundResponse
object
6 properties 6 required
GetWalletBalanceErrorResponse
NoWalletFoundForBalanceResponse
object
6 properties 6 required
ListWalletsResponse
object
2 properties 2 required
WalletQueryValidationErrorResponse
object
6 properties 6 required
CreateOneTimeDepositResponse
object
1 property 1 required
KycNotCompletedResponse
object
6 properties 6 required
DepositFailedAtCardProcessorResponse
object
6 properties 6 required
ExceedsMaxOneTimeDepositAmountResponse
object
6 properties 6 required
CreateOneTimeDepositErrorResponse
TransactionNotFoundResponse
object
6 properties 6 required
CreateOneTimeDepositNotFoundResponse
ClosedLoopWithdrawResponse
object
1 property 1 required
ClosedLoopWithdrawErrorResponse
ClosedLoopWithdrawNotFoundResponse
object
6 properties 6 required
Transaction
object
A transaction
3 properties 3 required
ListTransactionsResponse
object
2 properties 2 required
ListTransactionsErrorResponse
object
6 properties 6 required
ListTransactionsNotFoundResponse
object
6 properties 6 required
GetTransactionResponse
object
1 property 1 required
GetTransactionErrorResponse
object
6 properties 6 required
GetTransactionNotFoundResponse
User
object
A user
3 properties 3 required
ListUsersResponse
object
2 properties 2 required
UserQueryValidationErrorResponse
object
6 properties 6 required
UnexpectedErrorResponse
object
6 properties 6 required
InvalidIdentifierForAttachedProfileResponse
object
6 properties 6 required
InvalidUuidSyntaxResponse
object
6 properties 6 required
UpdateUserAttachedProfileErrorResponse
AttachedProfile
object
AttachedProfile patch object
3 properties 3 required
ReducedUser
object
A user
3 properties 3 required
GetUserResponse
object
1 property 1 required
GetUserErrorResponse
object
6 properties 6 required
UserNotFoundResponse
object
6 properties 6 required
CreateUserResponse
object
1 property 1 required
InvalidIdentifierResponse
object
6 properties 6 required
PhoneNumberBannedResponse
object
6 properties 6 required
MerchantIsDisabledResponse
object
6 properties 6 required
CreateUserErrorResponse
UserAlreadyExistsResponse
object
6 properties 6 required
IdentityProviderFailureResponse
object
6 properties 6 required
CreateUserInternalServerErrorResponse
CreateUser
object
Create user request
2 properties 2 required
AcceptKycDisclosureDocumentsErrorResponse
object
6 properties 6 required
UserNotFoundForDisclosureResponse
object
6 properties 6 required
IdentityVerificationChallenge
object
An active identity verification challenge with multiple-choice questions.
3 properties 3 required
CreateIdentityVerificationChallengeResponse
object
1 property 1 required
CreateIdentityVerificationChallengeErrorResponse
object
6 properties 6 required
InsufficientVerificationDataResponse
object
6 properties 6 required
UserNotFoundForIdentityVerificationResponse
object
6 properties 6 required
UnexpectedIdentityVerificationErrorResponse
object
6 properties 6 required
IdentityVerificationResult
object
Outcome of an identity verification challenge submission.
3 properties 3 required
SubmitIdentityVerificationChallengeResponse
object
1 property 1 required
ChallengeExpiredResponse
object
6 properties 6 required
ChallengeFailedResponse
object
6 properties 6 required
MaxAttemptsExceededResponse
object
6 properties 6 required
IdentityVerificationValidationErrorResponse
object
6 properties 6 required
SubmitIdentityVerificationChallengeErrorResponse
ChallengeNotFoundResponse
object
6 properties 6 required
SubmitIdentityVerificationChallengeRequest
object
1 property 1 required
ProfileUpdateResult
object
Confirmation of a verified profile update.
3 properties 3 required
ApplyVerifiedProfileUpdateResponse
object
1 property 1 required
ApplyVerifiedProfileUpdateErrorResponse
ApplyVerifiedProfileUpdateNotFoundResponse
ApplyVerifiedProfileUpdateRequest
object
1 property 1 required
WalletWidgetData
object
Widgets
5 properties 5 required
GetWalletWidgetDataResponse
object
1 property 1 required
NoWalletFoundResponse
object
6 properties 6 required
InvalidIdentifierForWidgetResponse
object
6 properties 6 required
MultipleWalletsFoundForWidgetResponse
object
6 properties 6 required
WalletWidgetErrorResponse
LinkedAccountWidgetData
object
Widgets
3 properties 3 required
GetLinkedAccountWidgetDataResponse
object
1 property 1 required
InvalidPaymentIntentIdentifierResponse
object
6 properties 6 required
NoLinkedAccountFoundResponse
object
6 properties 6 required
LinkedAccountWidgetErrorResponse
UnexpectedWidgetErrorResponse
object
6 properties 6 required
GetWalletWidgetDataV2Response
object
1 property 1 required
WalletWidgetV2ErrorResponse
FindWalletWidgetDataV2Response
object
1 property 1 required
WidgetSession
object
Widget Session
3 properties 3 required
CreateWidgetSessionResponse
object
1 property 1 required
WidgetSessionValidationErrorResponse
object
6 properties 6 required
CreateWidgetSessionRequest
object
1 property 1 required
SweepstakesRequestInvalidResponse
object
6 properties 6 required
SweepstakesNotFoundResponse
object
6 properties 6 required
AddSweepstakesResultsErrorResponse
UnexpectedSweepstakesErrorResponse
object
6 properties 6 required
SweepstakesResults
object
SweepstakesResults
3 properties 3 required
RewardResponse
object
Unified reward resource for both immediate wallet credits and pre-issued rewards awaiting claim.
3 properties 3 required
IssueRewardResponse
object
1 property 1 required
InvalidRewardRequestResponse
object
6 properties 6 required
IssueRewardWalletNotFoundResponse
object
6 properties 6 required
MultipleActiveWalletsResponse
object
6 properties 6 required
IssueRewardErrorResponse
WalletNotIssuableResponse
object
6 properties 6 required
PreIssuedConflictResponse
object
6 properties 6 required
IdempotencyConflictResponse
object
6 properties 6 required
IssueRewardConflictResponse
IssueRewardUnexpectedErrorResponse
object
6 properties 6 required
IssueRewardRequest
object
Request to issue a reward to a phone number.
2 properties 2 required
ListIssuedRewardsResponse
object
2 properties 2 required
RewardLookupUnexpectedErrorResponse
object
6 properties 6 required
GetIssuedRewardByIdResponse
object
1 property 1 required
UpdateRewardResponse
object
1 property 1 required
RewardNotFoundResponse
object
6 properties 6 required
InvalidRewardStateResponse
object
6 properties 6 required
RewardManagementUnexpectedErrorResponse
object
6 properties 6 required
UpdateRewardRequest
object
Request to update a reward when canUpdate is true (pre-issued rewards in Created status). At least one attribute must be provided.
2 properties 2 required
Gift
object
A gift remaining-balance lookup.
3 properties 3 required
GetGiftByLookUpIdResponse
object
1 property 1 required
GiftLookUpIdExpiredOrInvalidResponse
object
6 properties 6 required
GiftNotFoundResponse
object
6 properties 6 required
Kyc
object
KYC verification status for a user
3 properties 3 required
CreateKycApplicationResponse
object
1 property 1 required
UserNotFoundForBankingResponse
object
6 properties 6 required
InvalidRequestResponse
object
6 properties 6 required
KycApplicationFailedResponse
object
6 properties 6 required
InvalidUuidSyntaxForBankingResponse
object
6 properties 6 required
CreateKycApplicationErrorResponse
UnexpectedErrorForBankingResponse
object
6 properties 6 required
GetKycStatusResponse
objectnull
1 property 1 required
KycStatusNotFoundResponse
object
6 properties 6 required
GetKycStatusErrorResponse
DocumentVerificationLink
object
A secure link for users to complete document verification
3 properties 3 required
GetDocumentVerificationLinkResponse
object
1 property 1 required
DocumentVerificationFailedResponse
object
6 properties 6 required
GetDocumentVerificationLinkErrorResponse
CompleteDocumentVerificationResponse
objectnull
1 property 1 required
CompleteDocumentVerificationErrorResponse
CounterpartyExternalBankAccount
object
The payee's own bank account for settlement.
3 properties 3 required
CounterpartyInternalBankAccount
object
The Accrue bank account associated with this counterparty. Present only when a dedicated Accrue deposit account has been provisioned. Use these details to send…
3 properties 3 required
Counterparty
object
A counterparty represents a payee. externalBankAccount is the payee's own bank account for settlement. Top-level accountNumber / routingNumber / accountType st…
3 properties 3 required
CreateCounterpartyResponse
object
1 property 1 required
CounterpartyValidationErrorResponse
object
6 properties 6 required
CounterpartyAlreadyExistsResponse
object
6 properties 6 required
UnexpectedCounterpartyErrorResponse
object
6 properties 6 required
ListCounterpartiesResponse
object
1 property 1 required
UnauthorizedForCounterpartiesResponse
object
6 properties 6 required
GetCounterpartyResponse
object
1 property 1 required
CounterpartyNotFoundResponse
object
6 properties 6 required
UpdateCounterpartyResponse
object
1 property 1 required
CounterpartyHasBalanceResponse
object
6 properties 6 required
CounterpartyPayout
object
A payout represents a transfer of funds from a counterparty's available balance to their bank account.
3 properties 3 required
PayoutFromCounterpartyResponse
object
1 property 1 required
InsufficientBalanceResponse
object
6 properties 6 required
CreateCounterpartyPayoutErrorResponse
ListCounterpartyPayoutsResponse
object
2 properties 2 required
CounterpartyTransfer
object
A counterparty transfer represents a movement of funds between two counterparties.
3 properties 3 required
CreateCounterpartyTransferResponse
object
1 property 1 required
CounterpartyTransferValidationResponse
object
6 properties 6 required
CrossTenantCounterpartyTransferResponse
object
6 properties 6 required
CounterpartyNotFoundOnCreateResponse
object
6 properties 6 required
ListCounterpartyTransfersResponse
object
2 properties 2 required
CounterpartyTransferQueryValidationErrorResponse
object
6 properties 6 required
GetCounterpartyTransferResponse
object
1 property 1 required
CounterpartyTransferNotFoundResponse
object
6 properties 6 required
GetLinkedAccountsResponse
object
1 property 1 required
LinkedAccountInvalidUserResponse
object
6 properties 6 required
LinkedAccountUserNotFoundResponse
object
6 properties 6 required
UnexpectedLinkedAccountErrorResponse
object
6 properties 6 required
ExternalTransactionReference
object
ExternalTransactionReference
4 properties 4 required
AddExternalTransactionResponse
object
1 property 1 required
ExternalTransactionValidationErrorResponse
object
6 properties 6 required
UnexpectedExternalTransactionErrorResponse
object
6 properties 6 required
CreateExternalTransaction
object
Create external transaction request
2 properties 2 required
ExternalTransaction
object
ExternalTransaction
4 properties 4 required
GetExternalTransaction
object
1 property 1 required
ExternalTransactionNotFoundResponse
object
6 properties 6 required
ListExternalTransactionsResponse
object
2 properties 2 required
Webhook
object
3 properties 3 required
WebhookResponse
object
1 property 1 required
InvalidWebhookTopicsResponse
object
6 properties 6 required
WebhookValidationErrorResponse
object
6 properties 6 required
WebhookErrorResponse
CreateWebhook
object
Create webhook request
2 properties 2 required
GetWebhookResponse
object
1 property 1 required
WebhookNotFoundResponse
object
6 properties 5 required
WebhooksResponse
object
1 property 1 required
UpdateWebhook
object
Update webhook request
2 properties 2 required
WebhookEvent
object
4 properties 4 required
WebhookPaymentIntent
object
PaymentIntent entity as stored in webhook payload
3 properties 3 required
WebhookPayment
object
Payment entity as stored in webhook payload (includes walletId/userId from PaymentIntent). All Prisma Payment fields may be present.
3 properties 3 required
WebhookRefund
object
Refund entity as stored in webhook payload. Includes charges/deductions via shared mapRefundCharges utility.
3 properties 3 required
WebhookCapture
object
Capture entity as stored in webhook payload (includes externalPayments)
3 properties 3 required
BankApplicationLite
object
Bank application data
11 properties 6 required
ApplicationCreatedEventAttributes
object
3 properties 3 required
WebhookKycCreated
object
KycCreated event data as stored in webhook payload
3 properties 3 required
ApplicationApprovedEventAttributes
object
2 properties 1 required
WebhookKycApproved
object
KycApproved event data as stored in webhook payload
3 properties 3 required
ApplicationBasicEventAttributes
object
2 properties 1 required
WebhookKycStatus
object
KYC status event data (KycDeclined, KycPending, KycAwaitingDocuments, KycManualReview) as stored in webhook payload
3 properties 3 required
TransactionEventAttributes
object
3 properties 2 required
WebhookTransactionCleared
object
TransactionCleared event data as stored in webhook payload
3 properties 3 required
WebhookTransactionFailed
object
TransactionFailed event data as stored in webhook payload
3 properties 3 required
CounterpartyIncomingPaymentEventAttributes
object
8 properties 8 required
WebhookCounterpartyIncomingPayment
object
CounterpartyIncomingPayment event data as stored in webhook payload
3 properties 3 required
CounterpartyPayoutEventAttributes
object
10 properties 10 required
WebhookCounterpartyPayout
object
Counterparty payout lifecycle event data (CounterpartyPayoutCreated, CounterpartyPayoutSent, CounterpartyPayoutCompleted) as stored in webhook payload
3 properties 3 required
WebhookCounterpartyPayoutReturned
object
CounterpartyPayoutReturned event data as stored in webhook payload
3 properties 3 required
WebhookIncluded
Polymorphic schema for webhook included resources. Uses discriminator on 'type' field for runtime deserialization.
ListWebhookEventsResponse
object
2 properties 1 required
WebhookEventQueryValidationErrorResponse
object
6 properties 6 required
GetWebhookEventResponse
object
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

accrue-savings-merchant-api-openapi.yaml Raw ↑
#Payments#Wallets#Rewards#Banking#Webhooks
← Back to A APIs
API Details
ID
accrue-savings:accrue-merchant-api
Base URL
https://merchant-api.accruesavings.com
Docs
https://docs.byaccrue.com/api/
Provider
Accrue Savings
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=accrue-savings-accrue-merchant-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/accrue-savings-accrue-merchant-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Accrue Merchant API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.