Payment Execution API specification


AccountResource

getAccountsBalance

Given a list of accountIds returns the balance of each account in crypto and fiat currency. Fiat currency may not be present if at the time of the request the exchange rate is not available.


/accounts/balance

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"https://psp.example.com/accounts/balance"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccountResourceApi;

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

public class AccountResourceApiExample {

    public static void main(String[] args) {

        AccountResourceApi apiInstance = new AccountResourceApi();
        AccountBalanceFiltersDto body = ; // AccountBalanceFiltersDto |
        String key = key_example; // String | key of the client
        String signature = signature_example; // String | Client signature for this request
        try {
            AccountBalanceResponseDto result = apiInstance.getAccountsBalance(body, key, signature);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountResourceApi#getAccountsBalance");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AccountResourceApi;

public class AccountResourceApiExample {

    public static void main(String[] args) {
        AccountResourceApi apiInstance = new AccountResourceApi();
        AccountBalanceFiltersDto body = ; // AccountBalanceFiltersDto |
        String key = key_example; // String | key of the client
        String signature = signature_example; // String | Client signature for this request
        try {
            AccountBalanceResponseDto result = apiInstance.getAccountsBalance(body, key, signature);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountResourceApi#getAccountsBalance");
            e.printStackTrace();
        }
    }
}
AccountBalanceFiltersDto *body = ; //
String *key = key_example; // key of the client
String *signature = signature_example; // Client signature for this request

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

[apiInstance getAccountsBalanceWith:body
    key:key
    signature:signature
              completionHandler: ^(AccountBalanceResponseDto output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Psp = require('psp');

var api = new Psp.AccountResourceApi()
var body = ; // {{AccountBalanceFiltersDto}}
var key = key_example; // {{String}} key of the client
var signature = signature_example; // {{String}} Client signature for this request

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

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

            var apiInstance = new AccountResourceApi();
            var body = new AccountBalanceFiltersDto(); // AccountBalanceFiltersDto |
            var key = key_example;  // String | key of the client
            var signature = signature_example;  // String | Client signature for this request

            try
            {
                AccountBalanceResponseDto result = apiInstance.getAccountsBalance(body, key, signature);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountResourceApi.getAccountsBalance: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAccountResourceApi();
$body = ; // AccountBalanceFiltersDto |
$key = key_example; // String | key of the client
$signature = signature_example; // String | Client signature for this request

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

my $api_instance = WWW::SwaggerClient::AccountResourceApi->new();
my $body = WWW::SwaggerClient::Object::AccountBalanceFiltersDto->new(); # AccountBalanceFiltersDto |
my $key = key_example; # String | key of the client
my $signature = signature_example; # String | Client signature for this request

eval {
    my $result = $api_instance->getAccountsBalance(body => $body, key => $key, signature => $signature);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccountResourceApi->getAccountsBalance: $@\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.AccountResourceApi()
body =  # AccountBalanceFiltersDto |
key = key_example # String | key of the client
signature = signature_example # String | Client signature for this request

try:
    api_response = api_instance.get_accounts_balance(body, key, signature)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountResourceApi->getAccountsBalance: %s\n" % e)

Parameters

Header parameters
Name Description
key*
String
key of the client
Required
signature*
String
Client signature for this request
Required
Body parameters
Name Description
body *

Responses

Status: 200 - Current balance of the queried accounts


DepositResource

createDeposit

Create a Deposit


/deposits/create

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"https://psp.example.com/deposits/create"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DepositResourceApi;

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

public class DepositResourceApiExample {

    public static void main(String[] args) {

        DepositResourceApi apiInstance = new DepositResourceApi();
        CreateDepositRequestDto body = ; // CreateDepositRequestDto |
        String key = key_example; // String | key of the client
        String signature = signature_example; // String | Client signature for this request
        try {
            DepositCreatedDto result = apiInstance.createDeposit(body, key, signature);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DepositResourceApi#createDeposit");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DepositResourceApi;

public class DepositResourceApiExample {

    public static void main(String[] args) {
        DepositResourceApi apiInstance = new DepositResourceApi();
        CreateDepositRequestDto body = ; // CreateDepositRequestDto |
        String key = key_example; // String | key of the client
        String signature = signature_example; // String | Client signature for this request
        try {
            DepositCreatedDto result = apiInstance.createDeposit(body, key, signature);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DepositResourceApi#createDeposit");
            e.printStackTrace();
        }
    }
}
CreateDepositRequestDto *body = ; //
String *key = key_example; // key of the client
String *signature = signature_example; // Client signature for this request

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

[apiInstance createDepositWith:body
    key:key
    signature:signature
              completionHandler: ^(DepositCreatedDto output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Psp = require('psp');

var api = new Psp.DepositResourceApi()
var body = ; // {{CreateDepositRequestDto}}
var key = key_example; // {{String}} key of the client
var signature = signature_example; // {{String}} Client signature for this request

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

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

            var apiInstance = new DepositResourceApi();
            var body = new CreateDepositRequestDto(); // CreateDepositRequestDto |
            var key = key_example;  // String | key of the client
            var signature = signature_example;  // String | Client signature for this request

            try
            {
                DepositCreatedDto result = apiInstance.createDeposit(body, key, signature);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DepositResourceApi.createDeposit: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiDepositResourceApi();
$body = ; // CreateDepositRequestDto |
$key = key_example; // String | key of the client
$signature = signature_example; // String | Client signature for this request

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

my $api_instance = WWW::SwaggerClient::DepositResourceApi->new();
my $body = WWW::SwaggerClient::Object::CreateDepositRequestDto->new(); # CreateDepositRequestDto |
my $key = key_example; # String | key of the client
my $signature = signature_example; # String | Client signature for this request

eval {
    my $result = $api_instance->createDeposit(body => $body, key => $key, signature => $signature);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DepositResourceApi->createDeposit: $@\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.DepositResourceApi()
body =  # CreateDepositRequestDto |
key = key_example # String | key of the client
signature = signature_example # String | Client signature for this request

try:
    api_response = api_instance.create_deposit(body, key, signature)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DepositResourceApi->createDeposit: %s\n" % e)

Parameters

Header parameters
Name Description
key*
String
key of the client
Required
signature*
String
Client signature for this request
Required
Body parameters
Name Description
body *

Responses

Status: 202 - Deposit creation accepted

Status: 400 - Any parameter is wrong. i.e.: amount is negative, currency doesn't match with account currency, url malformed

Status: 404 - Any resource has not been found. i.e.: accountId doesn't exists

Status: 409 - Conflict error. i.e: Nonce is not valid


createDepositSynchronously

Create a Deposit synchronously


/deposits/create/sync

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"https://psp.example.com/deposits/create/sync"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DepositResourceApi;

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

public class DepositResourceApiExample {

    public static void main(String[] args) {

        DepositResourceApi apiInstance = new DepositResourceApi();
        CreateDepositRequestDto body = ; // CreateDepositRequestDto |
        String key = key_example; // String | key of the client
        String signature = signature_example; // String | Client signature for this request
        try {
            DepositDto result = apiInstance.createDepositSynchronously(body, key, signature);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DepositResourceApi#createDepositSynchronously");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DepositResourceApi;

public class DepositResourceApiExample {

    public static void main(String[] args) {
        DepositResourceApi apiInstance = new DepositResourceApi();
        CreateDepositRequestDto body = ; // CreateDepositRequestDto |
        String key = key_example; // String | key of the client
        String signature = signature_example; // String | Client signature for this request
        try {
            DepositDto result = apiInstance.createDepositSynchronously(body, key, signature);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DepositResourceApi#createDepositSynchronously");
            e.printStackTrace();
        }
    }
}
CreateDepositRequestDto *body = ; //
String *key = key_example; // key of the client
String *signature = signature_example; // Client signature for this request

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

[apiInstance createDepositSynchronouslyWith:body
    key:key
    signature:signature
              completionHandler: ^(DepositDto output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Psp = require('psp');

var api = new Psp.DepositResourceApi()
var body = ; // {{CreateDepositRequestDto}}
var key = key_example; // {{String}} key of the client
var signature = signature_example; // {{String}} Client signature for this request

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

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

            var apiInstance = new DepositResourceApi();
            var body = new CreateDepositRequestDto(); // CreateDepositRequestDto |
            var key = key_example;  // String | key of the client
            var signature = signature_example;  // String | Client signature for this request

            try
            {
                DepositDto result = apiInstance.createDepositSynchronously(body, key, signature);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DepositResourceApi.createDepositSynchronously: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiDepositResourceApi();
$body = ; // CreateDepositRequestDto |
$key = key_example; // String | key of the client
$signature = signature_example; // String | Client signature for this request

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

my $api_instance = WWW::SwaggerClient::DepositResourceApi->new();
my $body = WWW::SwaggerClient::Object::CreateDepositRequestDto->new(); # CreateDepositRequestDto |
my $key = key_example; # String | key of the client
my $signature = signature_example; # String | Client signature for this request

eval {
    my $result = $api_instance->createDepositSynchronously(body => $body, key => $key, signature => $signature);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DepositResourceApi->createDepositSynchronously: $@\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.DepositResourceApi()
body =  # CreateDepositRequestDto |
key = key_example # String | key of the client
signature = signature_example # String | Client signature for this request

try:
    api_response = api_instance.create_deposit_synchronously(body, key, signature)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DepositResourceApi->createDepositSynchronously: %s\n" % e)

Parameters

Header parameters
Name Description
key*
String
key of the client
Required
signature*
String
Client signature for this request
Required
Body parameters
Name Description
body *

Responses

Status: 201 - Deposit created

Status: 400 - Any parameter is wrong. i.e.: amount is negative, currency doesn't match with account currency, url malformed

Status: 404 - Any resource has not been found. i.e.: accountId doesn't exists

Status: 409 - Conflict error. i.e: Nonce is not valid

Status: 502 - Error during deposit creation


findDepositFilteredV2

Search Deposits details in pages


/deposits/v2/find

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"https://psp.example.com/deposits/v2/find"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DepositResourceApi;

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

public class DepositResourceApiExample {

    public static void main(String[] args) {

        DepositResourceApi apiInstance = new DepositResourceApi();
        DepositFiltersDtoV2 body = ; // DepositFiltersDtoV2 |
        String key = key_example; // String | key of the client
        String signature = signature_example; // String | Client signature for this request
        try {
            FindDepositResponseDtoV2 result = apiInstance.findDepositFilteredV2(body, key, signature);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DepositResourceApi#findDepositFilteredV2");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DepositResourceApi;

public class DepositResourceApiExample {

    public static void main(String[] args) {
        DepositResourceApi apiInstance = new DepositResourceApi();
        DepositFiltersDtoV2 body = ; // DepositFiltersDtoV2 |
        String key = key_example; // String | key of the client
        String signature = signature_example; // String | Client signature for this request
        try {
            FindDepositResponseDtoV2 result = apiInstance.findDepositFilteredV2(body, key, signature);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DepositResourceApi#findDepositFilteredV2");
            e.printStackTrace();
        }
    }
}
DepositFiltersDtoV2 *body = ; //
String *key = key_example; // key of the client
String *signature = signature_example; // Client signature for this request

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

[apiInstance findDepositFilteredV2With:body
    key:key
    signature:signature
              completionHandler: ^(FindDepositResponseDtoV2 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Psp = require('psp');

var api = new Psp.DepositResourceApi()
var body = ; // {{DepositFiltersDtoV2}}
var key = key_example; // {{String}} key of the client
var signature = signature_example; // {{String}} Client signature for this request

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

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

            var apiInstance = new DepositResourceApi();
            var body = new DepositFiltersDtoV2(); // DepositFiltersDtoV2 |
            var key = key_example;  // String | key of the client
            var signature = signature_example;  // String | Client signature for this request

            try
            {
                FindDepositResponseDtoV2 result = apiInstance.findDepositFilteredV2(body, key, signature);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DepositResourceApi.findDepositFilteredV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiDepositResourceApi();
$body = ; // DepositFiltersDtoV2 |
$key = key_example; // String | key of the client
$signature = signature_example; // String | Client signature for this request

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

my $api_instance = WWW::SwaggerClient::DepositResourceApi->new();
my $body = WWW::SwaggerClient::Object::DepositFiltersDtoV2->new(); # DepositFiltersDtoV2 |
my $key = key_example; # String | key of the client
my $signature = signature_example; # String | Client signature for this request

eval {
    my $result = $api_instance->findDepositFilteredV2(body => $body, key => $key, signature => $signature);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DepositResourceApi->findDepositFilteredV2: $@\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.DepositResourceApi()
body =  # DepositFiltersDtoV2 |
key = key_example # String | key of the client
signature = signature_example # String | Client signature for this request

try:
    api_response = api_instance.find_deposit_filtered_v2(body, key, signature)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DepositResourceApi->findDepositFilteredV2: %s\n" % e)

Parameters

Header parameters
Name Description
key*
String
key of the client
Required
signature*
String
Client signature for this request
Required
Body parameters
Name Description
body *

Responses

Status: 200 - Deposits info which match with filters is returned

Status: 409 - Conflict error. i.e: Nonce is not valid


voidDeposit

Void a Deposit


/deposits/void

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"https://psp.example.com/deposits/void"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DepositResourceApi;

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

public class DepositResourceApiExample {

    public static void main(String[] args) {

        DepositResourceApi apiInstance = new DepositResourceApi();
        VoidDepositRequestDto body = ; // VoidDepositRequestDto |
        String key = key_example; // String | key of the client
        String signature = signature_example; // String | Client signature for this request
        try {
            apiInstance.voidDeposit(body, key, signature);
        } catch (ApiException e) {
            System.err.println("Exception when calling DepositResourceApi#voidDeposit");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DepositResourceApi;

public class DepositResourceApiExample {

    public static void main(String[] args) {
        DepositResourceApi apiInstance = new DepositResourceApi();
        VoidDepositRequestDto body = ; // VoidDepositRequestDto |
        String key = key_example; // String | key of the client
        String signature = signature_example; // String | Client signature for this request
        try {
            apiInstance.voidDeposit(body, key, signature);
        } catch (ApiException e) {
            System.err.println("Exception when calling DepositResourceApi#voidDeposit");
            e.printStackTrace();
        }
    }
}
VoidDepositRequestDto *body = ; //
String *key = key_example; // key of the client
String *signature = signature_example; // Client signature for this request

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

[apiInstance voidDepositWith:body
    key:key
    signature:signature
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Psp = require('psp');

var api = new Psp.DepositResourceApi()
var body = ; // {{VoidDepositRequestDto}}
var key = key_example; // {{String}} key of the client
var signature = signature_example; // {{String}} Client signature for this request

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.voidDeposit(bodykeysignature, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new DepositResourceApi();
            var body = new VoidDepositRequestDto(); // VoidDepositRequestDto |
            var key = key_example;  // String | key of the client
            var signature = signature_example;  // String | Client signature for this request

            try
            {
                apiInstance.voidDeposit(body, key, signature);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DepositResourceApi.voidDeposit: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiDepositResourceApi();
$body = ; // VoidDepositRequestDto |
$key = key_example; // String | key of the client
$signature = signature_example; // String | Client signature for this request

try {
    $api_instance->voidDeposit($body, $key, $signature);
} catch (Exception $e) {
    echo 'Exception when calling DepositResourceApi->voidDeposit: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DepositResourceApi;

my $api_instance = WWW::SwaggerClient::DepositResourceApi->new();
my $body = WWW::SwaggerClient::Object::VoidDepositRequestDto->new(); # VoidDepositRequestDto |
my $key = key_example; # String | key of the client
my $signature = signature_example; # String | Client signature for this request

eval {
    $api_instance->voidDeposit(body => $body, key => $key, signature => $signature);
};
if ($@) {
    warn "Exception when calling DepositResourceApi->voidDeposit: $@\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.DepositResourceApi()
body =  # VoidDepositRequestDto |
key = key_example # String | key of the client
signature = signature_example # String | Client signature for this request

try:
    api_instance.void_deposit(body, key, signature)
except ApiException as e:
    print("Exception when calling DepositResourceApi->voidDeposit: %s\n" % e)

Parameters

Header parameters
Name Description
key*
String
key of the client
Required
signature*
String
Client signature for this request
Required
Body parameters
Name Description
body *

Responses

Status: 202 - Deposit voided

Status: 404 - Any resource has not been found. i.e.: accountId doesn't exists

Status: 409 - Conflict error. i.e: Nonce is not valid


PayoutResource

authorize

Authorize a Payout


/payouts/authorization

Usage and SDK Samples

curl -X POST\
-H "Content-Type: application/json"\
"https://psp.example.com/payouts/authorization"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PayoutResourceApi;

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

public class PayoutResourceApiExample {

    public static void main(String[] args) {

        PayoutResourceApi apiInstance = new PayoutResourceApi();
        AuthorizationRequestDto body = ; // AuthorizationRequestDto |
        String key = key_example; // String | key of the client
        String signature = signature_example; // String | Client signature for this request
        try {
            apiInstance.authorize(body, key, signature);
        } catch (ApiException e) {
            System.err.println("Exception when calling PayoutResourceApi#authorize");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PayoutResourceApi;

public class PayoutResourceApiExample {

    public static void main(String[] args) {
        PayoutResourceApi apiInstance = new PayoutResourceApi();
        AuthorizationRequestDto body = ; // AuthorizationRequestDto |
        String key = key_example; // String | key of the client
        String signature = signature_example; // String | Client signature for this request
        try {
            apiInstance.authorize(body, key, signature);
        } catch (ApiException e) {
            System.err.println("Exception when calling PayoutResourceApi#authorize");
            e.printStackTrace();
        }
    }
}
AuthorizationRequestDto *body = ; //
String *key = key_example; // key of the client
String *signature = signature_example; // Client signature for this request

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

[apiInstance authorizeWith:body
    key:key
    signature:signature
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Psp = require('psp');

var api = new Psp.PayoutResourceApi()
var body = ; // {{AuthorizationRequestDto}}
var key = key_example; // {{String}} key of the client
var signature = signature_example; // {{String}} Client signature for this request

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.authorize(bodykeysignature, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new PayoutResourceApi();
            var body = new AuthorizationRequestDto(); // AuthorizationRequestDto |
            var key = key_example;  // String | key of the client
            var signature = signature_example;  // String | Client signature for this request

            try
            {
                apiInstance.authorize(body, key, signature);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PayoutResourceApi.authorize: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiPayoutResourceApi();
$body = ; // AuthorizationRequestDto |
$key = key_example; // String | key of the client
$signature = signature_example; // String | Client signature for this request

try {
    $api_instance->authorize($body, $key, $signature);
} catch (Exception $e) {
    echo 'Exception when calling PayoutResourceApi->authorize: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PayoutResourceApi;

my $api_instance = WWW::SwaggerClient::PayoutResourceApi->new();
my $body = WWW::SwaggerClient::Object::AuthorizationRequestDto->new(); # AuthorizationRequestDto |
my $key = key_example; # String | key of the client
my $signature = signature_example; # String | Client signature for this request

eval {
    $api_instance->authorize(body => $body, key => $key, signature => $signature);
};
if ($@) {
    warn "Exception when calling PayoutResourceApi->authorize: $@\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.PayoutResourceApi()
body =  # AuthorizationRequestDto |
key = key_example # String | key of the client
signature = signature_example # String | Client signature for this request

try:
    api_instance.authorize(body, key, signature)
except ApiException as e:
    print("Exception when calling PayoutResourceApi->authorize: %s\n" % e)

Parameters

Header parameters
Name Description
key*
String
key of the client
Required
signature*
String
Client signature for this request
Required
Body parameters
Name Description
body *

Responses

Status: 202 - Payment authorization process has been accepted

Status: 403 - Access denied

Status: 404 - Not found payment authorization by payment id

Status: 409 - Payment authorization by payment id already authorized


createAndFirstAuthorizationPayout

Create a Payout and provide first authorization


/payouts/create-and-authorize

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"https://psp.example.com/payouts/create-and-authorize"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PayoutResourceApi;

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

public class PayoutResourceApiExample {

    public static void main(String[] args) {

        PayoutResourceApi apiInstance = new PayoutResourceApi();
        CreatePayoutRequestDto body = ; // CreatePayoutRequestDto |
        String key = key_example; // String | key of the client
        String signature = signature_example; // String | Client signature for this request
        try {
            PayoutCreatedDto result = apiInstance.createAndFirstAuthorizationPayout(body, key, signature);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PayoutResourceApi#createAndFirstAuthorizationPayout");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PayoutResourceApi;

public class PayoutResourceApiExample {

    public static void main(String[] args) {
        PayoutResourceApi apiInstance = new PayoutResourceApi();
        CreatePayoutRequestDto body = ; // CreatePayoutRequestDto |
        String key = key_example; // String | key of the client
        String signature = signature_example; // String | Client signature for this request
        try {
            PayoutCreatedDto result = apiInstance.createAndFirstAuthorizationPayout(body, key, signature);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PayoutResourceApi#createAndFirstAuthorizationPayout");
            e.printStackTrace();
        }
    }
}
CreatePayoutRequestDto *body = ; //
String *key = key_example; // key of the client
String *signature = signature_example; // Client signature for this request

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

[apiInstance createAndFirstAuthorizationPayoutWith:body
    key:key
    signature:signature
              completionHandler: ^(PayoutCreatedDto output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Psp = require('psp');

var api = new Psp.PayoutResourceApi()
var body = ; // {{CreatePayoutRequestDto}}
var key = key_example; // {{String}} key of the client
var signature = signature_example; // {{String}} Client signature for this request

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

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

            var apiInstance = new PayoutResourceApi();
            var body = new CreatePayoutRequestDto(); // CreatePayoutRequestDto |
            var key = key_example;  // String | key of the client
            var signature = signature_example;  // String | Client signature for this request

            try
            {
                PayoutCreatedDto result = apiInstance.createAndFirstAuthorizationPayout(body, key, signature);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PayoutResourceApi.createAndFirstAuthorizationPayout: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiPayoutResourceApi();
$body = ; // CreatePayoutRequestDto |
$key = key_example; // String | key of the client
$signature = signature_example; // String | Client signature for this request

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

my $api_instance = WWW::SwaggerClient::PayoutResourceApi->new();
my $body = WWW::SwaggerClient::Object::CreatePayoutRequestDto->new(); # CreatePayoutRequestDto |
my $key = key_example; # String | key of the client
my $signature = signature_example; # String | Client signature for this request

eval {
    my $result = $api_instance->createAndFirstAuthorizationPayout(body => $body, key => $key, signature => $signature);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PayoutResourceApi->createAndFirstAuthorizationPayout: $@\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.PayoutResourceApi()
body =  # CreatePayoutRequestDto |
key = key_example # String | key of the client
signature = signature_example # String | Client signature for this request

try:
    api_response = api_instance.create_and_first_authorization_payout(body, key, signature)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PayoutResourceApi->createAndFirstAuthorizationPayout: %s\n" % e)

Parameters

Header parameters
Name Description
key*
String
key of the client
Required
signature*
String
Client signature for this request
Required
Body parameters
Name Description
body *

Responses

Status: 202 - Payout creation & authorize accepted

Status: 400 - Any parameter is wrong. i.e.: amount is negative, currency doesn't match with account currency, url malformed

Status: 404 - Any resource has not been found. i.e.: accountId doesn't exists


createAndFirstAuthorizationPayoutV2

Create a Payout and provide first authorization v2


/payouts/v2/create-and-authorize

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"https://psp.example.com/payouts/v2/create-and-authorize"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PayoutResourceApi;

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

public class PayoutResourceApiExample {

    public static void main(String[] args) {

        PayoutResourceApi apiInstance = new PayoutResourceApi();
        CreatePayoutRequestDto body = ; // CreatePayoutRequestDto |
        String key = key_example; // String | key of the client
        String signature = signature_example; // String | Client signature for this request
        try {
            PayoutCreatedDto result = apiInstance.createAndFirstAuthorizationPayoutV2(body, key, signature);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PayoutResourceApi#createAndFirstAuthorizationPayoutV2");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PayoutResourceApi;

public class PayoutResourceApiExample {

    public static void main(String[] args) {
        PayoutResourceApi apiInstance = new PayoutResourceApi();
        CreatePayoutRequestDto body = ; // CreatePayoutRequestDto |
        String key = key_example; // String | key of the client
        String signature = signature_example; // String | Client signature for this request
        try {
            PayoutCreatedDto result = apiInstance.createAndFirstAuthorizationPayoutV2(body, key, signature);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PayoutResourceApi#createAndFirstAuthorizationPayoutV2");
            e.printStackTrace();
        }
    }
}
CreatePayoutRequestDto *body = ; //
String *key = key_example; // key of the client
String *signature = signature_example; // Client signature for this request

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

[apiInstance createAndFirstAuthorizationPayoutV2With:body
    key:key
    signature:signature
              completionHandler: ^(PayoutCreatedDto output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Psp = require('psp');

var api = new Psp.PayoutResourceApi()
var body = ; // {{CreatePayoutRequestDto}}
var key = key_example; // {{String}} key of the client
var signature = signature_example; // {{String}} Client signature for this request

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

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

            var apiInstance = new PayoutResourceApi();
            var body = new CreatePayoutRequestDto(); // CreatePayoutRequestDto |
            var key = key_example;  // String | key of the client
            var signature = signature_example;  // String | Client signature for this request

            try
            {
                PayoutCreatedDto result = apiInstance.createAndFirstAuthorizationPayoutV2(body, key, signature);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PayoutResourceApi.createAndFirstAuthorizationPayoutV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiPayoutResourceApi();
$body = ; // CreatePayoutRequestDto |
$key = key_example; // String | key of the client
$signature = signature_example; // String | Client signature for this request

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

my $api_instance = WWW::SwaggerClient::PayoutResourceApi->new();
my $body = WWW::SwaggerClient::Object::CreatePayoutRequestDto->new(); # CreatePayoutRequestDto |
my $key = key_example; # String | key of the client
my $signature = signature_example; # String | Client signature for this request

eval {
    my $result = $api_instance->createAndFirstAuthorizationPayoutV2(body => $body, key => $key, signature => $signature);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PayoutResourceApi->createAndFirstAuthorizationPayoutV2: $@\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.PayoutResourceApi()
body =  # CreatePayoutRequestDto |
key = key_example # String | key of the client
signature = signature_example # String | Client signature for this request

try:
    api_response = api_instance.create_and_first_authorization_payout_v2(body, key, signature)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PayoutResourceApi->createAndFirstAuthorizationPayoutV2: %s\n" % e)

Parameters

Header parameters
Name Description
key*
String
key of the client
Required
signature*
String
Client signature for this request
Required
Body parameters
Name Description
body *

Responses

Status: 202 - Payout creation & authorize accepted

Status: 400 - Any parameter is wrong. i.e.: amount is negative, currency doesn't match with account currency, url malformed

Status: 404 - Any resource has not been found. i.e.: accountId doesn't exists


createPayout

Create a Payout


/payouts/create

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"https://psp.example.com/payouts/create"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PayoutResourceApi;

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

public class PayoutResourceApiExample {

    public static void main(String[] args) {

        PayoutResourceApi apiInstance = new PayoutResourceApi();
        CreatePayoutRequestDto body = ; // CreatePayoutRequestDto |
        String key = key_example; // String | key of the client
        String signature = signature_example; // String | Client signature for this request
        try {
            PayoutCreatedDto result = apiInstance.createPayout(body, key, signature);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PayoutResourceApi#createPayout");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PayoutResourceApi;

public class PayoutResourceApiExample {

    public static void main(String[] args) {
        PayoutResourceApi apiInstance = new PayoutResourceApi();
        CreatePayoutRequestDto body = ; // CreatePayoutRequestDto |
        String key = key_example; // String | key of the client
        String signature = signature_example; // String | Client signature for this request
        try {
            PayoutCreatedDto result = apiInstance.createPayout(body, key, signature);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PayoutResourceApi#createPayout");
            e.printStackTrace();
        }
    }
}
CreatePayoutRequestDto *body = ; //
String *key = key_example; // key of the client
String *signature = signature_example; // Client signature for this request

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

[apiInstance createPayoutWith:body
    key:key
    signature:signature
              completionHandler: ^(PayoutCreatedDto output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Psp = require('psp');

var api = new Psp.PayoutResourceApi()
var body = ; // {{CreatePayoutRequestDto}}
var key = key_example; // {{String}} key of the client
var signature = signature_example; // {{String}} Client signature for this request

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

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

            var apiInstance = new PayoutResourceApi();
            var body = new CreatePayoutRequestDto(); // CreatePayoutRequestDto |
            var key = key_example;  // String | key of the client
            var signature = signature_example;  // String | Client signature for this request

            try
            {
                PayoutCreatedDto result = apiInstance.createPayout(body, key, signature);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PayoutResourceApi.createPayout: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiPayoutResourceApi();
$body = ; // CreatePayoutRequestDto |
$key = key_example; // String | key of the client
$signature = signature_example; // String | Client signature for this request

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

my $api_instance = WWW::SwaggerClient::PayoutResourceApi->new();
my $body = WWW::SwaggerClient::Object::CreatePayoutRequestDto->new(); # CreatePayoutRequestDto |
my $key = key_example; # String | key of the client
my $signature = signature_example; # String | Client signature for this request

eval {
    my $result = $api_instance->createPayout(body => $body, key => $key, signature => $signature);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PayoutResourceApi->createPayout: $@\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.PayoutResourceApi()
body =  # CreatePayoutRequestDto |
key = key_example # String | key of the client
signature = signature_example # String | Client signature for this request

try:
    api_response = api_instance.create_payout(body, key, signature)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PayoutResourceApi->createPayout: %s\n" % e)

Parameters

Header parameters
Name Description
key*
String
key of the client
Required
signature*
String
Client signature for this request
Required
Body parameters
Name Description
body *

Responses

Status: 202 - Payout creation accepted

Status: 400 - Any parameter is wrong. i.e.: amount is negative, currency doesn't match with account currency, url malformed

Status: 404 - Any resource has not been found. i.e.: accountId doesn't exists


createPayoutV2

Create a Payout v2


/payouts/v2/create

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"https://psp.example.com/payouts/v2/create"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PayoutResourceApi;

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

public class PayoutResourceApiExample {

    public static void main(String[] args) {

        PayoutResourceApi apiInstance = new PayoutResourceApi();
        CreatePayoutRequestDto body = ; // CreatePayoutRequestDto |
        String key = key_example; // String | key of the client
        String signature = signature_example; // String | Client signature for this request
        try {
            PayoutCreatedDto result = apiInstance.createPayoutV2(body, key, signature);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PayoutResourceApi#createPayoutV2");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PayoutResourceApi;

public class PayoutResourceApiExample {

    public static void main(String[] args) {
        PayoutResourceApi apiInstance = new PayoutResourceApi();
        CreatePayoutRequestDto body = ; // CreatePayoutRequestDto |
        String key = key_example; // String | key of the client
        String signature = signature_example; // String | Client signature for this request
        try {
            PayoutCreatedDto result = apiInstance.createPayoutV2(body, key, signature);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PayoutResourceApi#createPayoutV2");
            e.printStackTrace();
        }
    }
}
CreatePayoutRequestDto *body = ; //
String *key = key_example; // key of the client
String *signature = signature_example; // Client signature for this request

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

[apiInstance createPayoutV2With:body
    key:key
    signature:signature
              completionHandler: ^(PayoutCreatedDto output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Psp = require('psp');

var api = new Psp.PayoutResourceApi()
var body = ; // {{CreatePayoutRequestDto}}
var key = key_example; // {{String}} key of the client
var signature = signature_example; // {{String}} Client signature for this request

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

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

            var apiInstance = new PayoutResourceApi();
            var body = new CreatePayoutRequestDto(); // CreatePayoutRequestDto |
            var key = key_example;  // String | key of the client
            var signature = signature_example;  // String | Client signature for this request

            try
            {
                PayoutCreatedDto result = apiInstance.createPayoutV2(body, key, signature);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PayoutResourceApi.createPayoutV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiPayoutResourceApi();
$body = ; // CreatePayoutRequestDto |
$key = key_example; // String | key of the client
$signature = signature_example; // String | Client signature for this request

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

my $api_instance = WWW::SwaggerClient::PayoutResourceApi->new();
my $body = WWW::SwaggerClient::Object::CreatePayoutRequestDto->new(); # CreatePayoutRequestDto |
my $key = key_example; # String | key of the client
my $signature = signature_example; # String | Client signature for this request

eval {
    my $result = $api_instance->createPayoutV2(body => $body, key => $key, signature => $signature);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PayoutResourceApi->createPayoutV2: $@\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.PayoutResourceApi()
body =  # CreatePayoutRequestDto |
key = key_example # String | key of the client
signature = signature_example # String | Client signature for this request

try:
    api_response = api_instance.create_payout_v2(body, key, signature)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PayoutResourceApi->createPayoutV2: %s\n" % e)

Parameters

Header parameters
Name Description
key*
String
key of the client
Required
signature*
String
Client signature for this request
Required
Body parameters
Name Description
body *

Responses

Status: 202 - Payout creation accepted

Status: 400 - Any parameter is wrong. i.e.: amount is negative, currency doesn't match with account currency, url malformed

Status: 404 - Any resource has not been found. i.e.: accountId doesn't exists


findPayoutFilteredV2

Get Payouts details in batch


/payouts/v2/find

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"https://psp.example.com/payouts/v2/find"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PayoutResourceApi;

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

public class PayoutResourceApiExample {

    public static void main(String[] args) {

        PayoutResourceApi apiInstance = new PayoutResourceApi();
        PayoutFiltersDtoV2 body = ; // PayoutFiltersDtoV2 |
        String key = key_example; // String | key of the client
        String signature = signature_example; // String | Client signature for this request
        try {
            FindPayoutResponseDtoV2 result = apiInstance.findPayoutFilteredV2(body, key, signature);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PayoutResourceApi#findPayoutFilteredV2");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PayoutResourceApi;

public class PayoutResourceApiExample {

    public static void main(String[] args) {
        PayoutResourceApi apiInstance = new PayoutResourceApi();
        PayoutFiltersDtoV2 body = ; // PayoutFiltersDtoV2 |
        String key = key_example; // String | key of the client
        String signature = signature_example; // String | Client signature for this request
        try {
            FindPayoutResponseDtoV2 result = apiInstance.findPayoutFilteredV2(body, key, signature);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PayoutResourceApi#findPayoutFilteredV2");
            e.printStackTrace();
        }
    }
}
PayoutFiltersDtoV2 *body = ; //
String *key = key_example; // key of the client
String *signature = signature_example; // Client signature for this request

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

[apiInstance findPayoutFilteredV2With:body
    key:key
    signature:signature
              completionHandler: ^(FindPayoutResponseDtoV2 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Psp = require('psp');

var api = new Psp.PayoutResourceApi()
var body = ; // {{PayoutFiltersDtoV2}}
var key = key_example; // {{String}} key of the client
var signature = signature_example; // {{String}} Client signature for this request

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

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

            var apiInstance = new PayoutResourceApi();
            var body = new PayoutFiltersDtoV2(); // PayoutFiltersDtoV2 |
            var key = key_example;  // String | key of the client
            var signature = signature_example;  // String | Client signature for this request

            try
            {
                FindPayoutResponseDtoV2 result = apiInstance.findPayoutFilteredV2(body, key, signature);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PayoutResourceApi.findPayoutFilteredV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiPayoutResourceApi();
$body = ; // PayoutFiltersDtoV2 |
$key = key_example; // String | key of the client
$signature = signature_example; // String | Client signature for this request

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

my $api_instance = WWW::SwaggerClient::PayoutResourceApi->new();
my $body = WWW::SwaggerClient::Object::PayoutFiltersDtoV2->new(); # PayoutFiltersDtoV2 |
my $key = key_example; # String | key of the client
my $signature = signature_example; # String | Client signature for this request

eval {
    my $result = $api_instance->findPayoutFilteredV2(body => $body, key => $key, signature => $signature);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PayoutResourceApi->findPayoutFilteredV2: $@\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.PayoutResourceApi()
body =  # PayoutFiltersDtoV2 |
key = key_example # String | key of the client
signature = signature_example # String | Client signature for this request

try:
    api_response = api_instance.find_payout_filtered_v2(body, key, signature)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PayoutResourceApi->findPayoutFilteredV2: %s\n" % e)

Parameters

Header parameters
Name Description
key*
String
key of the client
Required
signature*
String
Client signature for this request
Required
Body parameters
Name Description
body *

Responses

Status: 200 - Payouts info which match with filters is returned


voidPayout

Voids a payout


/payouts/void

Usage and SDK Samples

curl -X POST\
-H "Content-Type: application/json"\
"https://psp.example.com/payouts/void"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PayoutResourceApi;

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

public class PayoutResourceApiExample {

    public static void main(String[] args) {

        PayoutResourceApi apiInstance = new PayoutResourceApi();
        VoidPayoutRequestDto body = ; // VoidPayoutRequestDto |
        String key = key_example; // String | key of the client
        String signature = signature_example; // String | Client signature for this request
        try {
            apiInstance.voidPayout(body, key, signature);
        } catch (ApiException e) {
            System.err.println("Exception when calling PayoutResourceApi#voidPayout");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PayoutResourceApi;

public class PayoutResourceApiExample {

    public static void main(String[] args) {
        PayoutResourceApi apiInstance = new PayoutResourceApi();
        VoidPayoutRequestDto body = ; // VoidPayoutRequestDto |
        String key = key_example; // String | key of the client
        String signature = signature_example; // String | Client signature for this request
        try {
            apiInstance.voidPayout(body, key, signature);
        } catch (ApiException e) {
            System.err.println("Exception when calling PayoutResourceApi#voidPayout");
            e.printStackTrace();
        }
    }
}
VoidPayoutRequestDto *body = ; //
String *key = key_example; // key of the client
String *signature = signature_example; // Client signature for this request

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

[apiInstance voidPayoutWith:body
    key:key
    signature:signature
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Psp = require('psp');

var api = new Psp.PayoutResourceApi()
var body = ; // {{VoidPayoutRequestDto}}
var key = key_example; // {{String}} key of the client
var signature = signature_example; // {{String}} Client signature for this request

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.voidPayout(bodykeysignature, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new PayoutResourceApi();
            var body = new VoidPayoutRequestDto(); // VoidPayoutRequestDto |
            var key = key_example;  // String | key of the client
            var signature = signature_example;  // String | Client signature for this request

            try
            {
                apiInstance.voidPayout(body, key, signature);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PayoutResourceApi.voidPayout: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiPayoutResourceApi();
$body = ; // VoidPayoutRequestDto |
$key = key_example; // String | key of the client
$signature = signature_example; // String | Client signature for this request

try {
    $api_instance->voidPayout($body, $key, $signature);
} catch (Exception $e) {
    echo 'Exception when calling PayoutResourceApi->voidPayout: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PayoutResourceApi;

my $api_instance = WWW::SwaggerClient::PayoutResourceApi->new();
my $body = WWW::SwaggerClient::Object::VoidPayoutRequestDto->new(); # VoidPayoutRequestDto |
my $key = key_example; # String | key of the client
my $signature = signature_example; # String | Client signature for this request

eval {
    $api_instance->voidPayout(body => $body, key => $key, signature => $signature);
};
if ($@) {
    warn "Exception when calling PayoutResourceApi->voidPayout: $@\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.PayoutResourceApi()
body =  # VoidPayoutRequestDto |
key = key_example # String | key of the client
signature = signature_example # String | Client signature for this request

try:
    api_instance.void_payout(body, key, signature)
except ApiException as e:
    print("Exception when calling PayoutResourceApi->voidPayout: %s\n" % e)

Parameters

Header parameters
Name Description
key*
String
key of the client
Required
signature*
String
Client signature for this request
Required
Body parameters
Name Description
body *

Responses

Status: 202 - Payout void accepted