NPGW Merchant API

Authentication

getToken

Create a new or refresh an expired Bearer Token.

This token allows you to execute operations on the NPGW Gateway APIs with authority, and whilst a single token will expire after 15 minutes, you can generate one at any time.


/token

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: text/plain" \
 "https://npgw.xyz/merchant-v1/token" \
 -d 'Custom MIME type example not yet supported: text/plain'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AuthenticationApi;

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

public class AuthenticationApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        AuthenticationApi apiInstance = new AuthenticationApi();
        String body = body_example; // String | 

        try {
            ResponseToken result = apiInstance.getToken(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthenticationApi#getToken");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String body = new String(); // String | 

try {
    final result = await api_instance.getToken(body);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getToken: $e\n');
}

import org.openapitools.client.api.AuthenticationApi;

public class AuthenticationApiExample {
    public static void main(String[] args) {
        AuthenticationApi apiInstance = new AuthenticationApi();
        String body = body_example; // String | 

        try {
            ResponseToken result = apiInstance.getToken(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthenticationApi#getToken");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AuthenticationApi *apiInstance = [[AuthenticationApi alloc] init];
String *body = body_example; // 

// Create a new or refresh an expired Bearer Token.
[apiInstance getTokenWith:body
              completionHandler: ^(ResponseToken output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NpgwMerchantApi = require('npgw_merchant_api');

// Create an instance of the API class
var api = new NpgwMerchantApi.AuthenticationApi()
var body = body_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getToken(body, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new AuthenticationApi();
            var body = body_example;  // String | 

            try {
                // Create a new or refresh an expired Bearer Token.
                ResponseToken result = apiInstance.getToken(body);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AuthenticationApi.getToken: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AuthenticationApi();
$body = body_example; // String | 

try {
    $result = $api_instance->getToken($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AuthenticationApi->getToken: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AuthenticationApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AuthenticationApi->new();
my $body = WWW::OPenAPIClient::Object::String->new(); # String | 

eval {
    my $result = $api_instance->getToken(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AuthenticationApi->getToken: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.AuthenticationApi()
body = body_example # String | 

try:
    # Create a new or refresh an expired Bearer Token.
    api_response = api_instance.get_token(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthenticationApi->getToken: %s\n" % e)
extern crate AuthenticationApi;

pub fn main() {
    let body = body_example; // String

    let mut context = AuthenticationApi::Context::default();
    let result = client.getToken(body, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
body *

Secret token.

Responses


Default

cancelTransaction


/transaction/{transactionId}/cancel

Usage and SDK Samples

curl -X POST \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://npgw.xyz/merchant-v1/transaction/{transactionId}/cancel" \
 -d '{
  "notificationUrl" : "https://example.com/notification_endpoint",
  "amount" : 1999,
  "merchantId" : "company786",
  "redirectUrlSuccess" : "https://example.com/success",
  "redirectUrlCancel" : "https://example.com/cancel",
  "currency" : "EUR",
  "externalTransactionId" : "REF00L00000",
  "paymentDetails" : {
    "expMonth" : "6",
    "cvv" : "148",
    "cardHolderName" : "Hal Jordan",
    "expYear" : "2029",
    "cardType" : "VISA",
    "paymentMethod" : "CreditCard",
    "pan" : "2303779999000275"
  },
  "type" : "SALE",
  "customerDetails" : {
    "zip" : "90210",
    "country" : "US",
    "lastName" : "Jordan",
    "externalCustomerId" : "32556",
    "address2" : "unit 5",
    "city" : "Coast City",
    "address1" : "59 Gil Broome Avenue",
    "ipAddress" : "192.168.3.123",
    "dateOfBirth" : "2004-08-24",
    "firstName" : "Hal",
    "phone" : "17723493500",
    "state" : "CA",
    "email" : "[email protected]"
  },
  "expiresAt" : "2000-01-23T04:56:07.000+00:00",
  "redirectUrlFail" : "https://example.com/failed"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DefaultApi;

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

public class DefaultApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: apiKeyAuth
        ApiKeyAuth apiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("apiKeyAuth");
        apiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //apiKeyAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        DefaultApi apiInstance = new DefaultApi();
        String transactionId = transactionId_example; // String | 
        Transaction transaction = ; // Transaction | 

        try {
            TransactionResponse result = apiInstance.cancelTransaction(transactionId, transaction);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#cancelTransaction");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String transactionId = new String(); // String | 
final Transaction transaction = new Transaction(); // Transaction | 

try {
    final result = await api_instance.cancelTransaction(transactionId, transaction);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->cancelTransaction: $e\n');
}

import org.openapitools.client.api.DefaultApi;

public class DefaultApiExample {
    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String transactionId = transactionId_example; // String | 
        Transaction transaction = ; // Transaction | 

        try {
            TransactionResponse result = apiInstance.cancelTransaction(transactionId, transaction);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#cancelTransaction");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: apiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
DefaultApi *apiInstance = [[DefaultApi alloc] init];
String *transactionId = transactionId_example; //  (default to null)
Transaction *transaction = ; // 

[apiInstance cancelTransactionWith:transactionId
    transaction:transaction
              completionHandler: ^(TransactionResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NpgwMerchantApi = require('npgw_merchant_api');
var defaultClient = NpgwMerchantApi.ApiClient.instance;

// Configure API key authorization: apiKeyAuth
var apiKeyAuth = defaultClient.authentications['apiKeyAuth'];
apiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKeyAuth.apiKeyPrefix['Authorization'] = "Token";

// Create an instance of the API class
var api = new NpgwMerchantApi.DefaultApi()
var transactionId = transactionId_example; // {String} 
var transaction = ; // {Transaction} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.cancelTransaction(transactionId, transaction, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class cancelTransactionExample
    {
        public void main()
        {
            // Configure API key authorization: apiKeyAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new DefaultApi();
            var transactionId = transactionId_example;  // String |  (default to null)
            var transaction = new Transaction(); // Transaction | 

            try {
                TransactionResponse result = apiInstance.cancelTransaction(transactionId, transaction);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DefaultApi.cancelTransaction: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: apiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DefaultApi();
$transactionId = transactionId_example; // String | 
$transaction = ; // Transaction | 

try {
    $result = $api_instance->cancelTransaction($transactionId, $transaction);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->cancelTransaction: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DefaultApi;

# Configure API key authorization: apiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
my $transactionId = transactionId_example; # String | 
my $transaction = WWW::OPenAPIClient::Object::Transaction->new(); # Transaction | 

eval {
    my $result = $api_instance->cancelTransaction(transactionId => $transactionId, transaction => $transaction);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->cancelTransaction: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: apiKeyAuth
openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.DefaultApi()
transactionId = transactionId_example # String |  (default to null)
transaction =  # Transaction | 

try:
    api_response = api_instance.cancel_transaction(transactionId, transaction)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->cancelTransaction: %s\n" % e)
extern crate DefaultApi;

pub fn main() {
    let transactionId = transactionId_example; // String
    let transaction = ; // Transaction

    let mut context = DefaultApi::Context::default();
    let result = client.cancelTransaction(transactionId, transaction, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
transactionId*
String
Required
Body parameters
Name Description
transaction *

Responses


captureTransaction


/transaction/{transactionId}/capture

Usage and SDK Samples

curl -X POST \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://npgw.xyz/merchant-v1/transaction/{transactionId}/capture" \
 -d '{
  "amount" : 1999,
  "currency" : "EUR"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DefaultApi;

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

public class DefaultApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: apiKeyAuth
        ApiKeyAuth apiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("apiKeyAuth");
        apiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //apiKeyAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        DefaultApi apiInstance = new DefaultApi();
        String transactionId = transactionId_example; // String | 
        Amount amount = ; // Amount | 

        try {
            TransactionResponse result = apiInstance.captureTransaction(transactionId, amount);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#captureTransaction");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String transactionId = new String(); // String | 
final Amount amount = new Amount(); // Amount | 

try {
    final result = await api_instance.captureTransaction(transactionId, amount);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->captureTransaction: $e\n');
}

import org.openapitools.client.api.DefaultApi;

public class DefaultApiExample {
    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String transactionId = transactionId_example; // String | 
        Amount amount = ; // Amount | 

        try {
            TransactionResponse result = apiInstance.captureTransaction(transactionId, amount);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#captureTransaction");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: apiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
DefaultApi *apiInstance = [[DefaultApi alloc] init];
String *transactionId = transactionId_example; //  (default to null)
Amount *amount = ; // 

[apiInstance captureTransactionWith:transactionId
    amount:amount
              completionHandler: ^(TransactionResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NpgwMerchantApi = require('npgw_merchant_api');
var defaultClient = NpgwMerchantApi.ApiClient.instance;

// Configure API key authorization: apiKeyAuth
var apiKeyAuth = defaultClient.authentications['apiKeyAuth'];
apiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKeyAuth.apiKeyPrefix['Authorization'] = "Token";

// Create an instance of the API class
var api = new NpgwMerchantApi.DefaultApi()
var transactionId = transactionId_example; // {String} 
var amount = ; // {Amount} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.captureTransaction(transactionId, amount, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class captureTransactionExample
    {
        public void main()
        {
            // Configure API key authorization: apiKeyAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new DefaultApi();
            var transactionId = transactionId_example;  // String |  (default to null)
            var amount = new Amount(); // Amount | 

            try {
                TransactionResponse result = apiInstance.captureTransaction(transactionId, amount);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DefaultApi.captureTransaction: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: apiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DefaultApi();
$transactionId = transactionId_example; // String | 
$amount = ; // Amount | 

try {
    $result = $api_instance->captureTransaction($transactionId, $amount);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->captureTransaction: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DefaultApi;

# Configure API key authorization: apiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
my $transactionId = transactionId_example; # String | 
my $amount = WWW::OPenAPIClient::Object::Amount->new(); # Amount | 

eval {
    my $result = $api_instance->captureTransaction(transactionId => $transactionId, amount => $amount);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->captureTransaction: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: apiKeyAuth
openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.DefaultApi()
transactionId = transactionId_example # String |  (default to null)
amount =  # Amount | 

try:
    api_response = api_instance.capture_transaction(transactionId, amount)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->captureTransaction: %s\n" % e)
extern crate DefaultApi;

pub fn main() {
    let transactionId = transactionId_example; // String
    let amount = ; // Amount

    let mut context = DefaultApi::Context::default();
    let result = client.captureTransaction(transactionId, amount, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
transactionId*
String
Required
Body parameters
Name Description
amount *

Responses


refundTransaction


/transaction/{transactionId}/refund

Usage and SDK Samples

curl -X POST \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://npgw.xyz/merchant-v1/transaction/{transactionId}/refund" \
 -d '{
  "notificationUrl" : "https://example.com/notification_endpoint",
  "amount" : 1999,
  "merchantId" : "company786",
  "redirectUrlSuccess" : "https://example.com/success",
  "redirectUrlCancel" : "https://example.com/cancel",
  "currency" : "EUR",
  "externalTransactionId" : "REF00L00000",
  "paymentDetails" : {
    "expMonth" : "6",
    "cvv" : "148",
    "cardHolderName" : "Hal Jordan",
    "expYear" : "2029",
    "cardType" : "VISA",
    "paymentMethod" : "CreditCard",
    "pan" : "2303779999000275"
  },
  "type" : "SALE",
  "customerDetails" : {
    "zip" : "90210",
    "country" : "US",
    "lastName" : "Jordan",
    "externalCustomerId" : "32556",
    "address2" : "unit 5",
    "city" : "Coast City",
    "address1" : "59 Gil Broome Avenue",
    "ipAddress" : "192.168.3.123",
    "dateOfBirth" : "2004-08-24",
    "firstName" : "Hal",
    "phone" : "17723493500",
    "state" : "CA",
    "email" : "[email protected]"
  },
  "expiresAt" : "2000-01-23T04:56:07.000+00:00",
  "redirectUrlFail" : "https://example.com/failed"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DefaultApi;

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

public class DefaultApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: apiKeyAuth
        ApiKeyAuth apiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("apiKeyAuth");
        apiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //apiKeyAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        DefaultApi apiInstance = new DefaultApi();
        String transactionId = transactionId_example; // String | 
        Transaction transaction = ; // Transaction | 

        try {
            TransactionResponse result = apiInstance.refundTransaction(transactionId, transaction);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#refundTransaction");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String transactionId = new String(); // String | 
final Transaction transaction = new Transaction(); // Transaction | 

try {
    final result = await api_instance.refundTransaction(transactionId, transaction);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->refundTransaction: $e\n');
}

import org.openapitools.client.api.DefaultApi;

public class DefaultApiExample {
    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String transactionId = transactionId_example; // String | 
        Transaction transaction = ; // Transaction | 

        try {
            TransactionResponse result = apiInstance.refundTransaction(transactionId, transaction);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#refundTransaction");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: apiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
DefaultApi *apiInstance = [[DefaultApi alloc] init];
String *transactionId = transactionId_example; //  (default to null)
Transaction *transaction = ; // 

[apiInstance refundTransactionWith:transactionId
    transaction:transaction
              completionHandler: ^(TransactionResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NpgwMerchantApi = require('npgw_merchant_api');
var defaultClient = NpgwMerchantApi.ApiClient.instance;

// Configure API key authorization: apiKeyAuth
var apiKeyAuth = defaultClient.authentications['apiKeyAuth'];
apiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKeyAuth.apiKeyPrefix['Authorization'] = "Token";

// Create an instance of the API class
var api = new NpgwMerchantApi.DefaultApi()
var transactionId = transactionId_example; // {String} 
var transaction = ; // {Transaction} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.refundTransaction(transactionId, transaction, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class refundTransactionExample
    {
        public void main()
        {
            // Configure API key authorization: apiKeyAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new DefaultApi();
            var transactionId = transactionId_example;  // String |  (default to null)
            var transaction = new Transaction(); // Transaction | 

            try {
                TransactionResponse result = apiInstance.refundTransaction(transactionId, transaction);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DefaultApi.refundTransaction: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: apiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DefaultApi();
$transactionId = transactionId_example; // String | 
$transaction = ; // Transaction | 

try {
    $result = $api_instance->refundTransaction($transactionId, $transaction);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->refundTransaction: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DefaultApi;

# Configure API key authorization: apiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
my $transactionId = transactionId_example; # String | 
my $transaction = WWW::OPenAPIClient::Object::Transaction->new(); # Transaction | 

eval {
    my $result = $api_instance->refundTransaction(transactionId => $transactionId, transaction => $transaction);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->refundTransaction: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: apiKeyAuth
openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.DefaultApi()
transactionId = transactionId_example # String |  (default to null)
transaction =  # Transaction | 

try:
    api_response = api_instance.refund_transaction(transactionId, transaction)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->refundTransaction: %s\n" % e)
extern crate DefaultApi;

pub fn main() {
    let transactionId = transactionId_example; // String
    let transaction = ; // Transaction

    let mut context = DefaultApi::Context::default();
    let result = client.refundTransaction(transactionId, transaction, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
transactionId*
String
Required
Body parameters
Name Description
transaction *

Responses


Payment

createTransaction

Create a new CreditCard Transaction.

A successful request will return a secure payment URL via **{body.paymentUrl}** to which the customer should be redirected to complete online 3DSecure authentication with their bank. Payments will proceed to Authorization on successful authentication by the customer.


/transaction

Usage and SDK Samples

curl -X POST \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://npgw.xyz/merchant-v1/transaction?async=true" \
 -d '{
  "notificationUrl" : "https://example.com/notification_endpoint",
  "amount" : 1999,
  "merchantId" : "company786",
  "redirectUrlSuccess" : "https://example.com/success",
  "redirectUrlCancel" : "https://example.com/cancel",
  "currency" : "EUR",
  "externalTransactionId" : "REF00L00000",
  "paymentDetails" : {
    "expMonth" : "6",
    "cvv" : "148",
    "cardHolderName" : "Hal Jordan",
    "expYear" : "2029",
    "cardType" : "VISA",
    "paymentMethod" : "CreditCard",
    "pan" : "2303779999000275"
  },
  "type" : "SALE",
  "customerDetails" : {
    "zip" : "90210",
    "country" : "US",
    "lastName" : "Jordan",
    "externalCustomerId" : "32556",
    "address2" : "unit 5",
    "city" : "Coast City",
    "address1" : "59 Gil Broome Avenue",
    "ipAddress" : "192.168.3.123",
    "dateOfBirth" : "2004-08-24",
    "firstName" : "Hal",
    "phone" : "17723493500",
    "state" : "CA",
    "email" : "[email protected]"
  },
  "expiresAt" : "2000-01-23T04:56:07.000+00:00",
  "redirectUrlFail" : "https://example.com/failed"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PaymentApi;

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

public class PaymentApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: apiKeyAuth
        ApiKeyAuth apiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("apiKeyAuth");
        apiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //apiKeyAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PaymentApi apiInstance = new PaymentApi();
        Transaction transaction = ; // Transaction | 
        Boolean async = true; // Boolean | Indicates whether the transaction should be processed asynchronously from our downstream CreditCard Acquirers. When set to true, the request will return immediately with a status indicating that processing is ongoing.

        try {
            TransactionResponse result = apiInstance.createTransaction(transaction, async);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentApi#createTransaction");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Transaction transaction = new Transaction(); // Transaction | 
final Boolean async = new Boolean(); // Boolean | Indicates whether the transaction should be processed asynchronously from our downstream CreditCard Acquirers. When set to true, the request will return immediately with a status indicating that processing is ongoing.

try {
    final result = await api_instance.createTransaction(transaction, async);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createTransaction: $e\n');
}

import org.openapitools.client.api.PaymentApi;

public class PaymentApiExample {
    public static void main(String[] args) {
        PaymentApi apiInstance = new PaymentApi();
        Transaction transaction = ; // Transaction | 
        Boolean async = true; // Boolean | Indicates whether the transaction should be processed asynchronously from our downstream CreditCard Acquirers. When set to true, the request will return immediately with a status indicating that processing is ongoing.

        try {
            TransactionResponse result = apiInstance.createTransaction(transaction, async);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentApi#createTransaction");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: apiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
PaymentApi *apiInstance = [[PaymentApi alloc] init];
Transaction *transaction = ; // 
Boolean *async = true; // Indicates whether the transaction should be processed asynchronously from our downstream CreditCard Acquirers. When set to true, the request will return immediately with a status indicating that processing is ongoing. (optional) (default to null)

// Create a new CreditCard Transaction.
[apiInstance createTransactionWith:transaction
    async:async
              completionHandler: ^(TransactionResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NpgwMerchantApi = require('npgw_merchant_api');
var defaultClient = NpgwMerchantApi.ApiClient.instance;

// Configure API key authorization: apiKeyAuth
var apiKeyAuth = defaultClient.authentications['apiKeyAuth'];
apiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKeyAuth.apiKeyPrefix['Authorization'] = "Token";

// Create an instance of the API class
var api = new NpgwMerchantApi.PaymentApi()
var transaction = ; // {Transaction} 
var opts = {
  'async': true // {Boolean} Indicates whether the transaction should be processed asynchronously from our downstream CreditCard Acquirers. When set to true, the request will return immediately with a status indicating that processing is ongoing.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createTransaction(transaction, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class createTransactionExample
    {
        public void main()
        {
            // Configure API key authorization: apiKeyAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new PaymentApi();
            var transaction = new Transaction(); // Transaction | 
            var async = true;  // Boolean | Indicates whether the transaction should be processed asynchronously from our downstream CreditCard Acquirers. When set to true, the request will return immediately with a status indicating that processing is ongoing. (optional)  (default to null)

            try {
                // Create a new CreditCard Transaction.
                TransactionResponse result = apiInstance.createTransaction(transaction, async);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PaymentApi.createTransaction: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: apiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PaymentApi();
$transaction = ; // Transaction | 
$async = true; // Boolean | Indicates whether the transaction should be processed asynchronously from our downstream CreditCard Acquirers. When set to true, the request will return immediately with a status indicating that processing is ongoing.

try {
    $result = $api_instance->createTransaction($transaction, $async);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PaymentApi->createTransaction: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PaymentApi;

# Configure API key authorization: apiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PaymentApi->new();
my $transaction = WWW::OPenAPIClient::Object::Transaction->new(); # Transaction | 
my $async = true; # Boolean | Indicates whether the transaction should be processed asynchronously from our downstream CreditCard Acquirers. When set to true, the request will return immediately with a status indicating that processing is ongoing.

eval {
    my $result = $api_instance->createTransaction(transaction => $transaction, async => $async);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PaymentApi->createTransaction: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: apiKeyAuth
openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.PaymentApi()
transaction =  # Transaction | 
async = true # Boolean | Indicates whether the transaction should be processed asynchronously from our downstream CreditCard Acquirers. When set to true, the request will return immediately with a status indicating that processing is ongoing. (optional) (default to null)

try:
    # Create a new CreditCard Transaction.
    api_response = api_instance.create_transaction(transaction, async=async)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PaymentApi->createTransaction: %s\n" % e)
extern crate PaymentApi;

pub fn main() {
    let transaction = ; // Transaction
    let async = true; // Boolean

    let mut context = PaymentApi::Context::default();
    let result = client.createTransaction(transaction, async, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
transaction *

Query parameters
Name Description
async
Boolean
Indicates whether the transaction should be processed asynchronously from our downstream CreditCard Acquirers. When set to true, the request will return immediately with a status indicating that processing is ongoing.

Responses


Status

getTransaction

Get Transaction

Retrieve transaction details using your External Transaction ID


/transaction

Usage and SDK Samples

curl -X GET \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json" \
 "https://npgw.xyz/merchant-v1/transaction?merchantId=merchantId_example&externalTransactionId=externalTransactionId_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.StatusApi;

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

public class StatusApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: apiKeyAuth
        ApiKeyAuth apiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("apiKeyAuth");
        apiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //apiKeyAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        StatusApi apiInstance = new StatusApi();
        String merchantId = merchantId_example; // String | 
        String externalTransactionId = externalTransactionId_example; // String | 

        try {
            TransactionResponse result = apiInstance.getTransaction(merchantId, externalTransactionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StatusApi#getTransaction");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String merchantId = new String(); // String | 
final String externalTransactionId = new String(); // String | 

try {
    final result = await api_instance.getTransaction(merchantId, externalTransactionId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getTransaction: $e\n');
}

import org.openapitools.client.api.StatusApi;

public class StatusApiExample {
    public static void main(String[] args) {
        StatusApi apiInstance = new StatusApi();
        String merchantId = merchantId_example; // String | 
        String externalTransactionId = externalTransactionId_example; // String | 

        try {
            TransactionResponse result = apiInstance.getTransaction(merchantId, externalTransactionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StatusApi#getTransaction");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: apiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
StatusApi *apiInstance = [[StatusApi alloc] init];
String *merchantId = merchantId_example; //  (default to null)
String *externalTransactionId = externalTransactionId_example; //  (default to null)

// Get Transaction
[apiInstance getTransactionWith:merchantId
    externalTransactionId:externalTransactionId
              completionHandler: ^(TransactionResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NpgwMerchantApi = require('npgw_merchant_api');
var defaultClient = NpgwMerchantApi.ApiClient.instance;

// Configure API key authorization: apiKeyAuth
var apiKeyAuth = defaultClient.authentications['apiKeyAuth'];
apiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKeyAuth.apiKeyPrefix['Authorization'] = "Token";

// Create an instance of the API class
var api = new NpgwMerchantApi.StatusApi()
var merchantId = merchantId_example; // {String} 
var externalTransactionId = externalTransactionId_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTransaction(merchantId, externalTransactionId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getTransactionExample
    {
        public void main()
        {
            // Configure API key authorization: apiKeyAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new StatusApi();
            var merchantId = merchantId_example;  // String |  (default to null)
            var externalTransactionId = externalTransactionId_example;  // String |  (default to null)

            try {
                // Get Transaction
                TransactionResponse result = apiInstance.getTransaction(merchantId, externalTransactionId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling StatusApi.getTransaction: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: apiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\StatusApi();
$merchantId = merchantId_example; // String | 
$externalTransactionId = externalTransactionId_example; // String | 

try {
    $result = $api_instance->getTransaction($merchantId, $externalTransactionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StatusApi->getTransaction: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::StatusApi;

# Configure API key authorization: apiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::StatusApi->new();
my $merchantId = merchantId_example; # String | 
my $externalTransactionId = externalTransactionId_example; # String | 

eval {
    my $result = $api_instance->getTransaction(merchantId => $merchantId, externalTransactionId => $externalTransactionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StatusApi->getTransaction: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: apiKeyAuth
openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.StatusApi()
merchantId = merchantId_example # String |  (default to null)
externalTransactionId = externalTransactionId_example # String |  (default to null)

try:
    # Get Transaction
    api_response = api_instance.get_transaction(merchantId, externalTransactionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StatusApi->getTransaction: %s\n" % e)
extern crate StatusApi;

pub fn main() {
    let merchantId = merchantId_example; // String
    let externalTransactionId = externalTransactionId_example; // String

    let mut context = StatusApi::Context::default();
    let result = client.getTransaction(merchantId, externalTransactionId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
merchantId*
String
Required
externalTransactionId*
String
Required

Responses


getTransactionById

Get Transaction by ID

Retrieve transaction details using the NPGW Transaction ID


/transaction/{transactionId}

Usage and SDK Samples

curl -X GET \
-H "Authorization: [[apiKey]]" \
 -H "Accept: application/json" \
 "https://npgw.xyz/merchant-v1/transaction/{transactionId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.StatusApi;

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

public class StatusApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: apiKeyAuth
        ApiKeyAuth apiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("apiKeyAuth");
        apiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //apiKeyAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        StatusApi apiInstance = new StatusApi();
        String transactionId = transactionId_example; // String | 

        try {
            TransactionResponse result = apiInstance.getTransactionById(transactionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StatusApi#getTransactionById");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String transactionId = new String(); // String | 

try {
    final result = await api_instance.getTransactionById(transactionId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getTransactionById: $e\n');
}

import org.openapitools.client.api.StatusApi;

public class StatusApiExample {
    public static void main(String[] args) {
        StatusApi apiInstance = new StatusApi();
        String transactionId = transactionId_example; // String | 

        try {
            TransactionResponse result = apiInstance.getTransactionById(transactionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StatusApi#getTransactionById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: apiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


// Create an instance of the API class
StatusApi *apiInstance = [[StatusApi alloc] init];
String *transactionId = transactionId_example; //  (default to null)

// Get Transaction by ID
[apiInstance getTransactionByIdWith:transactionId
              completionHandler: ^(TransactionResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NpgwMerchantApi = require('npgw_merchant_api');
var defaultClient = NpgwMerchantApi.ApiClient.instance;

// Configure API key authorization: apiKeyAuth
var apiKeyAuth = defaultClient.authentications['apiKeyAuth'];
apiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKeyAuth.apiKeyPrefix['Authorization'] = "Token";

// Create an instance of the API class
var api = new NpgwMerchantApi.StatusApi()
var transactionId = transactionId_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTransactionById(transactionId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getTransactionByIdExample
    {
        public void main()
        {
            // Configure API key authorization: apiKeyAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            // Create an instance of the API class
            var apiInstance = new StatusApi();
            var transactionId = transactionId_example;  // String |  (default to null)

            try {
                // Get Transaction by ID
                TransactionResponse result = apiInstance.getTransactionById(transactionId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling StatusApi.getTransactionById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: apiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\StatusApi();
$transactionId = transactionId_example; // String | 

try {
    $result = $api_instance->getTransactionById($transactionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StatusApi->getTransactionById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::StatusApi;

# Configure API key authorization: apiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::StatusApi->new();
my $transactionId = transactionId_example; # String | 

eval {
    my $result = $api_instance->getTransactionById(transactionId => $transactionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StatusApi->getTransactionById: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: apiKeyAuth
openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.StatusApi()
transactionId = transactionId_example # String |  (default to null)

try:
    # Get Transaction by ID
    api_response = api_instance.get_transaction_by_id(transactionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StatusApi->getTransactionById: %s\n" % e)
extern crate StatusApi;

pub fn main() {
    let transactionId = transactionId_example; // String

    let mut context = StatusApi::Context::default();
    let result = client.getTransactionById(transactionId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
transactionId*
String
Required

Responses