Versions Compared

Old Version 1

changes.mady.by.user axpb-vanmeerbeek

Saved on

compared with

New Version Current

changes.mady.by.user axpb-vanmeerbeek

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
The De Axepta BNP Paribas Online API is an online payment solution designed to facilitate the integration of secure payments on your e-commerce platform. This technical documentation provides all the necessary information to understand, configure, and use our API effectively.een veilige oplossing ontworpen om de integratie van betalingen in uw e-commerceplatform te vereenvoudigen. Deze documentatie biedt alle technische informatie die nodig is om de API effectief te begrijpen, te configureren en te gebruiken.



Info

Volledige API-documentatie

Info

The technical documentation for our API is available here: https://axeptabnpparibas-docs.redocly.app/

Presentation of the API


Presentatie van de API

Belangrijkste kenmerken

FunctieBeschrijving
RESTful-architectuurGebaseerd op REST-principes voor een voorspelbare en gebruiksvriendelijke interface.
Verhoogde beveiligingPCI-DSS-compliant met HTTPS

Key Features

  • RESTful Architecture: The API is based on REST principles, offering a predictable and easy-to-use interface.
    • Enhanced Security: Compliance with PCI-DSS standards and secure communication via HTTPS
    (TLS 1.2
    or higher).

  • Comprehensive Documentation: Detailed technical documentation to facilitate integration.

    • Use Cases

    • Online Payments: Real-time payment processing.

    • Transaction Management: Consultation and management of past transactions.

    Authentication

    of hoger) voor veilige communicatie.
    Uitgebreide documentatieGedetailleerde technische handleidingen voor eenvoudige integratie.

    Gebruiksscenario's

    • Online betalingen – Verwerk betalingen in real-time. 
    • Transactiebeheer – Raadpleeg en beheer eerdere transacties (bv. terugbetalingen, annuleringen).
    Authenticatie 

    Ondersteunde authenticatiemethoden

    Info

    Authenticatie verloopt via de productie-API: 

    Authentication Methods

    Info

    Authentication is performed by calling the following production API: https://paymentpage.axepta.bnpparibas/

    The API supports two authentication modes: BasicAuth and OAuth2.0

    Tip

    De API ondersteunt twee authenticatiemethoden:

    We recommend using
    • BasicAuth (eenvoudig, maar minder veilig)
    • OAuth 2.0
    authentication.
    • (aanbevolen)

    OAuth 2.0 :

    Authentication must be performed using the

    Authenticatie moet plaatsvinden via het OAuth-V2-protocol.

    The access token returned by the Axepta platform is valid for 1 hour.

    After this period, you must re-authenticate to obtain a valid token.

     

    Stappen:

    Generate a
    1. Genereer een 
    1. JSON Web Token (JWT)
    by authenticating with your API Key via the endpoint
    1.  door te authenticeren met uw API-sleutel via het endpoint: authorization/oauth/token
    .The
    2. Het access_token en token_type
    and access_token data must be present in all server requests, in the http 'Authorization' header
    1.  moeten worden meegestuurd in elke serveraanvraag, in de HTTP-header Authorization.

    Voorbeeld van een JWT-response:

    Code Block
    languagejson
    {
  "access_token": "eyJhbGciOiJSUzI1NiIsImtpZCI6IkZGQzlEM0JEQzY2Mjc3MUYwNzYxRUJDRTkwOTMyMDMyQjdGOTQ1NTQiLCJ4NXQiOiJfOG5UdmNaaWR4OEhZZXZPa0pNZ01yZjVSVlEiLCJ0eXAiOiJhdCtqd3QifQ.eyJpc3MiOiJodHRwczovL2xvY2FsaG9zdDo3MTIxLyIsImV4cCI6MTc0MDQ3NTUwNCwiaWF0IjoxNzQwNDcxOTA0LCJqdGkiOiJiZjU3YmUwMi05YThiLTQxYjctYjNjNi02NzlmMTcxNDU2ZjAiLCJzdWIiOiJDVF9Mb2dlZWNvbV90ZXN0IiwibmFtZSI6IkNUX0xvZ2VlY29tX3Rlc3QiLCJtYXJrZXRwbGFjZUlkIjoiQ1RfTG9nZWVjb21fdGVzdF9NYXJrZXRwbGFjZSIsIm1hcmtldHBsYWNlQWN0aXZlIjpmYWxzZSwib2lfcHJzdCI6IkNUX0xvZ2VlY29tX3Rlc3QiLCJjbGllbnRfaWQiOiJDVF9Mb2dlZWNvbV90ZXN0Iiwib2lfdGtuX2lkIjoiMjEwMWUxNTgtNzY0NC00OGU4LWIzNmYtYmZhNzczNWJmYjAyIn0.Xgtb81-GBPGnQ2tSJKXIlA38koRqlVa2oLhT902t-ICocWYD4_35bTAiPfU2A4HWwQpg1PZTrdf4riSoA_v_5bWSM-rdHAb-Y7fNwQTYAUYDxkcrw9qc5JcjwBGlOgXGTzJR2xyPDTq2sO4qAxo00lhCVjhEQR47yqOFta9rkcCmg1i6T6BxF7ZO6tBECfo7NSJ0wgN7G5_Unmd5MgWuG8V5VdvDxhXa1p_sBQdmy6nBCRi2d2bh1BOrz_uT5U2zngVBPzZBXv046j7971JXZbR20JFpkqwrULCGR6fy78NvkrHNC4U8ZDHmbejBbObMGCb_8pWMnaLhIg0A1k2x0Q",
  "token_type": "Bearer",
  "expires_in": 3600
}

    Idempotency


    ⚠ Belangrijk:

    • Het toegangstoken is 1 uur geldig.
    • Na verloop van tijd moet u opnieuw authenticeren om een nieuw token te verkrijgen.


    Idempotentie voor POST en PATCH-verzoeken

    Idempotentie voor POST en PATCH-verzoeken
    Voor POST en PATCH-verzoeken wordt idempotentie gegarandeerd door de HTTP-header Idempotency-Key.

    Vereisten:

    • De waarde moet uniek zijn voor elk HTTP-verzoek.
    • De client is verantwoordelijk voor het genereren van deze sleutel.
    • Aanbevolen formaat: UUID v4 (bv. 123e4567-e89b-12d3-a456-426614174000)

    The Axepta BNP Paribas Online server is idempotent: it processes the same request only once.

    If multiple identical requests are received, the same response will be returned without generating a new operation on the server side.

    This feature helps avoid duplicates in case of payment message repetition.

    For POST and PATCH messages, idempotence is ensured by using the HTTP header 'Idempotency-Key'.

    Its value must be unique for each HTTP request sent to the server, and it is the client's responsibility to generate it.

    It is recommended to use a uuid-v4 for this HTTP header
    • .