Skip to content

Cards partner API guide ​

The partner guide is now organized by integration task. Start with the cards partner API overview or make your first signed request.

Existing links to this page still open their corresponding topic below.

TopicCurrent guide
First requestFirst request
GraphiQLGraphiQL
AuthenticationAuthentication
CredentialsCredentials
API keyAPI key
HMAC signatureHMAC signature
Signing exampleSigning example
Verify your setupVerify your setup
API scopeAPI scope
Available operationsAvailable operations
Supported operationsSupported operations
ThrottlingThrottling
OnboardingOnboarding
Customer organizationCustomer organization
Cardholder provisioningCardholder provisioning
Correct cardholder detailsCorrect cardholder details
Submit an applicationSubmit an application
Agreement acceptanceAgreement acceptance
Agreement documentsAgreement documents
Application statusApplication status
WebhooksWebhooks
Subscribed eventsSubscribed events
Collateral eventsCollateral events
SubscribeSubscribe
Receiver requirementsReceiver requirements
Event payloadsEvent payloads
Nullable event fieldsNullable event fields
Webhook signaturesWebhook signatures
Test deliveryTest delivery
Deduplication and retriesDeduplication and retries
Webhook secret rotationWebhook secret rotation
Delivery historyDelivery history
UnsubscribeUnsubscribe
PIN and card-secret encryptionPIN and card-secret encryption
FundingFunding
Deposit addressDeposit address
Accepted collateral tokenAccepted collateral token
On-chain token balanceOn-chain token balance
Spending powerSpending power
Direct fundingDirect funding
Treasury fundingTreasury funding
Funding job statusFunding job status
WithdrawalWithdrawal
Available walletsAvailable wallets
Wallet balancesWallet balances
MultisendMultisend
Send a batchSend a batch
Bulk fundingBulk funding
Batch idempotencyBatch idempotency
Batch job statusBatch job status
Batch limitsBatch limits
Batch errorsBatch errors
Response envelopesResponse envelopes
Replacement cardsReplacement cards
Spending-limit frequencySpending-limit frequency
Service feesFunding
Read cardsRead cards
Live card balanceLive card balance
Cardholder card detailsCardholder card details
Freeze a cardFreeze a card
Cardholder recordsCardholder records
Monthly spendMonthly spend
ErrorsErrors
Error response examplesError response examples
Safe retriesSafe retries
Partner API changesPartner API changes

Collateral and payment events