Briqpay Partner Integration Gateway API

Norce

API Usage with Norce

The following swimlane describes the usage of the API for connecting with Norce

See following usefull links:

Endpoints

Playground: https://playground-partner-integration-gateway.briqpay.com

Production: https://partner-integration-gateway.briqpay.com

briqpayConfirmOrder

Confirm a order

The operation will confirm a Briqpay checkout order in Norce

/v1/norce/confirmpurchase

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"https://partner-integration-gateway.briqpay.com/v1/norce/confirmpurchase"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NorceApi;

import java.io.File;
import java.util.*;

public class NorceApiExample {

    public static void main(String[] args) {
        
        NorceApi apiInstance = new NorceApi();
        Confirmpurchase body = ; // Confirmpurchase | 
        try {
            confirmpurchaseResponse result = apiInstance.briqpayConfirmOrder(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NorceApi#briqpayConfirmOrder");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.NorceApi;

public class NorceApiExample {

    public static void main(String[] args) {
        NorceApi apiInstance = new NorceApi();
        Confirmpurchase body = ; // Confirmpurchase | 
        try {
            confirmpurchaseResponse result = apiInstance.briqpayConfirmOrder(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NorceApi#briqpayConfirmOrder");
            e.printStackTrace();
        }
    }
}

Confirmpurchase *body = ; //  (optional)

NorceApi *apiInstance = [[NorceApi alloc] init];

// Confirm a order
[apiInstance briqpayConfirmOrderWith:body
              completionHandler: ^(confirmpurchaseResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var BriqpayPartnerIntegrationGatewayApi = require('briqpay_partner_integration_gateway_api');

var api = new BriqpayPartnerIntegrationGatewayApi.NorceApi()
var opts = { 
  'body':  // {{Confirmpurchase}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.briqpayConfirmOrder(opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class briqpayConfirmOrderExample
    {
        public void main()
        {

            var apiInstance = new NorceApi();
            var body = new Confirmpurchase(); // Confirmpurchase |  (optional) 

            try
            {
                // Confirm a order
                confirmpurchaseResponse result = apiInstance.briqpayConfirmOrder(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NorceApi.briqpayConfirmOrder: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiNorceApi();
$body = ; // Confirmpurchase | 

try {
    $result = $api_instance->briqpayConfirmOrder($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling NorceApi->briqpayConfirmOrder: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::NorceApi;

my $api_instance = WWW::SwaggerClient::NorceApi->new();
my $body = WWW::SwaggerClient::Object::Confirmpurchase->new(); # Confirmpurchase | 

eval { 
    my $result = $api_instance->briqpayConfirmOrder(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling NorceApi->briqpayConfirmOrder: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.NorceApi()
body =  # Confirmpurchase |  (optional)

try: 
    # Confirm a order
    api_response = api_instance.briqpay_confirm_order(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling NorceApi->briqpayConfirmOrder: %s\n" % e)

Parameters

Body parameters

Name	Description
body

Responses

Status: 200 - Successful operation

Schema

Status: 400 - Error

Status: default - successful operation

briqpayReadSession

Read a Briqpay session

The operation will read a Briqpay sessions

/v1/norce/readsession

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"https://partner-integration-gateway.briqpay.com/v1/norce/readsession"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NorceApi;

import java.io.File;
import java.util.*;

public class NorceApiExample {

    public static void main(String[] args) {
        
        NorceApi apiInstance = new NorceApi();
        ReadBriqpaySession body = ; // ReadBriqpaySession | 
        try {
            BriqpaySession result = apiInstance.briqpayReadSession(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NorceApi#briqpayReadSession");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.NorceApi;

public class NorceApiExample {

    public static void main(String[] args) {
        NorceApi apiInstance = new NorceApi();
        ReadBriqpaySession body = ; // ReadBriqpaySession | 
        try {
            BriqpaySession result = apiInstance.briqpayReadSession(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NorceApi#briqpayReadSession");
            e.printStackTrace();
        }
    }
}

ReadBriqpaySession *body = ; //  (optional)

NorceApi *apiInstance = [[NorceApi alloc] init];

// Read a Briqpay session
[apiInstance briqpayReadSessionWith:body
              completionHandler: ^(BriqpaySession output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var BriqpayPartnerIntegrationGatewayApi = require('briqpay_partner_integration_gateway_api');

var api = new BriqpayPartnerIntegrationGatewayApi.NorceApi()
var opts = { 
  'body':  // {{ReadBriqpaySession}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.briqpayReadSession(opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class briqpayReadSessionExample
    {
        public void main()
        {

            var apiInstance = new NorceApi();
            var body = new ReadBriqpaySession(); // ReadBriqpaySession |  (optional) 

            try
            {
                // Read a Briqpay session
                BriqpaySession result = apiInstance.briqpayReadSession(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NorceApi.briqpayReadSession: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiNorceApi();
$body = ; // ReadBriqpaySession | 

try {
    $result = $api_instance->briqpayReadSession($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling NorceApi->briqpayReadSession: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::NorceApi;

my $api_instance = WWW::SwaggerClient::NorceApi->new();
my $body = WWW::SwaggerClient::Object::ReadBriqpaySession->new(); # ReadBriqpaySession | 

eval { 
    my $result = $api_instance->briqpayReadSession(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling NorceApi->briqpayReadSession: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.NorceApi()
body =  # ReadBriqpaySession |  (optional)

try: 
    # Read a Briqpay session
    api_response = api_instance.briqpay_read_session(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling NorceApi->briqpayReadSession: %s\n" % e)

Parameters

Body parameters

Name	Description
body

Responses

Status: 200 - Successful operation

Schema

Status: 400 - Error

Status: default - successful operation

briqpayUpdateSession

Update a Briqpay session

The operation will update an ongoing Briqpay session

/v1/norce/updatesession

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"https://partner-integration-gateway.briqpay.com/v1/norce/updatesession"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NorceApi;

import java.io.File;
import java.util.*;

public class NorceApiExample {

    public static void main(String[] args) {
        
        NorceApi apiInstance = new NorceApi();
        UpdateBriqpaySession body = ; // UpdateBriqpaySession | 
        try {
            UpdateBriqpaySessionResponse result = apiInstance.briqpayUpdateSession(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NorceApi#briqpayUpdateSession");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.NorceApi;

public class NorceApiExample {

    public static void main(String[] args) {
        NorceApi apiInstance = new NorceApi();
        UpdateBriqpaySession body = ; // UpdateBriqpaySession | 
        try {
            UpdateBriqpaySessionResponse result = apiInstance.briqpayUpdateSession(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NorceApi#briqpayUpdateSession");
            e.printStackTrace();
        }
    }
}

UpdateBriqpaySession *body = ; //  (optional)

NorceApi *apiInstance = [[NorceApi alloc] init];

// Update a Briqpay session
[apiInstance briqpayUpdateSessionWith:body
              completionHandler: ^(UpdateBriqpaySessionResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var BriqpayPartnerIntegrationGatewayApi = require('briqpay_partner_integration_gateway_api');

var api = new BriqpayPartnerIntegrationGatewayApi.NorceApi()
var opts = { 
  'body':  // {{UpdateBriqpaySession}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.briqpayUpdateSession(opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class briqpayUpdateSessionExample
    {
        public void main()
        {

            var apiInstance = new NorceApi();
            var body = new UpdateBriqpaySession(); // UpdateBriqpaySession |  (optional) 

            try
            {
                // Update a Briqpay session
                UpdateBriqpaySessionResponse result = apiInstance.briqpayUpdateSession(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NorceApi.briqpayUpdateSession: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiNorceApi();
$body = ; // UpdateBriqpaySession | 

try {
    $result = $api_instance->briqpayUpdateSession($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling NorceApi->briqpayUpdateSession: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::NorceApi;

my $api_instance = WWW::SwaggerClient::NorceApi->new();
my $body = WWW::SwaggerClient::Object::UpdateBriqpaySession->new(); # UpdateBriqpaySession | 

eval { 
    my $result = $api_instance->briqpayUpdateSession(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling NorceApi->briqpayUpdateSession: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.NorceApi()
body =  # UpdateBriqpaySession |  (optional)

try: 
    # Update a Briqpay session
    api_response = api_instance.briqpay_update_session(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling NorceApi->briqpayUpdateSession: %s\n" % e)

Parameters

Body parameters

Name	Description
body

Responses

Status: 200 - Successful operation

Schema

Status: 400 - Error

Status: default - successful operation

createBriqpaySession

Creates a checkout from a Norce basket

The API will use a Norce basket in order to generate a checkout

/v1/norce/sessions

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"https://partner-integration-gateway.briqpay.com/v1/norce/sessions"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NorceApi;

import java.io.File;
import java.util.*;

public class NorceApiExample {

    public static void main(String[] args) {
        
        NorceApi apiInstance = new NorceApi();
        CreateBriqpaySessionNorce body = ; // CreateBriqpaySessionNorce | 
        try {
            CreateSessionNorceResponse result = apiInstance.createBriqpaySession(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NorceApi#createBriqpaySession");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.NorceApi;

public class NorceApiExample {

    public static void main(String[] args) {
        NorceApi apiInstance = new NorceApi();
        CreateBriqpaySessionNorce body = ; // CreateBriqpaySessionNorce | 
        try {
            CreateSessionNorceResponse result = apiInstance.createBriqpaySession(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NorceApi#createBriqpaySession");
            e.printStackTrace();
        }
    }
}

CreateBriqpaySessionNorce *body = ; //  (optional)

NorceApi *apiInstance = [[NorceApi alloc] init];

// Creates a checkout from a Norce basket
[apiInstance createBriqpaySessionWith:body
              completionHandler: ^(CreateSessionNorceResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var BriqpayPartnerIntegrationGatewayApi = require('briqpay_partner_integration_gateway_api');

var api = new BriqpayPartnerIntegrationGatewayApi.NorceApi()
var opts = { 
  'body':  // {{CreateBriqpaySessionNorce}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createBriqpaySession(opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createBriqpaySessionExample
    {
        public void main()
        {

            var apiInstance = new NorceApi();
            var body = new CreateBriqpaySessionNorce(); // CreateBriqpaySessionNorce |  (optional) 

            try
            {
                // Creates a checkout from a Norce basket
                CreateSessionNorceResponse result = apiInstance.createBriqpaySession(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NorceApi.createBriqpaySession: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiNorceApi();
$body = ; // CreateBriqpaySessionNorce | 

try {
    $result = $api_instance->createBriqpaySession($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling NorceApi->createBriqpaySession: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::NorceApi;

my $api_instance = WWW::SwaggerClient::NorceApi->new();
my $body = WWW::SwaggerClient::Object::CreateBriqpaySessionNorce->new(); # CreateBriqpaySessionNorce | 

eval { 
    my $result = $api_instance->createBriqpaySession(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling NorceApi->createBriqpaySession: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.NorceApi()
body =  # CreateBriqpaySessionNorce |  (optional)

try: 
    # Creates a checkout from a Norce basket
    api_response = api_instance.create_briqpay_session(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling NorceApi->createBriqpaySession: %s\n" % e)

Parameters

Body parameters

Name	Description
body

Briqpay Partner Integration Gateway API

API and SDK Documentation

Norce

API Usage with Norce

Endpoints

briqpayConfirmOrder

Usage and SDK Samples

Parameters

Responses

Status: 200 - Successful operation

Status: 400 - Error

Status: default - successful operation

briqpayReadSession

Usage and SDK Samples

Parameters

Responses

Status: 200 - Successful operation

Status: 400 - Error

Status: default - successful operation

briqpayUpdateSession

Usage and SDK Samples

Parameters

Responses

Status: 200 - Successful operation

Status: 400 - Error

Status: default - successful operation

createBriqpaySession

Usage and SDK Samples

Parameters

Responses

Status: 200 - Successful operation

Status: 400 - Error

Status: default - successful operation