Payment API

Use the Payment API to create and process payments with Dinape. The Payment API is the required integration layer for merchants and integrators.

Depending on the payment request, channel configuration, payment method, and provider requirements, Dinape may process the payment directly or route the customer through a Hosted Payment Page when customer interaction is required.

Hosted payment page behavior

The Hosted Payment Page is part of selected Payment API flows. It is used when the customer needs to select a payment method, confirm payment details, complete authentication, or perform another provider-required step.

Whether a hosted page is required depends on:

• the payment method provided in the request
• the channel configuration
• the connected payment provider
• whether customer interaction is required
• provider-specific payment flow requirements

Continue to Hosted Payment Page

How it works

With the Payment API, your backend communicates with Dinape to create and process payment requests.

A typical Payment API flow includes these steps:

1. The customer starts checkout in your shop or application.
2. Your backend sends the payment request to Dinape through the Payment API.
3. Dinape evaluates the channel configuration, payment method, and provider requirements.
4. Dinape either processes the payment directly or starts a hosted payment page flow when customer interaction is required.
5. The customer completes any required payment steps.
6. Dinape returns the payment result and sends callback notifications where configured.
7. Your system updates the order or payment status.
8. Dinape records the transaction for monitoring, reporting, and reconciliation.

The exact flow depends on the payment method, provider, and payment action.

Before you start

Before using the Payment API, make sure you have:

• a configured channel
• at least one payment provider connected to the channel
• the payment method you want to use configured for the channel
• API credentials for the channel
• payment URLs or callback handling where required
• access to the API reference

For payment provider setup, see Integrations Overview.

Use the channel configuration

The channel determines which payment provider configuration and payment methods are available for the payment request.

Use the channel ID in your integration so Dinape can route the payment through the correct configuration.

For more information about channels, see Account structure.

Handle payment updates

Payment results can affect the customer experience, order status, reporting, and reconciliation.

Use the payment result returned by Dinape and any callback notifications available for the payment flow to keep your system in sync.

warning Do not rely only on browser redirects or front-end state to confirm a payment result. Use server-side payment updates where available.

Track transactions

Payments created through the Payment API are shown in DINAPE as transactions.

Use Transaction Overview to review payment status, amounts, payment methods, and related transaction details.

Continue to Transaction Overview

Next steps

Review the API reference

Use the API reference for endpoint details, required fields, authentication, request examples, and response schemas.

Open API reference

Test a hosted checkout flow

Use the Demo Online Shop if you want to see a ready-made checkout flow before building your own integration.

Continue to Demo Shop

Manage payment actions

Use debit and refund pages to understand payment actions after a transaction is created.

Continue to Debit