# Worldline solutions - API Explorer

> Documentation and interactive explorer for Worldline solutions APIs, including endpoints, SDK links, and usage examples.

## API Explorer

- [Home / API Explorer](https://explorer.anzworldline-solutions.com.au/): Interactive API explorer interface - list of available endpoints and request/response examples.
- [GitHub SDK Links](https://github.com/wl-online-payments-direct): Links to official SDKs and GitHub repositories (as shown on the site).
- [Postman](https://www.postman.com/worldline-direct-team/worldline-direct-team-workspace/overview): Links to official Postman collection.

## Authentication

> Use default Merchant ID for testing or switch to custom credentials directly in the explorer interface.

- Default Credentials: Pre-configured Merchant ID for immediate API testing (no signup needed).
- Custom Merchant Setup: Enter your Merchant ID, API Key ID, and API Key Secret in the prompted fields.
- Switch Back: Always return to default Merchant via interface button-no data loss.

## Endpoints Reference

### Create Hosted Checkout
- **Path:** `/v2/{merchantId}/hostedcheckouts`
- **Description:** Start a hosted checkout flow and get details to redirect the consumer and retrieve status.
- **Type:** S2S
- **Method:** POST
- **Tags:** hosted-checkout, card, tokenize, direct-sale, apm, token, click-to-pay, cit, group-cards, dcc, surcharge

#### Scenarios
- **Basic**: https://explorer.anzworldline-solutions.com.au/?endpoint=CreateHostedCheckout&scenario=Basic
- **Basic - Cards**: https://explorer.anzworldline-solutions.com.au/?endpoint=CreateHostedCheckout&scenario=Basic%20-%20Cards
- **Basic - Cards Direct Sale**: https://explorer.anzworldline-solutions.com.au/?endpoint=CreateHostedCheckout&scenario=Basic%20-%20Cards%20Direct%20Sale
- **Basic - Alternative Payment Methods**: https://explorer.anzworldline-solutions.com.au/?endpoint=CreateHostedCheckout&scenario=Basic%20-%20Alternative%20Payment%20Methods
- **Advanced - Payment with token**: https://explorer.anzworldline-solutions.com.au/?endpoint=CreateHostedCheckout&scenario=Advanced%20-%20Payment%20with%20token
- **Advanced - Click to Pay**: https://explorer.anzworldline-solutions.com.au/?endpoint=CreateHostedCheckout&scenario=Advanced%20-%20Click%20to%20Pay
- **Advanced - Cardholder Initiated Transaction**: https://explorer.anzworldline-solutions.com.au/?endpoint=CreateHostedCheckout&scenario=Advanced%20-%20Cardholder%20Initiated%20Transaction
- **Advanced - Group Cards**: https://explorer.anzworldline-solutions.com.au/?endpoint=CreateHostedCheckout&scenario=Advanced%20-%20Group%20Cards
- **Advanced - Cards only - Group Cards**: https://explorer.anzworldline-solutions.com.au/?endpoint=CreateHostedCheckout&scenario=Advanced%20-%20Cards%20only%20-%20Group%20Cards
- **Advanced - DCC**: https://explorer.anzworldline-solutions.com.au/?endpoint=CreateHostedCheckout&scenario=Advanced%20-%20DCC
- **Advanced - Surcharging**: https://explorer.anzworldline-solutions.com.au/?endpoint=CreateHostedCheckout&scenario=Advanced%20-%20Surcharging

### Get Hosted Checkout
- **Path:** `/v2/{merchantId}/hostedcheckouts/{hostedCheckoutId}`
- **Description:** Retrieve the status and payment details of a hosted checkout session.
- **Type:** S2S
- **Method:** GET
- **Tags:** retrieve

#### Scenarios
- **Basic**: https://explorer.anzworldline-solutions.com.au/?endpoint=GetHostedCheckout&scenario=Basic

### Create Hosted Tokenization
- **Path:** `/v2/{merchantId}/hostedtokenizations`
- **Description:** Start a hosted tokenization session and get the URL for the tokenization form.
- **Type:** S2S
- **Method:** POST
- **Tags:** tokenization, token

#### Scenarios
- **Basic**: https://explorer.anzworldline-solutions.com.au/?endpoint=CreateHostedTokenization&scenario=Basic
- **Advanced**: https://explorer.anzworldline-solutions.com.au/?endpoint=CreateHostedTokenization&scenario=Advanced

### Get Hosted Tokenization
- **Path:** `/v2/{merchantId}/hostedtokenizations/{hostedTokenizationId}`
- **Description:** Retrieve the current status of a hosted tokenization session.
- **Type:** S2S
- **Method:** GET
- **Tags:** retrieve

#### Scenarios
- **Basic**: https://explorer.anzworldline-solutions.com.au/?endpoint=GetHostedTokenization&scenario=Basic

### Create Payment Link
- **Path:** `/v2/{merchantId}/paymentlinks`
- **Description:** Create a payment link by posting relevant details. Returns the created link.
- **Type:** S2S
- **Method:** POST
- **Tags:** payment-link

#### Scenarios
- **Basic**: https://explorer.anzworldline-solutions.com.au/?endpoint=CreatePaymentLink&scenario=Basic

### Get Payment Link By Id
- **Path:** `/v2/{merchantId}/paymentlinks/{paymentLinkId}`
- **Description:** Retrieve details of a specific payment link by its ID.
- **Type:** S2S
- **Method:** GET
- **Tags:** retrieve

#### Scenarios
- **Basic**: https://explorer.anzworldline-solutions.com.au/?endpoint=GetPaymentLinkById&scenario=Basic

### Cancel Payment Link By Id
- **Path:** `/v2/{merchantId}/paymentlinks/{paymentLinkId}/cancel`
- **Description:** Cancel a specific payment link by its ID.
- **Type:** S2S
- **Method:** POST
- **Tags:** cancel, payment-link

#### Scenarios
- **Basic**: https://explorer.anzworldline-solutions.com.au/?endpoint=CancelPaymentLinkById&scenario=Basic

### Create Payment
- **Path:** `/v2/{merchantId}/payments`
- **Description:** Initiate a payment by posting the required payment details.
- **Type:** S2S
- **Method:** POST
- **Tags:** payment, card, Klarna, Paypal, Visa, American Express, Google pay, Carte Bancaire, Diners, Discover, JCB, Mastercard, Unionpay, EPS, AliPay, WeChatPay, tokenization, shopping-cart, fraud, cit, surcharge, dcc

#### Scenarios
- **Basic**: https://explorer.anzworldline-solutions.com.au/?endpoint=CreatePayment&scenario=Basic
- **Basic - Hosted tokenization ID**: https://explorer.anzworldline-solutions.com.au/?endpoint=CreatePayment&scenario=Basic%20-%20Hosted%20tokenization%20ID
- **Advanced - 3DSv2 External authentication**: https://explorer.anzworldline-solutions.com.au/?endpoint=CreatePayment&scenario=Advanced%20-%203DSv2%20External%20authentication
- **Advanced - Billing and shipping details, and shopping cart**: https://explorer.anzworldline-solutions.com.au/?endpoint=CreatePayment&scenario=Advanced%20-%20Billing%20and%20shipping%20details%2C%20and%20shopping%20cart
- **Advanced - Fraud fields**: https://explorer.anzworldline-solutions.com.au/?endpoint=CreatePayment&scenario=Advanced%20-%20Fraud%20fields
- **Advanced - Cardholder Initiated Transaction**: https://explorer.anzworldline-solutions.com.au/?endpoint=CreatePayment&scenario=Advanced%20-%20Cardholder%20Initiated%20Transaction
- **Advanced - Merchant Initiated Transaction**: https://explorer.anzworldline-solutions.com.au/?endpoint=CreatePayment&scenario=Advanced%20-%20Merchant%20Initiated%20Transaction
- **Advanced - Travel data**: https://explorer.anzworldline-solutions.com.au/?endpoint=CreatePayment&scenario=Advanced%20-%20Travel%20data
- **Advanced - Surcharging (on-behalf-of)**: https://explorer.anzworldline-solutions.com.au/?endpoint=CreatePayment&scenario=Advanced%20-%20Surcharging%20%28on-behalf-of%29
- **Advanced - Surcharging (pass-through)**: https://explorer.anzworldline-solutions.com.au/?endpoint=CreatePayment&scenario=Advanced%20-%20Surcharging%20%28pass-through%29
- **Advanced - DCC**: https://explorer.anzworldline-solutions.com.au/?endpoint=CreatePayment&scenario=Advanced%20-%20DCC

### Get Payment
- **Path:** `/v2/{merchantId}/payments/{paymentId}`
- **Description:** Retrieve details of a specific payment by its ID.
- **Type:** S2S
- **Method:** GET
- **Tags:** retrieve

#### Scenarios
- **Basic**: https://explorer.anzworldline-solutions.com.au/?endpoint=GetPayment&scenario=Basic

### Cancel Payment
- **Path:** `/v2/{merchantId}/payments/{paymentId}/cancel`
- **Description:** Cancel a payment to prevent further processing and attempt to reverse card authorization.
- **Type:** S2S
- **Method:** POST
- **Tags:** cancel, payment

#### Scenarios
- **Basic**: https://explorer.anzworldline-solutions.com.au/?endpoint=CancelPayment&scenario=Basic
- **Advanced**: https://explorer.anzworldline-solutions.com.au/?endpoint=CancelPayment&scenario=Advanced

### Capture Payment
- **Path:** `/v2/{merchantId}/payments/{paymentId}/capture`
- **Description:** Capture authorized funds for a payment in PENDING_CAPTURE state.
- **Type:** S2S
- **Method:** POST
- **Tags:** capture, payment

#### Scenarios
- **Basic**: https://explorer.anzworldline-solutions.com.au/?endpoint=CapturePayment&scenario=Basic
- **Advanced**: https://explorer.anzworldline-solutions.com.au/?endpoint=CapturePayment&scenario=Advanced

### Get Captures
- **Path:** `/v2/{merchantId}/payments/{paymentId}/captures`
- **Description:** Retrieve all captures performed on a specific payment.
- **Type:** S2S
- **Method:** GET
- **Tags:** retrieve

#### Scenarios
- **Basic**: https://explorer.anzworldline-solutions.com.au/?endpoint=GetCaptures&scenario=Basic

### Complete Payment
- **Path:** `/v2/{merchantId}/payments/{paymentId}/complete`
- **Description:** Complete a two-step payment process (e.g., PayPal Express Checkout).
- **Type:** S2S
- **Method:** POST
- **Tags:** complete, payment

#### Scenarios
- **Basic**: https://explorer.anzworldline-solutions.com.au/?endpoint=CompletePayment&scenario=Basic
- **Advanced**: https://explorer.anzworldline-solutions.com.au/?endpoint=CompletePayment&scenario=Advanced

### Get Payment Details
- **Path:** `/v2/{merchantId}/payments/{paymentId}/details`
- **Description:** Retrieve full details of a specific payment.
- **Type:** S2S
- **Method:** GET
- **Tags:** retrieve

#### Scenarios
- **Basic**: https://explorer.anzworldline-solutions.com.au/?endpoint=GetPaymentDetails&scenario=Basic

### Refund Payment
- **Path:** `/v2/{merchantId}/payments/{paymentId}/refund`
- **Description:** Refund a payment fully or partially.
- **Type:** S2S
- **Method:** POST
- **Tags:** refund, payment

#### Scenarios
- **Basic**: https://explorer.anzworldline-solutions.com.au/?endpoint=RefundPayment&scenario=Basic
- **Advanced**: https://explorer.anzworldline-solutions.com.au/?endpoint=RefundPayment&scenario=Advanced

### Get Refunds
- **Path:** `/v2/{merchantId}/payments/{paymentId}/refunds`
- **Description:** Retrieve all refunds for a specific payment.
- **Type:** S2S
- **Method:** GET
- **Tags:** retrieve

#### Scenarios
- **Basic**: https://explorer.anzworldline-solutions.com.au/?endpoint=GetRefunds&scenario=Basic

### Subsequent Payment
- **Path:** `/v2/{merchantId}/payments/{paymentId}/subsequent`
- **Description:** Initiate a subsequent payment using an existing payment ID.
- **Type:** S2S
- **Method:** POST
- **Tags:** payment, card, subsequent

#### Scenarios
- **Basic**: https://explorer.anzworldline-solutions.com.au/?endpoint=SubsequentPayment&scenario=Basic

### Create Payout
- **Path:** `/v2/{merchantId}/payouts`
- **Description:** Create a payout to transfer money to a bank account.
- **Type:** S2S
- **Method:** POST
- **Tags:** payout, card, token

#### Scenarios
- **Basic**: https://explorer.anzworldline-solutions.com.au/?endpoint=CreatePayout&scenario=Basic
- **Advanced**: https://explorer.anzworldline-solutions.com.au/?endpoint=CreatePayout&scenario=Advanced

### Get Payout
- **Path:** `/v2/{merchantId}/payouts/{payoutId}`
- **Description:** Retrieve details of a specific payout.
- **Type:** S2S
- **Method:** GET
- **Tags:** retrieve

#### Scenarios
- **Basic**: https://explorer.anzworldline-solutions.com.au/?endpoint=GetPayout&scenario=Basic

### Get Product Groups
- **Path:** `/v2/{merchantId}/productgroups`
- **Description:** Retrieve payment product groups filtered by transaction details.
- **Type:** S2S
- **Method:** GET
- **Tags:** retrieve

#### Scenarios
- **Basic**: https://explorer.anzworldline-solutions.com.au/?endpoint=GetProductGroups&scenario=Basic
- **Advanced**: https://explorer.anzworldline-solutions.com.au/?endpoint=GetProductGroups&scenario=Advanced

### Get Product Group
- **Path:** `/v2/{merchantId}/productgroups/{paymentProductGroupId}`
- **Description:** Retrieve a specific payment product group with optional transaction filters.
- **Type:** S2S
- **Method:** GET
- **Tags:** retrieve

#### Scenarios
- **Basic**: https://explorer.anzworldline-solutions.com.au/?endpoint=GetProductGroup&scenario=Basic
- **Advanced**: https://explorer.anzworldline-solutions.com.au/?endpoint=GetProductGroup&scenario=Advanced

### Get Payment Products
- **Path:** `/v2/{merchantId}/products`
- **Description:** Retrieve payment products filtered by transaction details and locale.
- **Type:** S2S
- **Method:** GET
- **Tags:** retrieve

#### Scenarios
- **Basic**: https://explorer.anzworldline-solutions.com.au/?endpoint=GetPaymentProducts&scenario=Basic
- **Advanced**: https://explorer.anzworldline-solutions.com.au/?endpoint=GetPaymentProducts&scenario=Advanced

### Get Payment Product
- **Path:** `/v2/{merchantId}/products/{paymentProductId}`
- **Description:** Retrieve details of a single payment product with optional transaction filters.
- **Type:** S2S
- **Method:** GET
- **Tags:** retrieve

#### Scenarios
- **Basic**: https://explorer.anzworldline-solutions.com.au/?endpoint=GetPaymentProduct&scenario=Basic
- **Advanced**: https://explorer.anzworldline-solutions.com.au/?endpoint=GetPaymentProduct&scenario=Advanced

### Get Payment Product Networks
- **Path:** `/v2/{merchantId}/products/{paymentProductId}/networks`
- **Description:** List available networks for a payment product in the current context.
- **Type:** S2S
- **Method:** GET
- **Tags:** retrieve

#### Scenarios
- **Basic**: https://explorer.anzworldline-solutions.com.au/?endpoint=GetPaymentProductNetworks&scenario=Basic
- **Advanced**: https://explorer.anzworldline-solutions.com.au/?endpoint=GetPaymentProductNetworks&scenario=Advanced

### Get Dcc Rate Inquiry
- **Path:** `/v2/{merchantId}/services/dccrate`
- **Description:** Retrieve the currency conversion rate.
- **Type:** S2S
- **Method:** POST
- **Tags:** dcc, inquiry

#### Scenarios
- **Basic**: https://explorer.anzworldline-solutions.com.au/?endpoint=GetDccRateInquiry&scenario=Basic

### Get IIN Details
- **Path:** `/v2/{merchantId}/services/getIINdetails`
- **Description:** Validate card processability and suggest card type using first digits.
- **Type:** S2S
- **Method:** POST
- **Tags:** inquiry

#### Scenarios
- **Basic**: https://explorer.anzworldline-solutions.com.au/?endpoint=GetIINDetails&scenario=Basic
- **Advanced**: https://explorer.anzworldline-solutions.com.au/?endpoint=GetIINDetails&scenario=Advanced

### Get Privacy Policy
- **Path:** `/v2/{merchantId}/services/privacypolicy`
- **Description:** Fetch formatted privacy policy for merchant and payment product.
- **Type:** S2S
- **Method:** GET
- **Tags:** retrieve

#### Scenarios
- **Basic**: https://explorer.anzworldline-solutions.com.au/?endpoint=GetPrivacyPolicy&scenario=Basic
- **Advanced**: https://explorer.anzworldline-solutions.com.au/?endpoint=GetPrivacyPolicy&scenario=Advanced

### Surcharge Calculation
- **Path:** `/v2/{merchantId}/services/surchargecalculation`
- **Description:** Calculate surcharges for a transaction.
- **Type:** S2S
- **Method:** POST
- **Tags:** surcharge, card, token

#### Scenarios
- **Basic - Card**: https://explorer.anzworldline-solutions.com.au/?endpoint=SurchargeCalculation&scenario=Basic%20-%20Card
- **Basic - Token**: https://explorer.anzworldline-solutions.com.au/?endpoint=SurchargeCalculation&scenario=Basic%20-%20Token

### Test Connection
- **Path:** `/v2/{merchantId}/services/testconnection`
- **Description:** Verify API connection and credentials.
- **Type:** S2S
- **Method:** GET
- **Tags:** test

#### Scenarios
- **Basic**: https://explorer.anzworldline-solutions.com.au/?endpoint=TestConnection&scenario=Basic

### Create Session
- **Path:** `/v2/{merchantId}/sessions`
- **Description:** Create a new session for consumer payments.
- **Type:** S2S
- **Method:** POST
- **Tags:** session, token

#### Scenarios
- **Basic**: https://explorer.anzworldline-solutions.com.au/?endpoint=CreateSession&scenario=Basic
- **Advanced**: https://explorer.anzworldline-solutions.com.au/?endpoint=CreateSession&scenario=Advanced

### Create Token
- **Path:** `/v2/{merchantId}/tokens`
- **Description:** Tokenize payment details without external verification.
- **Type:** S2S
- **Method:** POST
- **Tags:** token, card

#### Scenarios
- **Basic**: https://explorer.anzworldline-solutions.com.au/?endpoint=CreateToken&scenario=Basic

### Delete Token
- **Path:** `/v2/{merchantId}/tokens/{tokenId}`
- **Description:** Delete or invalidate a specific token.
- **Type:** S2S
- **Method:** DELETE
- **Tags:** token

#### Scenarios
- **Basic**: https://explorer.anzworldline-solutions.com.au/?endpoint=DeleteToken&scenario=Basic

### Get Token
- **Path:** `/v2/{merchantId}/tokens/{tokenId}`
- **Description:** Retrieve tokenized data for a specific token ID.
- **Type:** S2S
- **Method:** GET
- **Tags:** retrieve

#### Scenarios
- **Basic**: https://explorer.anzworldline-solutions.com.au/?endpoint=GetToken&scenario=Basic

### Get Client Public Key
- **Path:** `/client/v1/{customerId}/crypto/publickey`
- **Description:** Get a transaction-specific public key for encrypting sensitive data.
- **Type:** C2S
- **Method:** GET
- **Tags:** retrieve

#### Scenarios
- **Basic**: https://explorer.anzworldline-solutions.com.au/?endpoint=GetClientPublicKey&scenario=Basic

### Get Client Product Groups
- **Path:** `/client/v1/{customerId}/productgroups`
- **Description:** Retrieve payment product groups with optional filters.
- **Type:** C2S
- **Method:** GET
- **Tags:** retrieve

#### Scenarios
- **Basic**: https://explorer.anzworldline-solutions.com.au/?endpoint=GetClientProductGroups&scenario=Basic
- **Advanced**: https://explorer.anzworldline-solutions.com.au/?endpoint=GetClientProductGroups&scenario=Advanced

### Get Client Product Group
- **Path:** `/client/v1/{customerId}/productgroups/{paymentProductGroupId}`
- **Description:** Retrieve details for a specific client payment product group with optional filters.
- **Type:** C2S
- **Method:** GET
- **Tags:** retrieve

#### Scenarios
- **Basic**: https://explorer.anzworldline-solutions.com.au/?endpoint=GetClientProductGroup&scenario=Basic
- **Advanced**: https://explorer.anzworldline-solutions.com.au/?endpoint=GetClientProductGroup&scenario=Advanced

### Get Client Payment Products
- **Path:** `/client/v1/{customerId}/products`
- **Description:** Retrieve client payment products filtered by transaction details.
- **Type:** C2S
- **Method:** GET
- **Tags:** retrieve

#### Scenarios
- **Basic**: https://explorer.anzworldline-solutions.com.au/?endpoint=GetClientPaymentProducts&scenario=Basic
- **Advanced**: https://explorer.anzworldline-solutions.com.au/?endpoint=GetClientPaymentProducts&scenario=Advanced

### Get Client Payment Product
- **Path:** `/client/v1/{customerId}/products/{paymentProductId}`
- **Description:** Retrieve details for a specific client payment product with optional filters.
- **Type:** C2S
- **Method:** GET
- **Tags:** retrieve

#### Scenarios
- **Basic**: https://explorer.anzworldline-solutions.com.au/?endpoint=GetClientPaymentProduct&scenario=Basic
- **Advanced**: https://explorer.anzworldline-solutions.com.au/?endpoint=GetClientPaymentProduct&scenario=Advanced

### Get Client Payment Product Networks
- **Path:** `/client/v1/{customerId}/products/{paymentProductId}/networks`
- **Description:** Retrieve networks for a specific client payment product, e.g., Apple Pay or Google Pay networks.
- **Type:** C2S
- **Method:** GET
- **Tags:** retrieve

#### Scenarios
- **Basic**: https://explorer.anzworldline-solutions.com.au/?endpoint=GetClientPaymentProductNetworks&scenario=Basic
- **Advanced**: https://explorer.anzworldline-solutions.com.au/?endpoint=GetClientPaymentProductNetworks&scenario=Advanced

### Get Client IINdetails
- **Path:** `/client/v1/{customerId}/services/getIINdetails`
- **Description:** Verifies card processability and suggests the best card type using the initial 6 or more digits. Returns a suitable paymentProductId for user feedback.
- **Type:** C2S
- **Method:** POST
- **Tags:** retrieve

#### Scenarios
- **Basic**: https://explorer.anzworldline-solutions.com.au/?endpoint=GetClientIINdetails&scenario=Basic
- **Advanced**: https://explorer.anzworldline-solutions.com.au/?endpoint=GetClientIINdetails&scenario=Advanced

### Client Surcharge Calculation
- **Path:** `/client/v1/{customerId}/services/surchargecalculation`
- **Description:** Calculates surcharges for a client transaction.
- **Type:** C2S
- **Method:** POST
- **Tags:** surcharge

#### Scenarios
- **Basic - Card**: https://explorer.anzworldline-solutions.com.au/?endpoint=ClientSurchargeCalculation&scenario=Basic%20-%20Card
- **Basic - Token**: https://explorer.anzworldline-solutions.com.au/?endpoint=ClientSurchargeCalculation&scenario=Basic%20-%20Token

### Get Client Dcc Rate Inquiry
- **Path:** `/client/v2/{customerId}/services/dccrate`
- **Description:** Returns the currency conversion rate for a client transaction.
- **Type:** C2S
- **Method:** POST
- **Tags:** dcc

#### Scenarios
- **Basic**: https://explorer.anzworldline-solutions.com.au/?endpoint=GetClientDccRateInquiry&scenario=Basic

## Additional Resources

- **Sign Up / Authentication Info**: Endpoint for signing up and obtaining credentials for API access.
- **Changelog / Build Version Info**: Page with build/version history and updates (e.g., “Build version 2025.11.0 | Changelog”).