Guide · Developers

Payment API integration: how it works and how to do it safely

A payment API lets your software move money, issue accounts or convert currency by sending requests to a provider. This guide explains the main types of payment and fintech API, how an integration runs from sandbox to go-live, and the controls that stop a retry, a webhook or a leaked key from turning into a loss.

The short answer

  • What it is. A payment API lets your software ask a provider to move money, issue an account or convert currency, and tells your software what happened.
  • The main types. Payment acceptance (gateways), payouts, accounts and virtual accounts, FX, open banking and stablecoin settlement. Most providers cover some of these, not all.
  • What makes an integration safe. Credentials kept on your server, an idempotency key on every request that moves money, verified webhooks, careful retries, daily reconciliation, and approval limits for people and for code.
  • How to start. Map your money flows, choose a provider that will onboard your company and covers your corridors, then build and break the integration in a sandbox before any real money moves.

What is a payment API?

An API (application programming interface) is a defined way for one piece of software to ask another to do something. A payment API is one whose job is moving money or the things around it: payments, accounts, currency conversion and status updates. Your software sends a request, such as “pay this supplier €4,200 from my EUR balance”, and the provider replies with a result and an identifier you can track.

What is a fintech API?

A fintech API is the wider family: any API that exposes a financial service. That includes payment APIs, but also account data, identity and business verification, card issuing, lending and investment services. The provider runs the regulated activity and the infrastructure behind it. Your software uses it through requests and responses, usually JSON over HTTPS.

What is payment integration?

Payment integration is the work of building payments into your own product or back office. Searches for payment integration API, API payment integration and financial API integration mostly mean the same thing: connecting your systems to a provider’s API so that payments run from your software rather than from a bank portal.

Types of payment and fintech API

TypeWhat it doesTypical callsWatch for
Payment acceptance (gateway)Takes payments from customers, usually by card or wallet, at a checkoutCreate a payment, confirm it, refund itHandling card data brings the card industry’s security standard into scope; disputes and chargebacks
PayoutsSends money to bank accounts, suppliers or contractors, domestically or abroadCreate a recipient, quote, send a payout, read its statusRecipient details, returns, cut-offs, the rail each payout uses
Accounts and virtual accountsIssues account details to receive money and identify who paidIssue an account, list balances, list incoming paymentsWhose name is on the account; how incoming money is matched
FX and quotesConverts between currenciesRequest a quote, lock it, convertThe margin over the mid-market rate and how long a quote lasts
Open bankingWith the customer’s consent, reads bank account data or starts a payment from a bank accountRequest consent, read transactions, initiate a paymentConsent flows; in the EU and UK these services are regulated
Stablecoin settlementMoves value on a blockchain in a currency-linked token, with ordinary money in and outConvert, send on-chain, convert backSupported networks, eligibility, and the Travel Rule for crypto-asset transfers

Business-to-business flows mostly use the payouts, accounts and FX types. Our guide to B2B payments covers the methods behind them, and cross-border transactions and payment rails explains the networks a payout travels on.

Integration methods

There are four common ways to integrate, and they differ in how much control you have and how much responsibility you take on.

  1. Hosted page or redirect. The provider’s page collects the payment details. Quickest to build, least control over the experience, and the smallest security scope for you.
  2. Embedded components. The provider’s fields or widgets sit inside your page, but the sensitive data goes straight to the provider.
  3. Direct API (server to server). Your backend calls the provider’s API. Most control and automation; you own more of the security and error handling.
  4. Plugins and connectors. Ready-made integrations for an accounting system, an ERP or an e-commerce platform. Fast if one exists for your stack, limited if your process is unusual.

For card payments the method matters for compliance. The PCI Security Standards Council says its data security standard applies to entities that store, process or transmit cardholder data, so letting a provider’s hosted page or fields handle card numbers can reduce how much of the standard applies to you. For payouts, accounts and FX there is no card data, and the direct API is the usual route.

How a payment API integration works, step by step

  1. Map your money flows. List what you pay, to whom, in which currencies and how often, and the events your systems need to hear about: a payout sent, returned or credited, a payment received.
  2. Choose a provider. Check that it will onboard a company like yours, covers your currencies and corridors, publishes its documentation, has a sandbox and explains how it is regulated and how it holds client money. Ask for pricing in writing.
  3. Get credentials and keep them on your server. API keys and secrets belong in a secrets store, never in a browser, a mobile app or a code repository. Give each key the least access it needs, and rotate keys when people leave.
  4. Build against the sandbox. Create recipients, request quotes, send test payouts and read their status until the flow works end to end.
  5. Make every money-moving request idempotent. Send a unique idempotency key with every request that creates or changes something, and store it with the payment in your own system. If a request times out, retry with the same key. The IETF is standardising this as the Idempotency-Key HTTP header, which lets methods such as POST be retried without causing a duplicate.
  6. Handle webhooks properly. A webhook is a message the provider sends when something changes. Verify each one’s signature before you trust it (many providers sign with HMAC), reply quickly and process the event in the background, and expect the same event more than once or out of order.
  7. Handle errors and retries. Separate errors you can retry (timeouts, rate limits) from ones you cannot (invalid details, insufficient funds). Retry with backoff and the same idempotency key; never resend a payment with a new key just because a response did not arrive.
  8. Reconcile every day. Store the provider’s identifiers and your own references for every payment, and match your records to the provider’s statements. Investigate anything that does not match before it ages.
  9. Add controls for people and for code. Approval limits, two-person approval above a threshold, alerts on new recipients, and limits on what an API key can do on its own.
  10. Go live gradually. Start with small real payments on your main route, watch the webhooks and the reconciliation, then raise volume.

Security checklist

Payment APIs move real money, so the usual API risks have direct costs. The OWASP API Security Top 10 (2023) is a useful map. On the consuming side, the points that matter most are:

  • Credentials. Keep keys server-side, restrict and rotate them, and never log them. Broken authentication is the second item on the OWASP list.
  • Authorisation inside your own app. Check that the user who asks for a payout may act on that account or recipient. Broken object-level authorisation is the first item on the OWASP list.
  • Sensitive business flows. Rate-limit and alert on unusual patterns: many new recipients, many payouts just under an approval limit. OWASP lists unrestricted access to sensitive business flows as API6:2023.
  • Webhooks and responses. Verify signatures, validate every field you use, and treat provider responses as input to check, not as trusted data. OWASP lists unsafe consumption of APIs as API10:2023.
  • Recipient changes. Confirm any change to a supplier’s bank details through a channel you already hold, not one given in the request.

Compliance

  • Onboarding. A regulated provider will run know-your-business checks before you get live credentials. Our guide to KYB explains what to expect.
  • Screening. Payments are screened for sanctions and fraud. Build for the case where a payment is held for review, so your system does not mark it as failed or resend it.
  • Crypto-asset transfers. If you use stablecoin settlement, payer and payee information has to travel with the transfer under the Travel Rule.
  • Data. Store only the payment data you need, protect it, and follow the data protection law that applies to you.

Testing checklist

ScenarioWhat to check
Happy pathA payout moves from created to sent to credited, and your records follow each step
Timeout and retryA retry with the same idempotency key returns the original result and does not create a second payment
Duplicate webhookProcessing the same event twice changes nothing the second time
Out-of-order eventsA late “sent” event does not overwrite a “credited” status
Rejected detailsAn invalid account number fails cleanly and shows a usable error
Returned paymentA payout returned by the receiving bank is reversed in your records
Held for reviewA payment held for screening is shown as pending, not failed, and is not resent
Expired quoteA conversion on an expired quote asks for a new quote instead of failing silently
Revoked keyRequests with a revoked key fail, and your alerts fire

Common mistakes

  • Retrying a payment with a new idempotency key, which turns one payment into two.
  • Trusting a webhook without verifying its signature.
  • Treating “sent” as “paid”: the receiving bank can still return a payment.
  • Putting API keys in client-side code or a shared document.
  • Building only the happy path, then meeting returns, holds and expired quotes in production.
  • Skipping daily reconciliation until a mismatch is weeks old.

Where KwiikPay fits

KwiikPay’s API covers accounts, FX and payouts for businesses. It does not offer card acceptance, so it is not a checkout gateway.

  • What you can do. Hold named GBP, EUR and USD accounts (virtual IBANs) in your company’s name, convert between 40+ currencies with a quote you can lock before you confirm, and send payouts across 30+ corridors to 80+ countries. Eligible customers can also use stablecoin settlement: USDC and EURC on Ethereum, and USDT on Ethereum, BSC and Tron.
  • How it works. A REST API with JSON requests and responses and an OpenAPI 3.1 specification. Pass an Idempotency-Key header on every request that creates or changes something, and a retry returns the original response. Webhook events, such as a received deposit, are signed with HMAC-SHA256, and failed deliveries are retried with exponential backoff.
  • Testing. A free sandbox, so you can build and test before any money moves. Our team issues sandbox keys, normally the same business day.
  • Plans. API access and signed webhooks depend on your plan; the pricing page shows which plan includes them. See the developer page for the reference, and API payouts for how the payout flow works.
  • Access. KwiikPay onboards companies incorporated in the European Economic Area, the United Kingdom, Gibraltar, Switzerland and Canada, where any authorisation their activity requires is current. Companies elsewhere are assessed individually, with no presumption of approval. Account opening is by invitation: request an account and the team replies within one business day. KYB checks come before live access.

KwiikPay is a trading name of KWP Finance Limited — registered in Canada as a Payment Service Provider under the Retail Payment Activities Act (RPAA), supervised by the Bank of Canada, and as a Money Services Business with FINTRAC (MSB registration number C100000942), including dealing in virtual currency. These are registrations, not licences. KwiikPay is not authorised by the FCA. KwiikPay is not a bank; banking and e-money services are provided by regulated partner institutions.

Building payouts, accounts or FX into your product?

See the developer page, or tell us your flows and volumes and the right person will reply within one business day.

Talk to sales Request an account

Sources

Checked on 25 October 2026.

This is general information, not legal or technical advice for your specific system.

FAQs

What is payment API integration?

Payment API integration means connecting your own software, such as an ERP, a platform or an app, to a payment provider's API so it can create payments, accounts or currency conversions and receive status updates automatically. Instead of keying payments into a bank portal, your system sends requests and the provider moves the money.

What is a fintech API?

A fintech API is an interface that lets software use a financial service: sending or collecting payments, issuing accounts, converting currency, reading account data or checking identities. The provider runs the regulated service; your software calls it with structured requests and gets structured responses back.

What is payment integration?

Payment integration is the work of making payments part of your own product or back office, through a hosted page, embedded components, a plugin or a direct API connection. The right method depends on what you are building, how much control you need and what data you are allowed to handle.

What is the difference between a payment API and a payment gateway?

A payment gateway usually means a service that accepts payments from customers, typically by card, at a checkout. A payment API is the broader idea: any programmable interface for moving money, which also covers payouts to suppliers, account issuing, FX and payment status. Many gateways are reached through an API, but not every payment API is a gateway.

Do card data security rules apply when I integrate a payment API?

Only if card data is involved. The PCI Security Standards Council says its data security standard applies to entities that store, process or transmit cardholder data. A payouts, accounts or FX API that never touches card numbers does not bring that standard into play, though you still need strong security. If you accept cards, a hosted payment page or embedded fields from your provider can reduce how much of the standard applies to you.

What is an idempotency key?

An idempotency key is a unique value you send with a request that creates or changes something, so that if the request is retried, for example after a timeout, the provider recognises it and does not act twice. For payments it is what stops one invoice being paid two times. The IETF is standardising the Idempotency-Key HTTP header in an Internet-Draft.

How long does a payment API integration take?

It depends on scope more than on the API. A single flow, such as sending payouts and reading their status, can be built and tested quickly in a sandbox. The longer parts are usually the provider's onboarding checks, mapping your approval and reconciliation process, and testing the failure cases. Plan for the checks and the edge cases, not just the happy path.

Does KwiikPay offer a payment API?

Yes, for accounts, FX and payouts rather than card acceptance. Depending on your plan, a REST API lets you hold named GBP, EUR and USD accounts, convert between 40+ currencies and send payouts across 30+ corridors, with idempotency keys on every request that creates or changes something and webhooks signed with HMAC-SHA256. A free sandbox is available; our team issues sandbox keys, normally the same business day. KwiikPay does not offer card acceptance.

Related
KwiikPay for developers → API payouts → What are B2B payments? → Cross-border transactions and payment rails → What is embedded finance? → Virtual IBANs, explained → Security → Pricing →

Open your first IBAN today.

Open a multi-currency account, subject to KYB, screening and our risk appetite.

Talk to sales