BTCPay Server and Korapay Integration
Demonstration of how apps are integrated in WEXTL workflow builder[4]
Build finance workflows between BTCPay Server and Korapay on a visual canvas. Set up data fields sync between apps once and let data flow when events come automatically. Integration will work without code and your team will see the workflow inside WEXTL® builder.
- 3-day trial
- Cancel anytime
- Up to 10 minutes quick set up
- GDPR
- Data Encryption
- 2FA
- Local Data Region
Learn about BTCPay Server and Korapay
Detailed info you need to know about BTCPay Server and Korapay integrations in WEXTL. Explore which modules apps support and how you connect them.
BTCPay Server

Self-hosted Bitcoin payments: invoices, payment requests, payouts, stores, webhooks and lightning.[5]
Korapay

Payments for cards, bank transfers, payouts, and virtual accounts.[6]
How to connect BTCPay Server to Korapay
Set up your BTCPay Server and Korapay integration in 3 simple steps[2]. No coding required. Up to 10 minutes setup.
STEP 1
Connect BTCPay Server and Korapay
Save credentials in WEXTL once. We store them encrypted and reuse the authorization across every workflow[3]. No coding or API skills required.
STEP 2
Build a workflow
Paste selected BTCPay Server and Korapay nodes onto the canvas[4], or describe what you want and WEXTL wires the flow together with AI Builder.
STEP 3
Map your data
Choose which fields need to sync between BTCPay Server and Korapay. Use filters or a JS custom code step in between. Everything is on the canvas.
How does the integration between BTCPay Server and Korapay work in WEXTL?
WEXTL exposes actions and triggers for BTCPay Server and Korapay that help you connect apps and automate repetitive tasks[1]. A trigger is an event that happens, and an action is a step that performs when the event has occurred.
BTCPay Server triggersKorapay actions
BTCPay Server modules
- Watch Events Fires instantly when BTCPay Server posts a webhook event. Each run has the Event Type and Delivery ID.
- Activate an Invoice Payment Method Turns on one payment method of an invoice, such as BTC-CHAIN or BTC-LN, for payment.
- Add a Store User Gives a user access to a store through a Role. Name the user by id or email, and turn on Require Invitation to send an invitation first.
- Approve a Payout Approves a pending payout. Use Revision to guard against edits made meanwhile and Rate Rule to convert with a custom rate. A failed approval is not retried automatically.
- Approve a User Approves a user account on the server. Turn off Approved to withdraw an approval again.
- Archive a Payment Request Archives a payment request of a store so it is taken out of the active ones.
- Archive a Pull Payment Stops further claims on a pull payment by archiving it.
- Archive an Invoice Hides an invoice from the default invoice lists.
- Broadcast a Wallet Transaction Sends a signed Transaction in raw form to the network through the on-chain Payment Method of a store. Failures here are not retried automatically.
- Cancel a Payout Cancels a payout that has not been sent yet.
- Cancel a Store Invitation Withdraws a pending invitation to a store.
- Connect to a Lightning Peer Joins a Lightning node, either the server node or a store node, to another peer. Write the peer address as nodeid@host:port.
- Create a Lightning Invoice Creates a BOLT11 invoice on a Lightning node for an Amount (millisats). Use Expiry (seconds) to set its lifetime and Private Route Hints to include private channels.
- Create a Payment Request Issues a request for payment in a store using a Title and an Amount. Add an Expiry Date, a Reference ID or Allow Custom Payment Amounts.
- Create a Pull Payment Sets up a pull payment of a total Amount in a Currency. Use Payout Methods to limit how claims are paid and Auto Approve Claims to skip manual approval. A failed setup is not retried automatically.
- Create a Pull Payment Payout Claims a payout against a pull payment, sent to a Destination through a Payout Method ID. Leave Amount empty to claim the rest. A failed claim is not retried automatically.
- Create a Store Starts a store named Name. Set Website, Default Currency or Brand Color to shape how it looks and behaves.
- Create a Store Payout Queues a payout out of store funds to a Destination for an Amount. Turn on Approved to approve it at once, or attach it to a Pull Payment ID. A failed attempt is not retried automatically.
- Create a User Creates an account from an Email. Use Password to set one, Is Administrator for admin rights and Send Invitation Email to invite the user.
- Create a Wallet Transaction Builds an on-chain transaction to Destinations. By default it signs and BROADCASTS it, which spends funds. Turn off Broadcast to avoid sending. A failed run is not retried automatically.
- Create a Webhook Makes BTCPay Server call an Endpoint URL when store events occur. Use Events to restrict which, and Secret to sign every delivery.
- Create an API Key Makes an API key for your own account. Use Label to name it and Permissions to restrict what it can do. You read the API Key value once.
- Create an API Key for a User Makes an API key on behalf of another user. Use Label to name it and Permissions to limit the access it grants.
- Create an App Attaches an app to a store under an App Name, of a chosen App Type. Use Notification URL to receive payment notices.
- Create an Invoice Issues an invoice in a store for an Amount and Currency. Set Buyer Email to tie it to a customer and Order ID to match your own order. If the run fails, it is not retried automatically.
- Create an Offering Adds a subscription offering to a store under a Name. Use Features for a JSON list and Success Redirect URL to send customers elsewhere after signing up.
- Create an Offering Plan Adds a plan to a subscription Offering with a Name, Price and Currency. Use Recurring Type to set the renewal cycle and Trial Days for a free start.
- Delete a File Deletes an uploaded file on BTCPay Server.
- Delete a Notification Removes one notification from your inbox.
- Delete a Store Removes a store from BTCPay Server.
- Delete a Store Payment Method Disconnects a payment option from your store.
- Delete a Subscriber Deletes one subscriber of an offering. Use Customer Selector to say which.
- Delete a User Deletes a BTCPay Server user account.
- Delete a Webhook Detaches a webhook from a store.
- Delete an App Deletes an app from a store in BTCPay Server.
- Delete the Current User Deletes the account of the user that owns the credential. Turn on Confirm Deletion to proceed.
- Get a File Reads an uploaded file with its Original Name and URL.
- Get a Lightning Address Reads a Lightning address of a store by Username. You see its Min, Max and Invoice Metadata.
- Get a Lightning Deposit Address Generates an on-chain Address that tops up a Lightning node.
- Get a Lightning Invoice Reads an invoice from a Lightning node by Lightning Invoice ID, including its BOLT11 string and a Status that tells whether it was paid.
- Get a Lightning Node Balance Reads how much funds a Lightning node holds, split into two parts by Onchain and Offchain.
- Get a Lightning Node Info Reads a Lightning node and its Alias, Version, Block Height and Peers Count.
- Get a Lightning Payment Fetches one payment of a Lightning node by Payment Hash. It shows the Status and Preimage.
- Get a Notification Opens one notification from your inbox with its Type, Body and Link.
- Get a Payment Request Retrieves a payment request with its Title, Amount and Expiry Date.
- Get a Payout Checks a payout and shows its Destination, Revision and Original Currency.
- Get a Pull Payment Loads a pull payment with its Amount, Currency and BOLT11 Expiration.
- Get a Pull Payment LNURL Gives the LNURL for a pull payment in two forms, LNURL Bech32 and LNURL URI.
- Get a Pull Payment Payout Reads a single payout that was claimed against a pull payment, with its Destination and Date.
- Get a Rate Configuration Shows how a store converts rates, with the Spread, the Preferred Source and the Effective Script.
Korapay modules
- Authorize a Card Completes a card charge that you started earlier, with the Transaction Reference of the first charge. Use PIN, OTP or AVS to match the Auth model of that charge.
- Bank Transfer Creates a bank transfer payment from an Account name and an Amount. You can also send a Currency, a Reference or Customer details. Output includes the Bank account.
- Charge a Card Takes a card payment from a customer. Use Charge data to send the encrypted details Korapay requires for the charge. Output includes the Auth model.
- Charge a Voucher Takes a payment from a voucher, described by its PIN, Phone Number and Provider Code. Set a Notification URL to receive payment updates.
- Complete an Exchange Rate Conversion Finalizes a currency conversion from its Rate Reference by converting an Amount between From Currency and To Currency. Provide the Customer Name of whoever started it, and a Narration to describe it.
- Create a Card Creates a virtual USD card funded with an initial Amount for an existing Cardholder Reference. Use Brand to pick visa or mastercard.
- Create a Cardholder Registers a person who can hold Korapay cards. Provide their First name, Last name, Email, Phone number, Gender, Date of birth, Selfie reference, Country identity, Identity and Address. Output includes the Reference and Validation status.
- Create a Virtual Account Opens a virtual bank account under an Account name and Account reference. Turn on Permanent for a permanent account, add a Bank code, and supply Customer or KYC details such as a BVN. Output includes the Account number and Bank name.
- Create a Virtual Account Holder Registers a holder for virtual bank accounts from a First name, Last name and Use case. Add Identification, Proof of address and Selfie details, plus Address and Employment, to build out the profile.
- Credit a Sandbox Virtual Bank Account Adds test funds to a sandbox virtual bank account. Give its Account number, an Amount and a Currency.
- Disburse to Multiple Bank Accounts Starts a bulk payout in one request, with one entry per recipient under Payouts. Give the batch a Batch Reference and Description, and enable Merchant Bears Cost to cover the payout cost yourself.
- Fund a Card Adds money to a card for a given Amount, with an optional Description.
- Generate a File Upload URL Creates a link for uploading a file to Korapay. Describe the file with a Reference, a Purpose and a Content type such as image/jpeg.
- Get a Card Retrieves a card and its Brand, Balance, Expiry month, Expiry year and Status.
- Get a Cardholder Reads a single cardholder with their Status, Phone number, Address and Identity.
- Get a Conversion Fetches one exchange rate conversion, including the Converted amount, Status, Channel and Transaction date.
- Get a Refund Looks up one refund and its Status, Amount and Reason. Output also includes the Payment reference of the original payment.
- Get a Virtual Account Reads a virtual bank account with its Account number, Bank name, Account status and Customer.
- Get a Virtual Account Holder Pulls a virtual account holder with their Status, Occupation, Address and Documents.
- Get Balances Shows the balances of your Korapay account, listed as Ngn and Usd.
- Get Virtual Account Transactions Gets transactions on a virtual account number, showing Reference, Status, Amount, Fee and Payer bank account.
- Initiate a Refund Refunds a payment from its Payment reference, under a new Reference of your choosing for the refund. Use Amount for a specific refunded sum, Reason to record why, and Webhook URL for notifications.
- Initiate an Exchange Rate Conversion Requests a quote for converting money between currencies, tagged with your Reference. Add From currency, To currency and Amount to price a specific conversion.
- List Balance History Shows balance movements with their Amount, Balance before, Balance after and Direction. Use Limit to cut the history to a set number of entries.
- List Banks Lists the banks Korapay supports with their Name, Code and Nibss bank code. Use Country code to see the banks of one country.
- List Card Transactions Fetches transactions performed with a card, each with its Amount, Fee, Type, Status and Balance after. Use Limit to cap how many rows return.
- List Cardholders Retrieves cardholders with their Status, Email, Phone number and Identity. Set Limit to return fewer cardholders.
- List Cards Returns cards with their Brand, Balance and Status. Filter by Start date and End date, or by Status, and cap the number with Limit.
- List Conversions Pulls exchange rate conversions along with their Source currency, Destination currency and Status. Pass Date From and Date To to restrict the date range.
- List Payment Refunds Gets refunds along with the Reason for each. Narrow the results by Currency, Status, Date From and Date To.
- List Payouts Lists payouts, each with its Reference, Status, Fee, Payment destination and Customer email. Use Limit to control how many are returned.
- Make an API Call Makes an authorized free-form request to the Korapay REST API with your saved credential.
- Resend an OTP Sends a new one-time password for a card charge. Use Transaction Reference to say which charge it belongs to.
- Resolve a Bank Account Looks up the holder of a bank account from its Bank and Account values. The Account name is in the output.
- Resolve Mobile Money Looks up the Account name for a mobile money number, from its Mobile Money Code, Phone Number and a Currency of GHS or KES.
- Single Payout to Bank Account Pays out to one bank account. Provide the Amount, Customer and Bank Account details, set the Currency, and add a Narration or a Purpose of Payment for USD, GBP and other non-African currencies.
- Single Payout to Crypto Transfers money to a crypto wallet on a given Network and Destination Address, with a Reference, Amount, Currency and Customer.
- Single Payout to Mobile Money Delivers money to a mobile money number, for the Operator and Mobile Number of the recipient, in a Currency such as KES or GHS. Add a Narration if you want a description.
- Single Remittance Payout to Bank Account Pays a bank account by remittance. Describe the sender with Sender nationality, Sender date of birth and Sender phone number.
- Single Remittance Payout to Mobile Money Sends a mobile money remittance and records the sender through Sender name, Sender phone number and Sender ID type.
- Update a Cardholder Changes details of an existing cardholder, such as First name, Last name, Email, Phone number or Identity.
- Update a Virtual Account Holder Edits a virtual account holder with new Occupation, Nationality or Phone values and updated document details.
- Verify a Payout Transaction Checks the outcome of a payout using its Transaction reference, and shows its Status and Message.
- Watch Cards Scheduled check of your cards that emits each newly created one with its Reference, Brand and Status. Use Limit to set how many cards a cycle works on.
- Watch Conversions Polls for exchange rate conversions created since the last run and emits each, with its Exchange rate. Use Limit to decide how many one cycle handles.
- Watch Payment Refunds Catches refunds that appeared after the last cycle, each with its Reason and Payment reference. Use Limit to cap the refunds handled in one cycle.
- Watch Payouts Looks for payouts created since the previous check and fires once per payout, with its Reference, Fee and Payment destination. Set Limit for the number per cycle.
- Withdraw From a Card Withdraws money from a card, with the Reference of its funding transaction, an Amount and an optional Description.
Explore alternative integrations
There are other apps[9] supported by WEXTL that can be paired with BTCPay Server and Korapay integrations. Pick any from the list below if the current combination isn't the one you need.
Frequently asked questions
Common questions about connecting BTCPay Server and Korapay.
References
List of sources used to gather information about the BTCPay Server and Korapay integration.
- BTCPay Server and Korapay integration source code, module specs and credentials implementation.
- Our BTCPay Server and Korapay integration documentation, structured input and output parameters, scopes, and authentication methods.
- Official vendor API documentation for BTCPay Server and Korapay, used to verify field meanings, authentication flows, and anything our own specs don't fully capture.
- WEXTL® visual workflow builder, anonymized data from our technical support team.
- BTCPay Server integration information
- Korapay integration information
- WEXTL® Scheduling
- WEXTL® Pricing and Trial
- WEXTL® Apps Library
How we write our apps documentation
Explore how WEXTL® crafted BTCPay Server and Korapay integration page documentation. Used sources, the role of AI, and how the team validates the result.