XFT Global Payments

GlobalPayments

createPayment

Initiate Payments

Initiate Payments


/payments

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"https://api.payments.xft.com/payment/v2/payments"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GlobalPaymentsApi;

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

public class GlobalPaymentsApiExample {

    public static void main(String[] args) {
        
        GlobalPaymentsApi apiInstance = new GlobalPaymentsApi();
        Payment body = {
  "$ref" : "#/components/examples/RealTimeUKFPS"
}; // Payment | Representation of a Payment Initiation Request
        IdempotencyKey idempotencyKey = ; // IdempotencyKey | Client generated unique idempotency key used in recognizing consecutive retries of the same request

**Usage of V4 UUIDs is recommended.**
        RequestId requestId = ; // RequestId | Client generated identifier for the current request invocation.
If provided, this identifier will be included in error responses to assist in problem diagnosis.
        try {
            PaymentInitiationResponse result = apiInstance.createPayment(body, idempotencyKey, requestId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlobalPaymentsApi#createPayment");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GlobalPaymentsApi;

public class GlobalPaymentsApiExample {

    public static void main(String[] args) {
        GlobalPaymentsApi apiInstance = new GlobalPaymentsApi();
        Payment body = {
  "$ref" : "#/components/examples/RealTimeUKFPS"
}; // Payment | Representation of a Payment Initiation Request
        IdempotencyKey idempotencyKey = ; // IdempotencyKey | Client generated unique idempotency key used in recognizing consecutive retries of the same request

**Usage of V4 UUIDs is recommended.**
        RequestId requestId = ; // RequestId | Client generated identifier for the current request invocation.
If provided, this identifier will be included in error responses to assist in problem diagnosis.
        try {
            PaymentInitiationResponse result = apiInstance.createPayment(body, idempotencyKey, requestId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlobalPaymentsApi#createPayment");
            e.printStackTrace();
        }
    }
}
Payment *body = {
  "$ref" : "#/components/examples/RealTimeUKFPS"
}; // Representation of a Payment Initiation Request
IdempotencyKey *idempotencyKey = ; // Client generated unique idempotency key used in recognizing consecutive retries of the same request

**Usage of V4 UUIDs is recommended.** (optional)
RequestId *requestId = ; // Client generated identifier for the current request invocation.
If provided, this identifier will be included in error responses to assist in problem diagnosis. (optional)

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

// Initiate Payments
[apiInstance createPaymentWith:body
    idempotencyKey:idempotencyKey
    requestId:requestId
              completionHandler: ^(PaymentInitiationResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var XftGlobalPayments = require('xft_global_payments');

var api = new XftGlobalPayments.GlobalPaymentsApi()
var body = {
  "$ref" : "#/components/examples/RealTimeUKFPS"
}; // {{Payment}} Representation of a Payment Initiation Request
var opts = { 
  'idempotencyKey':  // {{IdempotencyKey}} Client generated unique idempotency key used in recognizing consecutive retries of the same request

**Usage of V4 UUIDs is recommended.**
  'requestId':  // {{RequestId}} Client generated identifier for the current request invocation.
If provided, this identifier will be included in error responses to assist in problem diagnosis.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createPayment(body, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new GlobalPaymentsApi();
            var body = new Payment(); // Payment | Representation of a Payment Initiation Request
            var idempotencyKey = new IdempotencyKey(); // IdempotencyKey | Client generated unique idempotency key used in recognizing consecutive retries of the same request

**Usage of V4 UUIDs is recommended.** (optional) 
            var requestId = new RequestId(); // RequestId | Client generated identifier for the current request invocation.
If provided, this identifier will be included in error responses to assist in problem diagnosis. (optional) 

            try
            {
                // Initiate Payments
                PaymentInitiationResponse result = apiInstance.createPayment(body, idempotencyKey, requestId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GlobalPaymentsApi.createPayment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiGlobalPaymentsApi();
$body = {
  "$ref" : "#/components/examples/RealTimeUKFPS"
}; // Payment | Representation of a Payment Initiation Request
$idempotencyKey = ; // IdempotencyKey | Client generated unique idempotency key used in recognizing consecutive retries of the same request

**Usage of V4 UUIDs is recommended.**
$requestId = ; // RequestId | Client generated identifier for the current request invocation.
If provided, this identifier will be included in error responses to assist in problem diagnosis.

try {
    $result = $api_instance->createPayment($body, $idempotencyKey, $requestId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GlobalPaymentsApi->createPayment: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GlobalPaymentsApi;

my $api_instance = WWW::SwaggerClient::GlobalPaymentsApi->new();
my $body = WWW::SwaggerClient::Object::Payment->new(); # Payment | Representation of a Payment Initiation Request
my $idempotencyKey = ; # IdempotencyKey | Client generated unique idempotency key used in recognizing consecutive retries of the same request

**Usage of V4 UUIDs is recommended.**
my $requestId = ; # RequestId | Client generated identifier for the current request invocation.
If provided, this identifier will be included in error responses to assist in problem diagnosis.

eval { 
    my $result = $api_instance->createPayment(body => $body, idempotencyKey => $idempotencyKey, requestId => $requestId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GlobalPaymentsApi->createPayment: $@\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.GlobalPaymentsApi()
body = {
  "$ref" : "#/components/examples/RealTimeUKFPS"
} # Payment | Representation of a Payment Initiation Request
idempotencyKey =  # IdempotencyKey | Client generated unique idempotency key used in recognizing consecutive retries of the same request

**Usage of V4 UUIDs is recommended.** (optional)
requestId =  # RequestId | Client generated identifier for the current request invocation.
If provided, this identifier will be included in error responses to assist in problem diagnosis. (optional)

try: 
    # Initiate Payments
    api_response = api_instance.create_payment(body, idempotencyKey=idempotencyKey, requestId=requestId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GlobalPaymentsApi->createPayment: %s\n" % e)

Parameters

Header parameters
Name Description
Idempotency-Key
IdempotencyKey
Client generated unique idempotency key used in recognizing consecutive retries of the same request **Usage of V4 UUIDs is recommended.**
Request-Id
RequestId
Client generated identifier for the current request invocation. If provided, this identifier will be included in error responses to assist in problem diagnosis.
Body parameters
Name Description
body *

Responses

Status: 202 - Payment has been accepted for processing

Status: 400 - Bad Request. **List of Error codes and Usage explanations.** | Error Code | Usage | | -------------- |------------------------------------------------| | 10001 | Mandatory field missing | | 10002 | Minimum length violation | | 10003 | Maximum length violation | | 10100 | Minimum value violation | | 10101 | Maximum value violation | | 10102 | Range violation | | 10103 | Bad format | | 10104 | Bad value | | 10105 | Unexpected field | | 10106 | Idempotency failure | | 10107 | Concurrent request failure | | 10199 | Other | | 11000 - 11499 | Account/Permission Problems | | 11500 - 11999 | General Business Errors | | 12000 - 12499 | Timeouts | | 12500 - 12999 | Service Offline | | 13000 | Other Errors | | 14000 | Security Failure | | 15000 | System Error |

Status: 401 - Unauthorized

Status: 403 - Forbidden. | Error Code | Description | |---------------|--------------------------------------------| | 14000 | Security failure |

Status: 422 - Unprocessable Entity

Status: 503 - Service unavailable.


getPayment

Retrieve Payment Details by paymentId

<!-- theme: warning --> > This operation is applicable only to RTP and Alternate payments, and does not apply to ACH or WIRES. Any request for ACH or WIRES will result in a 404 Not Found error. > Retrieve details of a payment by providing the `paymentId`


/payments/{paymentId}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"https://api.payments.xft.com/payment/v2/payments/{paymentId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GlobalPaymentsApi;

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

public class GlobalPaymentsApiExample {

    public static void main(String[] args) {
        
        GlobalPaymentsApi apiInstance = new GlobalPaymentsApi();
        PaymentId paymentId = ; // PaymentId | JPMC generated payment identifier
        RequestId requestId = ; // RequestId | Client generated identifier for the current request invocation.
If provided, this identifier will be included in error responses to assist in problem diagnosis.
        try {
            PaymentDetail result = apiInstance.getPayment(paymentId, requestId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlobalPaymentsApi#getPayment");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GlobalPaymentsApi;

public class GlobalPaymentsApiExample {

    public static void main(String[] args) {
        GlobalPaymentsApi apiInstance = new GlobalPaymentsApi();
        PaymentId paymentId = ; // PaymentId | JPMC generated payment identifier
        RequestId requestId = ; // RequestId | Client generated identifier for the current request invocation.
If provided, this identifier will be included in error responses to assist in problem diagnosis.
        try {
            PaymentDetail result = apiInstance.getPayment(paymentId, requestId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlobalPaymentsApi#getPayment");
            e.printStackTrace();
        }
    }
}
PaymentId *paymentId = ; // JPMC generated payment identifier
RequestId *requestId = ; // Client generated identifier for the current request invocation.
If provided, this identifier will be included in error responses to assist in problem diagnosis. (optional)

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

// Retrieve Payment Details by paymentId
[apiInstance getPaymentWith:paymentId
    requestId:requestId
              completionHandler: ^(PaymentDetail output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var XftGlobalPayments = require('xft_global_payments');

var api = new XftGlobalPayments.GlobalPaymentsApi()
var paymentId = ; // {{PaymentId}} JPMC generated payment identifier
var opts = { 
  'requestId':  // {{RequestId}} Client generated identifier for the current request invocation.
If provided, this identifier will be included in error responses to assist in problem diagnosis.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPayment(paymentId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new GlobalPaymentsApi();
            var paymentId = new PaymentId(); // PaymentId | JPMC generated payment identifier
            var requestId = new RequestId(); // RequestId | Client generated identifier for the current request invocation.
If provided, this identifier will be included in error responses to assist in problem diagnosis. (optional) 

            try
            {
                // Retrieve Payment Details by paymentId
                PaymentDetail result = apiInstance.getPayment(paymentId, requestId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GlobalPaymentsApi.getPayment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiGlobalPaymentsApi();
$paymentId = ; // PaymentId | JPMC generated payment identifier
$requestId = ; // RequestId | Client generated identifier for the current request invocation.
If provided, this identifier will be included in error responses to assist in problem diagnosis.

try {
    $result = $api_instance->getPayment($paymentId, $requestId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GlobalPaymentsApi->getPayment: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GlobalPaymentsApi;

my $api_instance = WWW::SwaggerClient::GlobalPaymentsApi->new();
my $paymentId = ; # PaymentId | JPMC generated payment identifier
my $requestId = ; # RequestId | Client generated identifier for the current request invocation.
If provided, this identifier will be included in error responses to assist in problem diagnosis.

eval { 
    my $result = $api_instance->getPayment(paymentId => $paymentId, requestId => $requestId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GlobalPaymentsApi->getPayment: $@\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.GlobalPaymentsApi()
paymentId =  # PaymentId | JPMC generated payment identifier
requestId =  # RequestId | Client generated identifier for the current request invocation.
If provided, this identifier will be included in error responses to assist in problem diagnosis. (optional)

try: 
    # Retrieve Payment Details by paymentId
    api_response = api_instance.get_payment(paymentId, requestId=requestId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GlobalPaymentsApi->getPayment: %s\n" % e)

Parameters

Path parameters
Name Description
paymentId*
PaymentId
JPMC generated payment identifier
Required
Header parameters
Name Description
Request-Id
RequestId
Client generated identifier for the current request invocation. If provided, this identifier will be included in error responses to assist in problem diagnosis.

Responses

Status: 200 - Success

Status: 400 - Bad Request. **List of Error codes and Usage explanations.** | Error Code | Usage | | -------------- |------------------------------------------------| | 10001 | Mandatory field missing | | 10002 | Minimum length violation | | 10003 | Maximum length violation | | 10100 | Minimum value violation | | 10101 | Maximum value violation | | 10102 | Range violation | | 10103 | Bad format | | 10104 | Bad value | | 10105 | Unexpected field | | 10106 | Idempotency failure | | 10107 | Concurrent request failure | | 10199 | Other | | 11000 - 11499 | Account/Permission Problems | | 11500 - 11999 | General Business Errors | | 12000 - 12499 | Timeouts | | 12500 - 12999 | Service Offline | | 13000 | Other Errors | | 14000 | Security Failure | | 15000 | System Error |

Status: 401 - Unauthorized

Status: 403 - Forbidden. | Error Code | Description | |---------------|--------------------------------------------| | 14000 | Security failure |

Status: 404 - Not Found

Status: 503 - Service unavailable.


getPaymentStatus

Retrieve Payment Status by paymentId

<!-- theme: warning --> > This operation is applicable only to RTP and Alternate payments, and does not apply to ACH or WIRES. Any request for ACH or WIRES will result in a 404 Not Found error. > Retrieve status of a payment by providing the `paymentId`


/payments/{paymentId}/status

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"https://api.payments.xft.com/payment/v2/payments/{paymentId}/status"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GlobalPaymentsApi;

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

public class GlobalPaymentsApiExample {

    public static void main(String[] args) {
        
        GlobalPaymentsApi apiInstance = new GlobalPaymentsApi();
        PaymentId paymentId = ; // PaymentId | JPMC generated payment identifier
        RequestId requestId = ; // RequestId | Client generated identifier for the current request invocation.
If provided, this identifier will be included in error responses to assist in problem diagnosis.
        try {
            PaymentStatus result = apiInstance.getPaymentStatus(paymentId, requestId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlobalPaymentsApi#getPaymentStatus");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GlobalPaymentsApi;

public class GlobalPaymentsApiExample {

    public static void main(String[] args) {
        GlobalPaymentsApi apiInstance = new GlobalPaymentsApi();
        PaymentId paymentId = ; // PaymentId | JPMC generated payment identifier
        RequestId requestId = ; // RequestId | Client generated identifier for the current request invocation.
If provided, this identifier will be included in error responses to assist in problem diagnosis.
        try {
            PaymentStatus result = apiInstance.getPaymentStatus(paymentId, requestId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlobalPaymentsApi#getPaymentStatus");
            e.printStackTrace();
        }
    }
}
PaymentId *paymentId = ; // JPMC generated payment identifier
RequestId *requestId = ; // Client generated identifier for the current request invocation.
If provided, this identifier will be included in error responses to assist in problem diagnosis. (optional)

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

// Retrieve Payment Status by paymentId
[apiInstance getPaymentStatusWith:paymentId
    requestId:requestId
              completionHandler: ^(PaymentStatus output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var XftGlobalPayments = require('xft_global_payments');

var api = new XftGlobalPayments.GlobalPaymentsApi()
var paymentId = ; // {{PaymentId}} JPMC generated payment identifier
var opts = { 
  'requestId':  // {{RequestId}} Client generated identifier for the current request invocation.
If provided, this identifier will be included in error responses to assist in problem diagnosis.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPaymentStatus(paymentId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new GlobalPaymentsApi();
            var paymentId = new PaymentId(); // PaymentId | JPMC generated payment identifier
            var requestId = new RequestId(); // RequestId | Client generated identifier for the current request invocation.
If provided, this identifier will be included in error responses to assist in problem diagnosis. (optional) 

            try
            {
                // Retrieve Payment Status by paymentId
                PaymentStatus result = apiInstance.getPaymentStatus(paymentId, requestId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GlobalPaymentsApi.getPaymentStatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiGlobalPaymentsApi();
$paymentId = ; // PaymentId | JPMC generated payment identifier
$requestId = ; // RequestId | Client generated identifier for the current request invocation.
If provided, this identifier will be included in error responses to assist in problem diagnosis.

try {
    $result = $api_instance->getPaymentStatus($paymentId, $requestId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GlobalPaymentsApi->getPaymentStatus: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GlobalPaymentsApi;

my $api_instance = WWW::SwaggerClient::GlobalPaymentsApi->new();
my $paymentId = ; # PaymentId | JPMC generated payment identifier
my $requestId = ; # RequestId | Client generated identifier for the current request invocation.
If provided, this identifier will be included in error responses to assist in problem diagnosis.

eval { 
    my $result = $api_instance->getPaymentStatus(paymentId => $paymentId, requestId => $requestId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GlobalPaymentsApi->getPaymentStatus: $@\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.GlobalPaymentsApi()
paymentId =  # PaymentId | JPMC generated payment identifier
requestId =  # RequestId | Client generated identifier for the current request invocation.
If provided, this identifier will be included in error responses to assist in problem diagnosis. (optional)

try: 
    # Retrieve Payment Status by paymentId
    api_response = api_instance.get_payment_status(paymentId, requestId=requestId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GlobalPaymentsApi->getPaymentStatus: %s\n" % e)

Parameters

Path parameters
Name Description
paymentId*
PaymentId
JPMC generated payment identifier
Required
Header parameters
Name Description
Request-Id
RequestId
Client generated identifier for the current request invocation. If provided, this identifier will be included in error responses to assist in problem diagnosis.

Responses

Status: 200 - Success

Status: 400 - Bad Request. **List of Error codes and Usage explanations.** | Error Code | Usage | | -------------- |------------------------------------------------| | 10001 | Mandatory field missing | | 10002 | Minimum length violation | | 10003 | Maximum length violation | | 10100 | Minimum value violation | | 10101 | Maximum value violation | | 10102 | Range violation | | 10103 | Bad format | | 10104 | Bad value | | 10105 | Unexpected field | | 10106 | Idempotency failure | | 10107 | Concurrent request failure | | 10199 | Other | | 11000 - 11499 | Account/Permission Problems | | 11500 - 11999 | General Business Errors | | 12000 - 12499 | Timeouts | | 12500 - 12999 | Service Offline | | 13000 | Other Errors | | 14000 | Security Failure | | 15000 | System Error |

Status: 401 - Unauthorized

Status: 403 - Forbidden. | Error Code | Description | |---------------|--------------------------------------------| | 14000 | Security failure |

Status: 404 - Not Found

Status: 429 - Too Many Requests

Status: 503 - Service unavailable.


getPayments

Query Payments by endToEndId

<!-- theme: success --> > Query Payments by `endToEndId`, specify a `paymentType` to optimize query execution and `view` to **summarize** or **detail** the response.


/payments

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"https://api.payments.xft.com/payment/v2/payments?endToEndId=&view=&paymentType="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GlobalPaymentsApi;

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

public class GlobalPaymentsApiExample {

    public static void main(String[] args) {
        
        GlobalPaymentsApi apiInstance = new GlobalPaymentsApi();
        EndToEndId endToEndId = ; // EndToEndId | Customer assigned Unique identifier to unambiguously identify the Payment transaction.
This identification is passed on, unchanged, throughout the entire end-to-end chain.
        View view = ; // View | Determines whether only the payment status or the full payment information is returned.
- If `SUMMARY` is provided, only the status and identifiers are returned.
- If `FULL` is provided, the complete payment details is returned.
        PaymentType paymentType = ; // PaymentType | Payment type.
**Providing paymentType is optional but when provided, it enhances both query efficiency and response times.**

        RequestId requestId = ; // RequestId | Client generated identifier for the current request invocation.
If provided, this identifier will be included in error responses to assist in problem diagnosis.
        try {
            PaymentDetail result = apiInstance.getPayments(endToEndId, view, paymentType, requestId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlobalPaymentsApi#getPayments");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GlobalPaymentsApi;

public class GlobalPaymentsApiExample {

    public static void main(String[] args) {
        GlobalPaymentsApi apiInstance = new GlobalPaymentsApi();
        EndToEndId endToEndId = ; // EndToEndId | Customer assigned Unique identifier to unambiguously identify the Payment transaction.
This identification is passed on, unchanged, throughout the entire end-to-end chain.
        View view = ; // View | Determines whether only the payment status or the full payment information is returned.
- If `SUMMARY` is provided, only the status and identifiers are returned.
- If `FULL` is provided, the complete payment details is returned.
        PaymentType paymentType = ; // PaymentType | Payment type.
**Providing paymentType is optional but when provided, it enhances both query efficiency and response times.**

        RequestId requestId = ; // RequestId | Client generated identifier for the current request invocation.
If provided, this identifier will be included in error responses to assist in problem diagnosis.
        try {
            PaymentDetail result = apiInstance.getPayments(endToEndId, view, paymentType, requestId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlobalPaymentsApi#getPayments");
            e.printStackTrace();
        }
    }
}
EndToEndId *endToEndId = ; // Customer assigned Unique identifier to unambiguously identify the Payment transaction.
This identification is passed on, unchanged, throughout the entire end-to-end chain.
View *view = ; // Determines whether only the payment status or the full payment information is returned.
- If `SUMMARY` is provided, only the status and identifiers are returned.
- If `FULL` is provided, the complete payment details is returned.
PaymentType *paymentType = ; // Payment type.
**Providing paymentType is optional but when provided, it enhances both query efficiency and response times.**
 (optional)
RequestId *requestId = ; // Client generated identifier for the current request invocation.
If provided, this identifier will be included in error responses to assist in problem diagnosis. (optional)

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

// Query Payments by endToEndId
[apiInstance getPaymentsWith:endToEndId
    view:view
    paymentType:paymentType
    requestId:requestId
              completionHandler: ^(PaymentDetail output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var XftGlobalPayments = require('xft_global_payments');

var api = new XftGlobalPayments.GlobalPaymentsApi()
var endToEndId = ; // {{EndToEndId}} Customer assigned Unique identifier to unambiguously identify the Payment transaction.
This identification is passed on, unchanged, throughout the entire end-to-end chain.
var view = ; // {{View}} Determines whether only the payment status or the full payment information is returned.
- If `SUMMARY` is provided, only the status and identifiers are returned.
- If `FULL` is provided, the complete payment details is returned.
var opts = { 
  'paymentType': , // {{PaymentType}} Payment type.
**Providing paymentType is optional but when provided, it enhances both query efficiency and response times.**

  'requestId':  // {{RequestId}} Client generated identifier for the current request invocation.
If provided, this identifier will be included in error responses to assist in problem diagnosis.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPayments(endToEndId, view, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new GlobalPaymentsApi();
            var endToEndId = new EndToEndId(); // EndToEndId | Customer assigned Unique identifier to unambiguously identify the Payment transaction.
This identification is passed on, unchanged, throughout the entire end-to-end chain.
            var view = new View(); // View | Determines whether only the payment status or the full payment information is returned.
- If `SUMMARY` is provided, only the status and identifiers are returned.
- If `FULL` is provided, the complete payment details is returned.
            var paymentType = new PaymentType(); // PaymentType | Payment type.
**Providing paymentType is optional but when provided, it enhances both query efficiency and response times.**
 (optional) 
            var requestId = new RequestId(); // RequestId | Client generated identifier for the current request invocation.
If provided, this identifier will be included in error responses to assist in problem diagnosis. (optional) 

            try
            {
                // Query Payments by endToEndId
                PaymentDetail result = apiInstance.getPayments(endToEndId, view, paymentType, requestId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GlobalPaymentsApi.getPayments: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiGlobalPaymentsApi();
$endToEndId = ; // EndToEndId | Customer assigned Unique identifier to unambiguously identify the Payment transaction.
This identification is passed on, unchanged, throughout the entire end-to-end chain.
$view = ; // View | Determines whether only the payment status or the full payment information is returned.
- If `SUMMARY` is provided, only the status and identifiers are returned.
- If `FULL` is provided, the complete payment details is returned.
$paymentType = ; // PaymentType | Payment type.
**Providing paymentType is optional but when provided, it enhances both query efficiency and response times.**

$requestId = ; // RequestId | Client generated identifier for the current request invocation.
If provided, this identifier will be included in error responses to assist in problem diagnosis.

try {
    $result = $api_instance->getPayments($endToEndId, $view, $paymentType, $requestId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GlobalPaymentsApi->getPayments: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GlobalPaymentsApi;

my $api_instance = WWW::SwaggerClient::GlobalPaymentsApi->new();
my $endToEndId = ; # EndToEndId | Customer assigned Unique identifier to unambiguously identify the Payment transaction.
This identification is passed on, unchanged, throughout the entire end-to-end chain.
my $view = ; # View | Determines whether only the payment status or the full payment information is returned.
- If `SUMMARY` is provided, only the status and identifiers are returned.
- If `FULL` is provided, the complete payment details is returned.
my $paymentType = ; # PaymentType | Payment type.
**Providing paymentType is optional but when provided, it enhances both query efficiency and response times.**

my $requestId = ; # RequestId | Client generated identifier for the current request invocation.
If provided, this identifier will be included in error responses to assist in problem diagnosis.

eval { 
    my $result = $api_instance->getPayments(endToEndId => $endToEndId, view => $view, paymentType => $paymentType, requestId => $requestId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GlobalPaymentsApi->getPayments: $@\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.GlobalPaymentsApi()
endToEndId =  # EndToEndId | Customer assigned Unique identifier to unambiguously identify the Payment transaction.
This identification is passed on, unchanged, throughout the entire end-to-end chain.
view =  # View | Determines whether only the payment status or the full payment information is returned.
- If `SUMMARY` is provided, only the status and identifiers are returned.
- If `FULL` is provided, the complete payment details is returned.
paymentType =  # PaymentType | Payment type.
**Providing paymentType is optional but when provided, it enhances both query efficiency and response times.**
 (optional)
requestId =  # RequestId | Client generated identifier for the current request invocation.
If provided, this identifier will be included in error responses to assist in problem diagnosis. (optional)

try: 
    # Query Payments by endToEndId
    api_response = api_instance.get_payments(endToEndId, view, paymentType=paymentType, requestId=requestId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GlobalPaymentsApi->getPayments: %s\n" % e)

Parameters

Header parameters
Name Description
Request-Id
RequestId
Client generated identifier for the current request invocation. If provided, this identifier will be included in error responses to assist in problem diagnosis.
Query parameters
Name Description
endToEndId*
EndToEndId
Customer assigned Unique identifier to unambiguously identify the Payment transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.
Required
view*
View
Determines whether only the payment status or the full payment information is returned. - If `SUMMARY` is provided, only the status and identifiers are returned. - If `FULL` is provided, the complete payment details is returned.
Required
paymentType
PaymentType
Payment type. **Providing paymentType is optional but when provided, it enhances both query efficiency and response times.**

Responses

Status: 200 - Success

Status: 400 - Bad Request. **List of Error codes and Usage explanations.** | Error Code | Usage | | -------------- |------------------------------------------------| | 10001 | Mandatory field missing | | 10002 | Minimum length violation | | 10003 | Maximum length violation | | 10100 | Minimum value violation | | 10101 | Maximum value violation | | 10102 | Range violation | | 10103 | Bad format | | 10104 | Bad value | | 10105 | Unexpected field | | 10106 | Idempotency failure | | 10107 | Concurrent request failure | | 10199 | Other | | 11000 - 11499 | Account/Permission Problems | | 11500 - 11999 | General Business Errors | | 12000 - 12499 | Timeouts | | 12500 - 12999 | Service Offline | | 13000 | Other Errors | | 14000 | Security Failure | | 15000 | System Error |

Status: 401 - Unauthorized

Status: 403 - Forbidden. | Error Code | Description | |---------------|--------------------------------------------| | 14000 | Security failure |

Status: 404 - Not Found

Status: 503 - Service unavailable.