Worldline Payment APIs

Name: Worldline Payment APIs API
Brand: Worldline Payment APIs
Availability: InStock

✓ Official Vendor SpecPaymentsPayment ProcessingapiKey23 EndpointsREST

For Agents

Process card payments, manage tokenised payment profiles, refund or void transactions, and pull settlement reports through Worldline (Bambora) North America.

Quickstart

Get started with Worldline Payment APIs in minutes using your preferred integration method.

# Add to your MCP client config (Claude Desktop, Cursor, Windsurf)
{
  "jentic": {
    "url": "https://api.jentic.com/mcp",
    "auth": "oauth"
  }
}

# Then ask your agent:
"process a worldline card payment"

# → Jentic returns the GET /events tool with parameter schema, agent executes.

Capabilities

What an agent can do with Worldline Payment APIs API.

Process card payments and capture pre-authorisations through the /payments endpoints

Tokenise card numbers so the merchant stays outside PCI DSS scope

Create stored payment profiles and attach, update, or remove cards on file

Refund or void a transaction using its trans ID

GET STARTED

Start building with Worldline Payment APIs API

Explore with Jentic

View OpenAPI Document

Worldline (formerly Bambora) North America offers a payment processing API for card transactions, tokenisation, stored payment profiles, settlement reporting, and recurring billing. The 23 endpoints handle the full transaction lifecycle: process, complete pre-auths, void, refund, and continue 3D Secure flows. Stored cards on a customer profile let merchants charge returning customers without re-collecting card data, while the reporting endpoints expose settlement, statement, and commission data for finance teams.

Use Cases

Patterns agents use Worldline Payment APIs API for, with concrete tasks.

★ Card Payment Processing

Accept one-time card payments through POST /payments, with support for pre-authorisation, completion, void, and refund flows. The API tokenises card data via /scripts/tokenization/tokens so merchants stay outside PCI scope. Pre-auths are captured later through /payments/{transId}/completions, and 3D Secure challenges resume through /payments/{merchantData}/continue.

Tokenise a card via POST /scripts/tokenization/tokens, then process a $49.99 USD payment with POST /payments using the returned token.

Stored Card Profiles for Returning Customers

Create persistent customer payment profiles via POST /profiles and attach one or more cards via POST /profiles/{profileId}/cards. On the next purchase the merchant references the profile and stored card instead of collecting card data again, which improves conversion and keeps PCI scope minimal. Cards can be listed, updated, or deleted as the customer's wallet changes.

Create a payment profile for a returning customer via POST /profiles, then add their card via POST /profiles/{profileId}/cards and charge it through POST /payments.

Settlement and Finance Reporting

Finance teams pull settlement data, monthly fee statements, and commission payouts directly via the /reports endpoints. /reports/settlement returns the rolling three-month window of settled transactions, /reports/statements returns the monthly fee statement, and /reports/commissions returns commission detail. This replaces manual extracts from the Worldline back office.

Call GET /reports/settlement for the last 30 days, then reconcile the totals against the merchant's accounting system.

AI Agent Integration via Jentic

An agent built on Jentic can run a card payment end-to-end: tokenise the card, optionally create a profile, process the payment, and surface the transaction ID. Worldline passcodes are held in MAXsystem so the agent never touches the encoded merchant_id:passcode pair.

Search Jentic for 'process a worldline payment', load the schema for POST /payments, and execute it with the order amount, currency, and card token.

Key Endpoints

23 endpoints — worldline (formerly bambora) north america offers a payment processing api for card transactions, tokenisation, stored payment profiles, settlement reporting, and recurring billing.

METHOD

PATH

DESCRIPTION

POST

/payments

Process a card payment

POST

/payments/{transId}/returns

Process a refund or return

POST

/payments/{transId}/void

Void or cancel a transaction

POST

/payments/{transId}/completions

Complete a pre-authorised payment

POST

/profiles

Create a customer payment profile

POST

/profiles/{profileId}/cards

Add a card to a profile

POST

/scripts/tokenization/tokens

Tokenise a credit card

GET

/reports/settlement

Retrieve settlement data

POST

/payments

Process a card payment

POST

/payments/{transId}/returns

Process a refund or return

POST

/payments/{transId}/void

Void or cancel a transaction

POST

/payments/{transId}/completions

Complete a pre-authorised payment

POST

/profiles

Create a customer payment profile

Why though Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

Worldline (Bambora) Passcode credentials and any Sub-Merchant-Id header are stored encrypted in the Jentic vault (MAXsystem). Agents receive scoped operation handles; the base64-encoded merchant_id:passcode pair never enters agent context or logs.

Intent-based discovery

Agents search Jentic with intents like 'process a card payment' or 'refund a transaction' and Jentic returns the matching Worldline operation with its input schema, so the agent calls the correct endpoint without parsing the spec.

Time to first call

Direct Worldline integration: 3-5 days for passcode handling, tokenisation, 3D Secure resume logic, and report endpoints. Through Jentic: under an hour — search, load schema, execute.

Related APIs

Alternatives and complements available in the Jentic catalogue.

Complementary

Bagisto Shop REST API

E-commerce storefront whose checkout step can hand off to Bambora for card capture

Use Bagisto for catalog and cart, and route the checkout payment to Bambora when the merchant is on Worldline.

Alternative

Bank of America Merchant Services

Another payment-related banking API alternative for North American merchants

Choose Bank of America when the merchant is already banking with BofA and wants integrated treasury, otherwise use Bambora for direct card processing.

Complementary

Backendless API

BaaS that can persist customer-facing receipts and order state alongside Bambora

Use Backendless to store order metadata once Bambora confirms the transaction.

FAQs

Specific to using Worldline Payment APIs API through Jentic.

What authentication does the Worldline (Bambora) API use?

Authentication uses a Passcode header in the format 'Passcode Base64Encoded(merchant_id:passcode)' (the passcode apiKey scheme). Payment facilitators additionally pass a Sub-Merchant-Id header. Through Jentic, both values live in the encrypted vault and are injected at execution so the agent never sees the encoded credential.

Can I store a card on file with the Bambora API?

Yes. Create a payment profile with POST /profiles, then attach a card via POST /profiles/{profileId}/cards. On the next charge, reference the profile in POST /payments instead of resubmitting card data. Cards on a profile are managed with PUT and DELETE on /profiles/{profileId}/cards/{cardId}.

What are the rate limits for the Bambora API?

Rate limits are not declared in the OpenAPI spec. Worldline enforces limits per merchant and gateway type; consult https://dev.na.bambora.com/ and your merchant agreement before high-volume bulk operations or batch refund jobs.

How do I refund a payment through Jentic?

Search Jentic for 'refund a worldline payment', load the schema for POST /payments/{transId}/returns, and execute with the original transaction ID and refund amount. Jentic injects the Passcode header so the agent never holds the credential.

Does the Bambora API support 3D Secure?

Yes. When a payment requires cardholder authentication, the initial POST /payments returns a redirect challenge. After the cardholder completes 3D Secure, the merchant resumes the flow with POST /payments/{merchantData}/continue using the merchantData token returned by the challenge.

Can I download settlement reports through this API?

Yes. GET /reports/settlement returns up to a three-month window of settled transactions. GET /reports/statements returns the monthly fee statement and GET /reports/commissions returns commission payout detail. POST /reports queries arbitrary transactions by date range.