Online Banking API
  1. Webhook Endpoints
Online Banking API
  • Online Banking API
    • Health
      • Health Check
      • Protected Health Check
    • Customers
      • Get all customers
      • Create a customer
      • Get a single customer
      • Update a customer
      • Delete a customer
      • Get ToS acceptance link
      • Get associated persons for a business customer (Beta)
      • Create a new associated person for a business customer (Beta)
      • Get KYC link
      • Get all transfers
      • Get a single associated person (Beta)
      • Update a single associated person
      • Delete a single associated person
      • Request a hosted URL for ToS acceptance for new customer creation
    • External Accounts
      • Get all External Accounts
      • Create a new External Account
      • Retrieve an External Account object
      • Update an External Account
      • Delete a single External Account object
      • Reactivate an External Account
    • Transfers
      • Get all transfers
      • Create a transfer
      • Get a transfer
      • Update a transfer
      • Delete a transfer
    • Prefunded Accounts
      • Get all Prefunded Accounts
      • Get a Prefunded Account
      • Get funding history of a Prefunded Account
    • Liquidation Addresses
      • Create a Liquidation Address
      • Get all Liquidation Addresses for a customer
      • Get a Liquidation Address
      • Update a Liquidation Address
      • Get drain history of a Liquidation Address
      • Get the balance of a Liquidation Address (deprecated)
    • Liquidation Address Drains
      • Liquidation Address Activity Across All Customers
    • Developers
      • Get the configured fees
      • Update the configured fees
      • Get the configured fee External Account
      • Configure a fee External Account
    • Plaid
      • Generate a Plaid Link token for a customer
      • Exchange Plaid public token for an access token
    • Virtual Accounts
      • Create a Virtual Account
      • List Virtual Accounts
      • Get a Virtual Account
      • Update a Virtual Account
      • Deactivate a Virtual Account
      • Reactivate a Virtual Account
      • Virtual Account Activity
      • Virtual Account Activity Across All Customers
    • Static Memos
      • Create a Static Memo
      • List Static Memos
      • Get a Static Memo
      • Update a Static Memo
      • Static Memo Activity
      • Static Memo Activity Across All Customers
    • Cards
      • Create Card PIN Update URL
      • Get all card accounts
      • Provision a card account
      • Place a freeze on the card account
      • Unfreeze the card account
      • Create a mobile wallet push provisioning request
      • Retrieve pending card authorizations
      • Retrieve card transactions
      • Create a funds withdrawal request
      • Retrieve the withdrawal history of funds
      • Retrieve a card transaction
      • Retrieve a card withdrawal
      • Generate a card account statement
    • Webhooks
      • Get all webhook endpoints
      • Create a webhook endpoint
      • Update a webhook
      • Delete a webhook
      • List upcoming events
      • View logs
      • Send event
    • Lists
      • Get occupation codes
      • Get countries
    • Crypto Return Policies
      • Get all crypto return policies
      • Create a new crypto return policy
      • Update an existing crypto return policy
      • Delete a single crypto return policy object
    • Associated Persons
      • Get a single associated person (Beta)
      • Update a single associated person
      • Delete a single associated person
    • Lead Bank Wallets
      • Get all Lead Bank Wallets
      • Get total balances of all Lead Bank Wallets
      • Get transaction history for a Lead Bank Wallet
      • Get all Lead Bank Wallets for a customer
      • Create a Lead Bank Wallet
      • Get a Lead Bank Wallet
    • Batch Settlements
      • Create a Batch Settlement Schedule
    • KYC Links
      • Generate the Links needs to complete KYC for an individual or business
      • Get all KYC links
      • Check the status of a KYC link
    • Exchange Rates
      • Get current exchange rate between two currencies
    • V2 Quotes
      • Create a new quote
      • Get FX Rate
    • V2 Payouts
      • Retrieve Payout
      • Retrieve Payout Track
      • Retrieve Payouts
      • Export Payouts
      • Authorize Token on Stellar Wallet
      • Create Payout on Stellar
      • Create Payout on EVM Chains
    • V2 Virtual Accounts
      • Create Virtual Account
      • Retrieve Virtual Account
      • Update Virtual Account
    • V2 Receivers
      • Create Receiver
      • Get Receivers
      • Get Receiver
      • Update Receiver
      • Delete Receiver
      • Get Receiver Limits
    • V2 Blockchain Wallets
      • Get blockchain wallet sign message
      • Add blockchain wallet
      • Retrieve blockchain wallets for a receiver
      • Delete blockchain wallet
      • Create asset trustline
      • Mint USDB on Stellar
    • Payins
      • Retrieve Payin
      • List Payins
      • Export Payins
      • Create Payin on EVM Chains
      • Retrieve Payin Track
    • Payin Quotes
      • Create Payin Quote
      • Get FX Rate
    • Partner Fees
      • Create Partner Fee
      • List Partner Fees
      • Get Partner Fee
      • Delete Partner Fee
    • Bank Accounts
      • Add Bank Account
      • Get Bank Accounts
      • Get Bank Account
      • Delete Bank Account
    • Available
      • Retrieve bank details by rail
      • Retrieve available rails
    • Instances
      • Update Instance
      • Delete Instance
      • Retrieve Instance Members
      • Delete Member from Instance
      • Update Instance Member Role
    • API Keys
      • Create API Key
      • Get API Keys
      • Get API Key
      • Delete API Key
      • Initiate Terms of Service
      • Accept Terms of Service
    • Webhook Endpoints
      • Register Webhook Endpoint
        POST
      • Get Webhook Endpoints
        GET
      • Delete Webhook Endpoint
        DELETE
      • Get Webhook Endpoint Secret
        GET
      • Get Webhook Portal Access URL
        GET
      • Receive webhooks from Privy
        POST
      • Receive webhooks from DTR
        POST
    • V3 Entities
      • Create Personal Entity
      • Create Business Entity
      • Finalize Entity
      • Update Business Entity
      • Create Representative
      • Update Representative
      • Delete Representative
      • Get Entity Required Fields
      • Get Representative Required Fields
      • Get Organization Entities
      • Get Verified Organization Entities
      • Get User Entities
      • Get Single Entity (admin only)
      • Get Entities Page
      • Upload document for entity
      • Upload document for representative
    • V3 Virtual Accounts
      • Create Virtual Account
      • Get Organization Virtual Accounts Page
    • V3 Users
      • Create V3 User
      • Get Current V3 User
      • Get Organization Users
    • V3 Wallets
      • Create Wallet
      • Add Balance to Wallet (Sandbox Only)
      • Get Wallet Funding Instructions
      • Get Organization Entity Wallets
      • Get Entity Wallets
      • Get Wallet
    • V3 Beneficiaries
      • Create Personal Beneficiary
      • Create Business Beneficiary
      • Update Personal Beneficiary
      • Update Business Beneficiary
      • Get Resource Corridors
      • Get Beneficiary Required Fields
      • Get Beneficiaries Page
      • Get Entity Beneficiaries
      • Get Single Beneficiary
    • V3 Transfers
      • Create Transfer
      • Create Wallet Transfer
      • Finalize Transfer
      • Finalize Wallet Transfer
      • Get Transfer Quote
      • Update Transfer
      • Sandbox: Change Transfer State
      • Get Transfer Receipt
      • Get Transfers Page
      • Get Single Transfer
      • Get Incoming Transfers Page
    • V3 Rates
      • Get Mid Market Rate
      • Get Current Rate
    • V3 Webhooks
      • Create Webhook Subscription
      • Disable Webhook Subscription
    • V3 Find Bank
      • Find Bank
    • Schemas
      • TransbridgeErrorResponse
      • CustomerDto
      • CustomersListResponseDto
      • AddressDto
      • IdentifyingInformationDto
      • CreateCustomerDto
      • CreateAssociatedPersonDto
      • ExternalAccountDto
      • ExternalAccountsListResponseDto
      • IbanDto
      • AccountDto
      • SwiftDto
      • ClabeDto
      • CreateExternalAccountDto
      • UpdateExternalAccountDto
      • SourceOrDestinationDto
      • ReceiptDto
      • SourceDepositInstructionsDto
      • ReturnDetailsDto
      • TransferDto
      • TransfersListResponseDto
      • SourceOrDestinationCreateDto
      • CreateTransferDto
      • UpdateTransferDto
      • PrefundedAccountDto
      • PrefundedAccountsListResponseDto
      • PrefundedAccountHistoryDto
      • PrefundedAccountHistoryListResponseDto
      • CreateLiquidationAddressDto
      • LiquidationAddressDto
      • LiquidationAddressesListResponseDto
      • UpdateLiquidationAddressDto
      • DrainDestinationDto
      • DrainReturnDetailsDto
      • DrainReceiptDto
      • DrainDto
      • DrainsListResponseDto
      • LiquidationAddressBalanceDto
      • LiquidationAddressBalanceResponseDto
      • AllDrainsListResponseDto
      • DeveloperFeesResponseDto
      • DeveloperFeesRequestDto
      • FeeExternalAccountResponseDto
      • FeeExternalAccountRequestDto
      • PlaidLinkTokenResponseDto
      • PlaidExchangePublicTokenRequestDto
      • PlaidExchangePublicTokenResponseDto
      • VirtualAccountSourceDto
      • VirtualAccountDestinationDto
      • CreateVirtualAccountRequestDto
      • CreateVirtualAccountResponseDto
      • ListVirtualAccountsResponseDto
      • GetVirtualAccountResponseDto
      • UpdateVirtualAccountDestinationDto
      • UpdateVirtualAccountRequestDto
      • VirtualAccountHistoryResponseDto
      • StaticMemoSourceDto
      • StaticMemoDestinationDto
      • CreateStaticMemoRequestDto
      • CreateStaticMemoResponseDto
      • ListStaticMemosResponseDto
      • GetStaticMemoResponseDto
      • UpdateStaticMemoDestinationDto
      • UpdateStaticMemoRequestDto
      • StaticMemoHistoryResponseDto
      • CreateCardPinUpdateUrlResponseDto
      • CardDetailsDto
      • BalanceAmountDto
      • BalancesDto
      • FreezeDto
      • CryptoAccountDto
      • FundingInstructionsDto
      • GetCardAccountResponseDto
      • ListCardAccountsResponseDto
      • CryptoAccountRequestDto
      • ProvisionCardAccountRequestDto
      • PlaceFreezeRequestDto
      • PlaceFreezeResponseDto
      • UnfreezeCardRequestDto
      • UnfreezeCardResponseDto
      • ApplePayProvisioningRequestDto
      • GooglePayProvisioningRequestDto
      • CreateMobileWalletProvisioningRequestDto
      • ApplePayProvisioningResponseDto
      • GooglePayProvisioningResponseDto
      • CreateMobileWalletProvisioningResponseDto
      • LocalTransactionDetailsDto
      • DetailsDto
      • PendingCardAuthorizationDto
      • GetPendingCardAuthorizationsResponseDto
      • CardTransactionDto
      • GetCardTransactionsResponseDto
      • WithdrawalDestinationDto
      • CreateFundsWithdrawalRequestDto
      • WithdrawalDestinationResponseDto
      • GasFeeDto
      • CreateFundsWithdrawalResponseDto
      • GetCardTransactionResponseDto
      • FundsWithdrawalDto
      • GetFundsWithdrawalHistoryResponseDto
      • GetFundsWithdrawalResponseDto
      • BridgeErrorResponse
      • WebhookEndpointDto
      • ListWebhooksResponseDto
      • CreateWebhookEndpointDto
      • CreateWebhookEndpointResponseDto
      • UpdateWebhookEndpointDto
      • WebhookEventDto
      • ListUpcomingEventsResponseDto
      • WebhookLogDto
      • ListWebhookLogsResponseDto
      • SendEventDto
      • SendEventResponseDto
      • OccupationCodeDto
      • SubdivisionDto
      • CountryDto
      • ListCountriesResponseDto
      • CryptoReturnPolicyDto
      • CreateCryptoReturnPolicyDto
      • UpdateCryptoReturnPolicyDto
      • AssociatedPersonDto
      • UpdateAssociatedPersonDto
      • BridgeWalletDto
      • BridgeWalletsListResponseDto
      • BridgeWalletTotalBalanceDto
      • BridgeWalletTransactionDto
      • BridgeWalletHistoryListResponseDto
      • CreateBridgeWalletDto
      • BridgeWalletBalanceDto
      • BridgeWalletDetailsDto
      • CreateBatchSettlementScheduleDto
      • BatchSettlementScheduleDto
      • CreateKycLinkDto
      • KycRejectionReasonDto
      • KycLinkDto
      • KycLinksListResponseDto
      • ExchangeRateResponseDto
      • CreateQuoteDto
      • QuoteResponseDto
      • GetFxRateDto
      • GetFxRateResponseDto
      • TrackingTransactionDto
      • TrackingPaymentDto
      • TrackingLiquidityDto
      • TrackingCompleteDto
      • TrackingPartnerFeeDto
      • PayoutResponseDto
      • PayoutsPaginationDto
      • ListPayoutsResponseDto
      • AuthorizeStellarDto
      • AuthorizeStellarResponseDto
      • CreateStellarPayoutDto
      • CreateStellarPayoutResponseDto
      • CreateEvmPayoutDto
      • CreateEvmPayoutResponseDto
      • CreateVirtualAccountDto
      • VirtualAccountACHDto
      • VirtualAccountWireDto
      • VirtualAccountRTPDto
      • VirtualAccountBeneficiaryDto
      • VirtualAccountReceivingBankDto
      • VirtualAccountUSDtos
      • UpdateVirtualAccountResponseDto
      • ReceiverOwnerDto
      • CreateReceiverDto
      • CreateReceiverResponseDto
      • ReceiverResponseDto
      • UpdateReceiverDto
      • UpdateReceiverResponseDto
      • ReceiverLimitsResponseDto
      • AddBlockchainWalletDto
      • BlockchainWalletResponseDto
      • SuccessResponseDto
      • CreateAssetTrustlineBodyDto
      • CreateAssetTrustlineResponseDto
      • MintUsdbStellarBodyDto
      • PayinTrackingTransactionDto
      • PayinTrackingPaymentDto
      • PayinTrackingCompleteDto
      • PayinTrackingPartnerFeeDto
      • PayinBeneficiaryDto
      • PayinReceivingBankDto
      • PayinBankDetailsDto
      • PayinResponseDto
      • PayinsPaginationDto
      • ListPayinsResponseDto
      • CreateEvmPayinDto
      • PayerRulesDto
      • CreatePayinQuoteDto
      • CreatePayinQuoteResponseDto
      • CreatePartnerFeeDto
      • PartnerFeeResponseDto
      • DeletePartnerFeeResponseDto
      • CreateBankAccountDto
      • BankAccountResponseDto
      • DeleteBankAccountResponseDto
      • AvailableBankDetailsItemDto
      • AvailableBankDetailsDto
      • AvailableRailDto
      • UpdateInstanceDto
      • UpdateInstanceResponseDto
      • DeleteInstanceResponseDto
      • InstanceMemberDto
      • DeleteInstanceMemberResponseDto
      • UpdateInstanceMemberRoleDto
      • UpdateInstanceMemberRoleResponseDto
      • CreateApiKeyDto
      • CreateApiKeyResponseDto
      • ApiKeyDto
      • DeleteApiKeyResponseDto
      • InitiateTosDto
      • InitiateTosResponseDto
      • AcceptTosDto
      • AcceptTosResponseDto
      • RegisterWebhookEndpointDto
      • RegisterWebhookEndpointResponseDto
      • DeleteWebhookEndpointResponseDto
      • WebhookEndpointSecretResponseDto
      • WebhookPortalAccessResponseDto
      • PrivyWebhookDto
      • DtrWebhookDto
      • CreatePersonalEntityDto
      • RepresentativeInputDto
      • CreateBusinessEntityDto
      • FinalizeEntityDto
      • UpdateBusinessEntityDto
      • CreateRepresentativeDto
      • RepresentativeUpdateInputDto
      • UpdateRepresentativeDto
      • DeleteRepresentativeDto
      • EntityRequiredFieldsQueryDto
      • RepresentativeRequiredFieldsQueryDto
      • ListFilterDto
      • OrganizationEntitiesQueryDto
      • VerifiedOrganizationEntitiesQueryDto
      • UserEntitiesQueryDto
      • EntityQueryDto
      • PaginationInputDto
      • FilterInputDto
      • EntitiesPageDto
      • OrganizationVirtualAccountsPageDto
      • OrganizationVirtualAccountItemDto
      • OrganizationVirtualAccountsPaginationDto
      • OrganizationVirtualAccountsPageResponseDto
      • CreateUserDto
      • OrganizationUsersQueryDto
      • OrganizationDto
      • OrganizationUserDto
      • OrganizationUsersResponseDto
      • CreateWalletDto
      • AddBalanceToWalletDto
      • WalletFundingInstructionsDto
      • WalletFundingInstructionsResponseDto
      • OrganizationEntityWalletsWalletDto
      • OrganizationEntityWalletsDto
      • OrganizationEntityWalletsResponseDto
      • EntityWalletsDto
      • EntityWalletsWalletDto
      • EntityWalletsResponseDto
      • WalletDto
      • WalletOrganizationDto
      • WalletEntityDto
      • WalletResponseDto
      • CreateBeneficiaryDto
      • CreateBusinessBeneficiaryDto
      • UpdatePersonalBeneficiaryDto
      • UpdateBusinessBeneficiaryDto
      • BeneficiaryRequiredFieldsDto
      • BeneficiariesPageDto
      • EntityBeneficiariesDto
      • BeneficiaryDto
      • CreateWalletTransferDto
      • FinalizeTransferDto
      • FinalizeWalletTransferDto
      • GetTransferQuoteDto
      • ChangeTransferStateDto
      • TransferReceiptDto
      • TransfersPageDto
      • IncomingTransfersPageDto
      • GetMidMarketRateDto
      • GetMidMarketRateResponseDto
      • GetRateDto
      • GetRateResponseDto
      • CreateWebhookSubscriptionDto
      • DisableWebhookSubscriptionDto
      • FindBankDto
      • FindBankResponseDto
  1. Webhook Endpoints

Get Webhook Portal Access URL

GET
/v1/instances/{instance_id}/webhook-endpoints/portal-access

Request

Authorization
Path Params

Responses

🟢200
application/json
Get webhook portal access url
Body

Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://online-banking.originalaccounts.com/v1/instances//webhook-endpoints/portal-access'
Response Response Example
{
    "url": "http://example.com"
}
Modified at 2025-12-19 15:30:02
Previous
Get Webhook Endpoint Secret
Next
Receive webhooks from Privy
Built with