Copy Page
Framnex for Developers
Introduction
Overview
Quick Start
Authentication
Environments
Guides
Onboard a client
Open an account
Create an outgoing transfer
Handle webhooks
Accounts
Open account
List accounts
Get account
Auth
Get access token
Clients
Create client
List clients
Get client creation schema
Get client
Get client state
Transfers
Create transfer
List transfers
Get transfer
Webhooks
Register webhook URL
Get webhook URL
List webhook deliveries
Get webhook delivery
Retry webhook delivery
Cards
List card products
List cardholders
Issue card
List cards
Get card
Activate card
Freeze card
Unfreeze card
Close card
Set card limits
Create encryption envelope
Reveal card details
Set PIN
Card Transactions
List card transactions
Get card transaction
Exchange Rates
Get exchange rate
Incoming Transfers
Simulate incoming transfer
Transfer Documents
Download document
List documents
Upload documents
Schemas
BaaS API
Account
AccountCredentials
AccountOpenedWebhookPayload
AccountOpeningFailedWebhookPayload
AccountPagedDataDto
AccountState
AccountType
AchCredentials
Address
AuthTokenRequest
AuthTokenResponse
BankDetails
BusinessClient
BusinessEntity
Client
CreateBusinessClientRequest
ClientCreateType
CreateClientRequest
ClientCreatedResponse
ClientPagedDataDto
CreateIndividualClientRequest
ClientState
ClientStateResponse
ClientType
ClientsFilter
CreateAccountRequest
CreateExchangeTransferRequest
CreateIncomingTransferRequest
CreateOutgoingTransferRequest
CredentialsState
CreateTransferRequest
ExchangeRate
CreateTransferType
CreatedResponse
Credentials
CredentialsIssueFailedWebhookPayload
CredentialsIssuedWebhookPayload
ExchangeTransferProcessingWebhookPayload
CryptoCredentials
IError
CryptoTransferDetails
IReason
DocumentDto
ISuccess
EmptyResponse
ErrorDetailsDto
IdentificationDocument
IdentificationDocumentType
ExchangeTransfer
ExchangeTransferCancelledWebhookPayload
ExchangeTransferExecutedWebhookPayload
FasterUkCredentials
FedWireCredentials
ForeignTransferParty
GasPaymentWebhookPayload
IncomingTransfer
IncomingTransferReceivedWebhookPayload
OutgoingTransferProcessingWebhookPayload
IndividualClient
IndividualEntity
LegalEntity
InternalCredentials
Participant
LegalEntityType
LocalAEDCredentials
LocalXafCredentials
NeftCredentials
Result
OnboardingCompletedWebhookPayload
OutgoingTransfer
RiskLevel
OnboardingFailedWebhookPayload
OutgoingTransferCancelledWebhookPayload
PageInfoDto
OutgoingTransferExecutedWebhookPayload
TransferPagedDataDto
PagedFilterDto
PaymentMethod
ProblemDetails
TransfersFilter
PixCredentials
RegisterWebhookRequest
WebhookDelivery
SortOrderDto
WebhookDeliveryPagedDataDto
SepaCredentials
SortDto
Transfer
WebhookSubscription
SwiftCredentials
TedPayCredentials
WebhooksFilter
TransferDetails
TransferDetailsType
TransferGas
TransferState
TransferType
ValidationProblemDetails
UaeFtsCredentials
UaeIppCredentials
WebhookPayload
WebhookState
WebhookType
YeePayKesLocalCredentials
YeePayMxnLocalCredentials
YeePayNgnLocalCredentials
CardProduct
Cardholder
IssueCardRequest
Card
CardType
CardState
CardPagedDataDto
CloseCardRequest
SetCardLimitsRequest
CardEncryptionEnvelope
CardEncryptedDetailsRequest
CardEncryptedDetails
SetCardPinRequest
CardTransaction
CardTransactionState
CardTransactionPagedDataDto
CardNetwork
CardIssuanceFee
CardShipping
CardSpendingLimit
CardLimitInterval
CardCloseReason
CardSecretType
CardEncryptedValue
CardMerchant
CardWebhookType
CardWebhookPayload
CardIssuedWebhookPayload
CardIssuanceFailedWebhookPayload
CardStateChangedWebhookPayload
CardTransactionAuthorizedWebhookPayload
CardTransactionCompletedWebhookPayload
CardTransactionReversedWebhookPayload
Guides
BaaS API Reference
Bank Client API Reference
Guides
BaaS API Reference
Bank Client API Reference
CardWebhookType
Copy Page
Type of event a card webhook reports.
"cardIssued"