مستندات وب سرویس های درگاه پرداخت جیب

Callback

receiverAddressPost

آدرس: توسط پذیرنده در وب سرویس issue تنظیم می شود


/ReceiverAddress

Usage and SDK Samples

curl -X POST "https://api.apieco.ir/jeeb/ReceiverAddress"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CallbackApi;

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

public class CallbackApiExample {

    public static void main(String[] args) {
        
        CallbackApi apiInstance = new CallbackApi();
        String apiecoKey = apiecoKey_example; // String | apikey for use API
        Body_3 body = ; // Body_3 | 
        try {
            apiInstance.receiverAddressPost(apiecoKey, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling CallbackApi#receiverAddressPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CallbackApi;

public class CallbackApiExample {

    public static void main(String[] args) {
        CallbackApi apiInstance = new CallbackApi();
        String apiecoKey = apiecoKey_example; // String | apikey for use API
        Body_3 body = ; // Body_3 | 
        try {
            apiInstance.receiverAddressPost(apiecoKey, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling CallbackApi#receiverAddressPost");
            e.printStackTrace();
        }
    }
}
String *apiecoKey = apiecoKey_example; // apikey for use API (default to WsLdHK46I5Wfr5xgI0ynjjyiw9Fyhydu)
Body_3 *body = ; //  (optional)

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

// آدرس: توسط پذیرنده در وب سرویس issue تنظیم می شود
[apiInstance receiverAddressPostWith:apiecoKey
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var _ = require('______');

var api = new _.CallbackApi()

var apiecoKey = apiecoKey_example; // {String} apikey for use API

var opts = { 
  'body':  // {Body_3} 
};

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

namespace Example
{
    public class receiverAddressPostExample
    {
        public void main()
        {
            
            var apiInstance = new CallbackApi();
            var apiecoKey = apiecoKey_example;  // String | apikey for use API (default to WsLdHK46I5Wfr5xgI0ynjjyiw9Fyhydu)
            var body = new Body_3(); // Body_3 |  (optional) 

            try
            {
                // آدرس: توسط پذیرنده در وب سرویس issue تنظیم می شود
                apiInstance.receiverAddressPost(apiecoKey, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CallbackApi.receiverAddressPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CallbackApi();
$apiecoKey = apiecoKey_example; // String | apikey for use API
$body = ; // Body_3 | 

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

my $api_instance = WWW::SwaggerClient::CallbackApi->new();
my $apiecoKey = apiecoKey_example; # String | apikey for use API
my $body = WWW::SwaggerClient::Object::Body_3->new(); # Body_3 | 

eval { 
    $api_instance->receiverAddressPost(apiecoKey => $apiecoKey, body => $body);
};
if ($@) {
    warn "Exception when calling CallbackApi->receiverAddressPost: $@\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.CallbackApi()
apiecoKey = apiecoKey_example # String | apikey for use API (default to WsLdHK46I5Wfr5xgI0ynjjyiw9Fyhydu)
body =  # Body_3 |  (optional)

try: 
    # آدرس: توسط پذیرنده در وب سرویس issue تنظیم می شود
    api_instance.receiver_address_post(apiecoKey, body=body)
except ApiException as e:
    print("Exception when calling CallbackApi->receiverAddressPost: %s\n" % e)

Parameters

Header parameters
Name Description
apieco-key*
String
apikey for use API
Required
Body parameters
Name Description
body
{
Required: orderNo,referenceNo,stateId
referenceNo:
string

شماره رهگیری پرداخت در جیب

orderNo:
string

شماره سفارش در سیستم پذیرنده

stateId:
number

کد وضعیت پرداخت

baseValue:
number

مبلغ پایه به بیت کوین، این فیلد برابر است با فیلد value در ورودی وب سرویس issue

coin:
string

کوینی که کاربر بر روی آن تراکنش انجام داده است

value:
number

مبلغ درخواستی بر روی کوین انتخابی

paidValue:
number

مبلغ پرداختی بر روی کوین انتخابی

rate:
number

نرخ تبدیل مبلغ پایه به مبلغ درخواستی کوین انتخابی

}

Responses

Status: 200 - 200 response


Confirm

apiPaymentsSignatureConfirmPost


/api/payments/{signature}/confirm

Usage and SDK Samples

curl -X POST "https://api.apieco.ir/jeeb/api/payments/{signature}/confirm"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConfirmApi;

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

public class ConfirmApiExample {

    public static void main(String[] args) {
        
        ConfirmApi apiInstance = new ConfirmApi();
        String apiecoKey = apiecoKey_example; // String | apikey for use API
        String signature = signature_example; // String | Signature یا امضای پذیرنده محرمانه می باشد
        Body_1 body = ; // Body_1 | 
        try {
            inline_response_200_1 result = apiInstance.apiPaymentsSignatureConfirmPost(apiecoKey, signature, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfirmApi#apiPaymentsSignatureConfirmPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ConfirmApi;

public class ConfirmApiExample {

    public static void main(String[] args) {
        ConfirmApi apiInstance = new ConfirmApi();
        String apiecoKey = apiecoKey_example; // String | apikey for use API
        String signature = signature_example; // String | Signature یا امضای پذیرنده محرمانه می باشد
        Body_1 body = ; // Body_1 | 
        try {
            inline_response_200_1 result = apiInstance.apiPaymentsSignatureConfirmPost(apiecoKey, signature, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfirmApi#apiPaymentsSignatureConfirmPost");
            e.printStackTrace();
        }
    }
}
String *apiecoKey = apiecoKey_example; // apikey for use API (default to WsLdHK46I5Wfr5xgI0ynjjyiw9Fyhydu)
String *signature = signature_example; // Signature یا امضای پذیرنده محرمانه می باشد
Body_1 *body = ; //  (optional)

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

[apiInstance apiPaymentsSignatureConfirmPostWith:apiecoKey
    signature:signature
    body:body
              completionHandler: ^(inline_response_200_1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var _ = require('______');

var api = new _.ConfirmApi()

var apiecoKey = apiecoKey_example; // {String} apikey for use API

var signature = signature_example; // {String} Signature یا امضای پذیرنده محرمانه می باشد

var opts = { 
  'body':  // {Body_1} 
};

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

namespace Example
{
    public class apiPaymentsSignatureConfirmPostExample
    {
        public void main()
        {
            
            var apiInstance = new ConfirmApi();
            var apiecoKey = apiecoKey_example;  // String | apikey for use API (default to WsLdHK46I5Wfr5xgI0ynjjyiw9Fyhydu)
            var signature = signature_example;  // String | Signature یا امضای پذیرنده محرمانه می باشد
            var body = new Body_1(); // Body_1 |  (optional) 

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

$api_instance = new Swagger\Client\Api\ConfirmApi();
$apiecoKey = apiecoKey_example; // String | apikey for use API
$signature = signature_example; // String | Signature یا امضای پذیرنده محرمانه می باشد
$body = ; // Body_1 | 

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

my $api_instance = WWW::SwaggerClient::ConfirmApi->new();
my $apiecoKey = apiecoKey_example; # String | apikey for use API
my $signature = signature_example; # String | Signature یا امضای پذیرنده محرمانه می باشد
my $body = WWW::SwaggerClient::Object::Body_1->new(); # Body_1 | 

eval { 
    my $result = $api_instance->apiPaymentsSignatureConfirmPost(apiecoKey => $apiecoKey, signature => $signature, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConfirmApi->apiPaymentsSignatureConfirmPost: $@\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.ConfirmApi()
apiecoKey = apiecoKey_example # String | apikey for use API (default to WsLdHK46I5Wfr5xgI0ynjjyiw9Fyhydu)
signature = signature_example # String | Signature یا امضای پذیرنده محرمانه می باشد
body =  # Body_1 |  (optional)

try: 
    api_response = api_instance.api_payments_signature_confirm_post(apiecoKey, signature, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConfirmApi->apiPaymentsSignatureConfirmPost: %s\n" % e)

Parameters

Path parameters
Name Description
signature*
String
Signature یا امضای پذیرنده محرمانه می باشد
Required
Header parameters
Name Description
apieco-key*
String
apikey for use API
Required
Body parameters
Name Description
body
{
token:
string

توکن پرداخت

}

Responses

Status: 200 - 200 response

{
isConfirmed:
boolean

این فیلد در خروجی حتما باید true باشد در غیر این صورت پذیرنده نباید سفارش را نهایی کند.

referenceNo:
string

شماره رهگیری پرداخت در جیب

orderNo:
string

شماره سفارش در سیستم پذیرنده

stateId:
number

کد وضعیت پرداخت

baseValue:
number

مبلغ پایه به بیت کوین، این فیلد برابر است با فیلد value در ورودی وب سرویس issue

coin:
string

کوینی که کاربر بر روی آن تراکنش انجام داده است

value:
number

مبلغ درخواستی بر روی کوین انتخابی

paidValue:
number

مبلغ پرداختی بر روی کوین انتخابی

rate:
number

نرخ تبدیل مبلغ پایه به مبلغ درخواستی کوین انتخابی

expirationTime:
string

تاریخ و زمان انقضای پرداخت

finalizedTime:
string

تاریخ و زمان نهایی شدن پرداخت

}

Issue

apiPaymentsSignatureIssuePost

انتقال با روش ارسال Form: در این روش، جهت انتقال به درگاه پرداخت، می بایست کاربر را به همراه token - مطابق مشخصات زیر - به جیب POST نمایید.


/api/payments/{signature}/issue

Usage and SDK Samples

curl -X POST "https://api.apieco.ir/jeeb/api/payments/{signature}/issue?token="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.IssueApi;

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

public class IssueApiExample {

    public static void main(String[] args) {
        
        IssueApi apiInstance = new IssueApi();
        String apiecoKey = apiecoKey_example; // String | apikey for use API
        String signature = signature_example; // String | Signature یا امضای پذیرنده محرمانه می باشد
        String token = token_example; // String | 
        Body body = ; // Body | 
        try {
            inline_response_200 result = apiInstance.apiPaymentsSignatureIssuePost(apiecoKey, signature, token, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling IssueApi#apiPaymentsSignatureIssuePost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.IssueApi;

public class IssueApiExample {

    public static void main(String[] args) {
        IssueApi apiInstance = new IssueApi();
        String apiecoKey = apiecoKey_example; // String | apikey for use API
        String signature = signature_example; // String | Signature یا امضای پذیرنده محرمانه می باشد
        String token = token_example; // String | 
        Body body = ; // Body | 
        try {
            inline_response_200 result = apiInstance.apiPaymentsSignatureIssuePost(apiecoKey, signature, token, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling IssueApi#apiPaymentsSignatureIssuePost");
            e.printStackTrace();
        }
    }
}
String *apiecoKey = apiecoKey_example; // apikey for use API (default to WsLdHK46I5Wfr5xgI0ynjjyiw9Fyhydu)
String *signature = signature_example; // Signature یا امضای پذیرنده محرمانه می باشد
String *token = token_example; // 
Body *body = ; //  (optional)

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

// انتقال با روش ارسال Form: در این روش، جهت انتقال به درگاه پرداخت، می بایست کاربر را به همراه token - مطابق مشخصات زیر - به جیب POST نمایید. 
[apiInstance apiPaymentsSignatureIssuePostWith:apiecoKey
    signature:signature
    token:token
    body:body
              completionHandler: ^(inline_response_200 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var _ = require('______');

var api = new _.IssueApi()

var apiecoKey = apiecoKey_example; // {String} apikey for use API

var signature = signature_example; // {String} Signature یا امضای پذیرنده محرمانه می باشد

var token = token_example; // {String} 

var opts = { 
  'body':  // {Body} 
};

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

namespace Example
{
    public class apiPaymentsSignatureIssuePostExample
    {
        public void main()
        {
            
            var apiInstance = new IssueApi();
            var apiecoKey = apiecoKey_example;  // String | apikey for use API (default to WsLdHK46I5Wfr5xgI0ynjjyiw9Fyhydu)
            var signature = signature_example;  // String | Signature یا امضای پذیرنده محرمانه می باشد
            var token = token_example;  // String | 
            var body = new Body(); // Body |  (optional) 

            try
            {
                // انتقال با روش ارسال Form: در این روش، جهت انتقال به درگاه پرداخت، می بایست کاربر را به همراه token - مطابق مشخصات زیر - به جیب POST نمایید. 
                inline_response_200 result = apiInstance.apiPaymentsSignatureIssuePost(apiecoKey, signature, token, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling IssueApi.apiPaymentsSignatureIssuePost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\IssueApi();
$apiecoKey = apiecoKey_example; // String | apikey for use API
$signature = signature_example; // String | Signature یا امضای پذیرنده محرمانه می باشد
$token = token_example; // String | 
$body = ; // Body | 

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

my $api_instance = WWW::SwaggerClient::IssueApi->new();
my $apiecoKey = apiecoKey_example; # String | apikey for use API
my $signature = signature_example; # String | Signature یا امضای پذیرنده محرمانه می باشد
my $token = token_example; # String | 
my $body = WWW::SwaggerClient::Object::Body->new(); # Body | 

eval { 
    my $result = $api_instance->apiPaymentsSignatureIssuePost(apiecoKey => $apiecoKey, signature => $signature, token => $token, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling IssueApi->apiPaymentsSignatureIssuePost: $@\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.IssueApi()
apiecoKey = apiecoKey_example # String | apikey for use API (default to WsLdHK46I5Wfr5xgI0ynjjyiw9Fyhydu)
signature = signature_example # String | Signature یا امضای پذیرنده محرمانه می باشد
token = token_example # String | 
body =  # Body |  (optional)

try: 
    # انتقال با روش ارسال Form: در این روش، جهت انتقال به درگاه پرداخت، می بایست کاربر را به همراه token - مطابق مشخصات زیر - به جیب POST نمایید. 
    api_response = api_instance.api_payments_signature_issue_post(apiecoKey, signature, token, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling IssueApi->apiPaymentsSignatureIssuePost: %s\n" % e)

Parameters

Path parameters
Name Description
signature*
String
Signature یا امضای پذیرنده محرمانه می باشد
Required
Header parameters
Name Description
apieco-key*
String
apikey for use API
Required
Body parameters
Name Description
body
{
Required: coins,orderNo,value,webhookUrl
orderNo:
string

شماره سفارش در سیستم پذیرنده

value:
number

مبلغ تراکنش به بیت کوین. مبلغ پایه تمام تراکنش ها به بیت کوین محاسبه می شود و می تواند شامل 8 رقم اعشار باشد.

coins:
string

لیست کوین های قابل پرداخت. شما می توانید هر تعداد کوینی که می خواهید در این فیلد وارد کنید، ولی در حال حاضر تنها 3 کوین اول پردازش می شوند. برای مشاهده لیست کوین ها به جدول کوین ها مراجعه کنید. این فیلد می بایست به صورت زیر وارد شود. coin1/coin2/coin3/.....

callbackUrl:
string

آدرس بازگشت به وب سایت پذیرنده (اجباریست در صورتی که از روش اول پیاده سازی استفاده می کنید)

webhookUrl:
string

آدرس ارسال اعلان ها به وب سایت پذیرنده

language:
string

جهت انتخاب زبان بخش پرداخت استفاده می شود، که در حال حاضر فقط en ، fa و null قابل قبول است. در صورتی که مقداری وارد نشود، بر اساس موقعیت حدودی پرداخت کننده، جیب تصمیم می گیرد که بخش پرداخت با چه زبانی بارگزاری شود.

expiration:
number

مقدار اولیه 15 (دقیقه) جهت افزایش زمان انقضای پرداخت استفاده می شود. این فیلد می تواند مقداری بین 15 تا 2880 داشته باشد.

allowReject:
boolean

مقدار اولیه true اگر true باشد و کاربر دقیقا مبلغ درخواست شده را واریز نکرده باشد، تراکنش پس از دریافت تاییدیه، از وضعیت 3 به 6 و یا 7 ختم شده و مبلغ واریز شده با کسر فی شبکه مسترد می شود.

allowTestNet:
boolean

مقدار اولیه false تنها در صورتی که این فیلد true باشد، امکان پردازش تست کوین ها در فیلد coins خواهد بود. توجه داشته باشید که تست کوین ها تنها برای برنامه نویس ها و به جهت تست ارتباطات ارائه شده اند و به هیچ عنوان نباید در نسخه نهایی استفاده شوند.

}
Query parameters
Name Description
token*
String
Required

Responses

Status: 200 - 200 response

{
referenceNo:
string

شماره رهگیری پرداخت در جیب

addresses:
string

آرایه ای از Object هایی که شامل آدرس و مبلغ درخواستی می باشد

expirationTime:
string

تاریخ و زمان انقضای پرداخت

token:
string

token پرداخت

}

Status

apiPaymentsSignatureStatusPost


/api/payments/{signature}/status

Usage and SDK Samples

curl -X POST "https://api.apieco.ir/jeeb/api/payments/{signature}/status"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.StatusApi;

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

public class StatusApiExample {

    public static void main(String[] args) {
        
        StatusApi apiInstance = new StatusApi();
        String apiecoKey = apiecoKey_example; // String | apikey for use API
        String signature = signature_example; // String | Signature یا امضای پذیرنده محرمانه می باشد
        Body_2 body = ; // Body_2 | 
        try {
            inline_response_200_1 result = apiInstance.apiPaymentsSignatureStatusPost(apiecoKey, signature, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StatusApi#apiPaymentsSignatureStatusPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.StatusApi;

public class StatusApiExample {

    public static void main(String[] args) {
        StatusApi apiInstance = new StatusApi();
        String apiecoKey = apiecoKey_example; // String | apikey for use API
        String signature = signature_example; // String | Signature یا امضای پذیرنده محرمانه می باشد
        Body_2 body = ; // Body_2 | 
        try {
            inline_response_200_1 result = apiInstance.apiPaymentsSignatureStatusPost(apiecoKey, signature, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StatusApi#apiPaymentsSignatureStatusPost");
            e.printStackTrace();
        }
    }
}
String *apiecoKey = apiecoKey_example; // apikey for use API (default to WsLdHK46I5Wfr5xgI0ynjjyiw9Fyhydu)
String *signature = signature_example; // Signature یا امضای پذیرنده محرمانه می باشد
Body_2 *body = ; //  (optional)

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

[apiInstance apiPaymentsSignatureStatusPostWith:apiecoKey
    signature:signature
    body:body
              completionHandler: ^(inline_response_200_1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var _ = require('______');

var api = new _.StatusApi()

var apiecoKey = apiecoKey_example; // {String} apikey for use API

var signature = signature_example; // {String} Signature یا امضای پذیرنده محرمانه می باشد

var opts = { 
  'body':  // {Body_2} 
};

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

namespace Example
{
    public class apiPaymentsSignatureStatusPostExample
    {
        public void main()
        {
            
            var apiInstance = new StatusApi();
            var apiecoKey = apiecoKey_example;  // String | apikey for use API (default to WsLdHK46I5Wfr5xgI0ynjjyiw9Fyhydu)
            var signature = signature_example;  // String | Signature یا امضای پذیرنده محرمانه می باشد
            var body = new Body_2(); // Body_2 |  (optional) 

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

$api_instance = new Swagger\Client\Api\StatusApi();
$apiecoKey = apiecoKey_example; // String | apikey for use API
$signature = signature_example; // String | Signature یا امضای پذیرنده محرمانه می باشد
$body = ; // Body_2 | 

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

my $api_instance = WWW::SwaggerClient::StatusApi->new();
my $apiecoKey = apiecoKey_example; # String | apikey for use API
my $signature = signature_example; # String | Signature یا امضای پذیرنده محرمانه می باشد
my $body = WWW::SwaggerClient::Object::Body_2->new(); # Body_2 | 

eval { 
    my $result = $api_instance->apiPaymentsSignatureStatusPost(apiecoKey => $apiecoKey, signature => $signature, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StatusApi->apiPaymentsSignatureStatusPost: $@\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.StatusApi()
apiecoKey = apiecoKey_example # String | apikey for use API (default to WsLdHK46I5Wfr5xgI0ynjjyiw9Fyhydu)
signature = signature_example # String | Signature یا امضای پذیرنده محرمانه می باشد
body =  # Body_2 |  (optional)

try: 
    api_response = api_instance.api_payments_signature_status_post(apiecoKey, signature, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StatusApi->apiPaymentsSignatureStatusPost: %s\n" % e)

Parameters

Path parameters
Name Description
signature*
String
Signature یا امضای پذیرنده محرمانه می باشد
Required
Header parameters
Name Description
apieco-key*
String
apikey for use API
Required
Body parameters
Name Description
body
{
token:
string

توکن پرداخت

}

Responses

Status: 200 - 200 response

{
isConfirmed:
boolean

این فیلد در خروجی حتما باید true باشد در غیر این صورت پذیرنده نباید سفارش را نهایی کند.

referenceNo:
string

شماره رهگیری پرداخت در جیب

orderNo:
string

شماره سفارش در سیستم پذیرنده

stateId:
number

کد وضعیت پرداخت

baseValue:
number

مبلغ پایه به بیت کوین، این فیلد برابر است با فیلد value در ورودی وب سرویس issue

coin:
string

کوینی که کاربر بر روی آن تراکنش انجام داده است

value:
number

مبلغ درخواستی بر روی کوین انتخابی

paidValue:
number

مبلغ پرداختی بر روی کوین انتخابی

rate:
number

نرخ تبدیل مبلغ پایه به مبلغ درخواستی کوین انتخابی

expirationTime:
string

تاریخ و زمان انقضای پرداخت

finalizedTime:
string

تاریخ و زمان نهایی شدن پرداخت

}

Trans

apiPaymentsInvoiceGet

انتقال با روش Redirect: در این روش، جهت انتقال به درگاه پرداخت، می بایست کاربر را به همراه token - مطابق مشخصات زیر - به جیب redirect نمایید.


/api/payments/invoice

Usage and SDK Samples

curl -X GET "https://api.apieco.ir/jeeb/api/payments/invoice?token="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TransApi;

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

public class TransApiExample {

    public static void main(String[] args) {
        
        TransApi apiInstance = new TransApi();
        String apiecoKey = apiecoKey_example; // String | apikey for use API
        String token = token_example; // String | 
        try {
            apiInstance.apiPaymentsInvoiceGet(apiecoKey, token);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransApi#apiPaymentsInvoiceGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TransApi;

public class TransApiExample {

    public static void main(String[] args) {
        TransApi apiInstance = new TransApi();
        String apiecoKey = apiecoKey_example; // String | apikey for use API
        String token = token_example; // String | 
        try {
            apiInstance.apiPaymentsInvoiceGet(apiecoKey, token);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransApi#apiPaymentsInvoiceGet");
            e.printStackTrace();
        }
    }
}
String *apiecoKey = apiecoKey_example; // apikey for use API (default to WsLdHK46I5Wfr5xgI0ynjjyiw9Fyhydu)
String *token = token_example; // 

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

// انتقال با روش Redirect: در این روش، جهت انتقال به درگاه پرداخت، می بایست کاربر را به همراه token - مطابق مشخصات زیر - به جیب redirect نمایید.
[apiInstance apiPaymentsInvoiceGetWith:apiecoKey
    token:token
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var _ = require('______');

var api = new _.TransApi()

var apiecoKey = apiecoKey_example; // {String} apikey for use API

var token = token_example; // {String} 


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

namespace Example
{
    public class apiPaymentsInvoiceGetExample
    {
        public void main()
        {
            
            var apiInstance = new TransApi();
            var apiecoKey = apiecoKey_example;  // String | apikey for use API (default to WsLdHK46I5Wfr5xgI0ynjjyiw9Fyhydu)
            var token = token_example;  // String | 

            try
            {
                // انتقال با روش Redirect: در این روش، جهت انتقال به درگاه پرداخت، می بایست کاربر را به همراه token - مطابق مشخصات زیر - به جیب redirect نمایید.
                apiInstance.apiPaymentsInvoiceGet(apiecoKey, token);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TransApi.apiPaymentsInvoiceGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\TransApi();
$apiecoKey = apiecoKey_example; // String | apikey for use API
$token = token_example; // String | 

try {
    $api_instance->apiPaymentsInvoiceGet($apiecoKey, $token);
} catch (Exception $e) {
    echo 'Exception when calling TransApi->apiPaymentsInvoiceGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TransApi;

my $api_instance = WWW::SwaggerClient::TransApi->new();
my $apiecoKey = apiecoKey_example; # String | apikey for use API
my $token = token_example; # String | 

eval { 
    $api_instance->apiPaymentsInvoiceGet(apiecoKey => $apiecoKey, token => $token);
};
if ($@) {
    warn "Exception when calling TransApi->apiPaymentsInvoiceGet: $@\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.TransApi()
apiecoKey = apiecoKey_example # String | apikey for use API (default to WsLdHK46I5Wfr5xgI0ynjjyiw9Fyhydu)
token = token_example # String | 

try: 
    # انتقال با روش Redirect: در این روش، جهت انتقال به درگاه پرداخت، می بایست کاربر را به همراه token - مطابق مشخصات زیر - به جیب redirect نمایید.
    api_instance.api_payments_invoice_get(apiecoKey, token)
except ApiException as e:
    print("Exception when calling TransApi->apiPaymentsInvoiceGet: %s\n" % e)

Parameters

Header parameters
Name Description
apieco-key*
String
apikey for use API
Required
Query parameters
Name Description
token*
String
Required

Responses

Status: 200 - 200 response


apiPaymentsInvoicePost

انتقال با روش ارسال Form: در این روش، جهت انتقال به درگاه پرداخت، می بایست کاربر را به همراه token - مطابق مشخصات زیر - به جیب POST نمایید.


/api/payments/invoice

Usage and SDK Samples

curl -X POST "https://api.apieco.ir/jeeb/api/payments/invoice"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TransApi;

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

public class TransApiExample {

    public static void main(String[] args) {
        
        TransApi apiInstance = new TransApi();
        String apiecoKey = apiecoKey_example; // String | apikey for use API
        Token token = ; // Token | 
        try {
            apiInstance.apiPaymentsInvoicePost(apiecoKey, token);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransApi#apiPaymentsInvoicePost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TransApi;

public class TransApiExample {

    public static void main(String[] args) {
        TransApi apiInstance = new TransApi();
        String apiecoKey = apiecoKey_example; // String | apikey for use API
        Token token = ; // Token | 
        try {
            apiInstance.apiPaymentsInvoicePost(apiecoKey, token);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransApi#apiPaymentsInvoicePost");
            e.printStackTrace();
        }
    }
}
String *apiecoKey = apiecoKey_example; // apikey for use API (default to WsLdHK46I5Wfr5xgI0ynjjyiw9Fyhydu)
Token *token = ; //  (optional)

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

// انتقال با روش ارسال Form: در این روش، جهت انتقال به درگاه پرداخت، می بایست کاربر را به همراه token - مطابق مشخصات زیر - به جیب POST نمایید. 
[apiInstance apiPaymentsInvoicePostWith:apiecoKey
    token:token
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var _ = require('______');

var api = new _.TransApi()

var apiecoKey = apiecoKey_example; // {String} apikey for use API

var opts = { 
  'token':  // {Token} 
};

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

namespace Example
{
    public class apiPaymentsInvoicePostExample
    {
        public void main()
        {
            
            var apiInstance = new TransApi();
            var apiecoKey = apiecoKey_example;  // String | apikey for use API (default to WsLdHK46I5Wfr5xgI0ynjjyiw9Fyhydu)
            var token = new Token(); // Token |  (optional) 

            try
            {
                // انتقال با روش ارسال Form: در این روش، جهت انتقال به درگاه پرداخت، می بایست کاربر را به همراه token - مطابق مشخصات زیر - به جیب POST نمایید. 
                apiInstance.apiPaymentsInvoicePost(apiecoKey, token);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TransApi.apiPaymentsInvoicePost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\TransApi();
$apiecoKey = apiecoKey_example; // String | apikey for use API
$token = ; // Token | 

try {
    $api_instance->apiPaymentsInvoicePost($apiecoKey, $token);
} catch (Exception $e) {
    echo 'Exception when calling TransApi->apiPaymentsInvoicePost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TransApi;

my $api_instance = WWW::SwaggerClient::TransApi->new();
my $apiecoKey = apiecoKey_example; # String | apikey for use API
my $token = WWW::SwaggerClient::Object::Token->new(); # Token | 

eval { 
    $api_instance->apiPaymentsInvoicePost(apiecoKey => $apiecoKey, token => $token);
};
if ($@) {
    warn "Exception when calling TransApi->apiPaymentsInvoicePost: $@\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.TransApi()
apiecoKey = apiecoKey_example # String | apikey for use API (default to WsLdHK46I5Wfr5xgI0ynjjyiw9Fyhydu)
token =  # Token |  (optional)

try: 
    # انتقال با روش ارسال Form: در این روش، جهت انتقال به درگاه پرداخت، می بایست کاربر را به همراه token - مطابق مشخصات زیر - به جیب POST نمایید. 
    api_instance.api_payments_invoice_post(apiecoKey, token=token)
except ApiException as e:
    print("Exception when calling TransApi->apiPaymentsInvoicePost: %s\n" % e)

Parameters

Header parameters
Name Description
apieco-key*
String
apikey for use API
Required
Body parameters
Name Description
token
{
Required: token
token:
string
example: token ایجاد شده برای پرداخت
}

Responses

Status: 200 - 200 response


Webhook

receiverAddressPost

آدرس: توسط پذیرنده در وب سرویس issue تنظیم می شود


/ReceiverAddress/

Usage and SDK Samples

curl -X POST "https://api.apieco.ir/jeeb/ReceiverAddress/"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WebhookApi;

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

public class WebhookApiExample {

    public static void main(String[] args) {
        
        WebhookApi apiInstance = new WebhookApi();
        String apiecoKey = apiecoKey_example; // String | apikey for use API
        Body1 body1 = ; // Body1 | 
        try {
            apiInstance.receiverAddressPost(apiecoKey, body1);
        } catch (ApiException e) {
            System.err.println("Exception when calling WebhookApi#receiverAddressPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.WebhookApi;

public class WebhookApiExample {

    public static void main(String[] args) {
        WebhookApi apiInstance = new WebhookApi();
        String apiecoKey = apiecoKey_example; // String | apikey for use API
        Body1 body1 = ; // Body1 | 
        try {
            apiInstance.receiverAddressPost(apiecoKey, body1);
        } catch (ApiException e) {
            System.err.println("Exception when calling WebhookApi#receiverAddressPost");
            e.printStackTrace();
        }
    }
}
String *apiecoKey = apiecoKey_example; // apikey for use API (default to WsLdHK46I5Wfr5xgI0ynjjyiw9Fyhydu)
Body1 *body1 = ; //  (optional)

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

// آدرس: توسط پذیرنده در وب سرویس issue تنظیم می شود
[apiInstance receiverAddressPostWith:apiecoKey
    body1:body1
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var _ = require('______');

var api = new _.WebhookApi()

var apiecoKey = apiecoKey_example; // {String} apikey for use API

var opts = { 
  'body1':  // {Body1} 
};

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

namespace Example
{
    public class receiverAddressPostExample
    {
        public void main()
        {
            
            var apiInstance = new WebhookApi();
            var apiecoKey = apiecoKey_example;  // String | apikey for use API (default to WsLdHK46I5Wfr5xgI0ynjjyiw9Fyhydu)
            var body1 = new Body1(); // Body1 |  (optional) 

            try
            {
                // آدرس: توسط پذیرنده در وب سرویس issue تنظیم می شود
                apiInstance.receiverAddressPost(apiecoKey, body1);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WebhookApi.receiverAddressPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\WebhookApi();
$apiecoKey = apiecoKey_example; // String | apikey for use API
$body1 = ; // Body1 | 

try {
    $api_instance->receiverAddressPost($apiecoKey, $body1);
} catch (Exception $e) {
    echo 'Exception when calling WebhookApi->receiverAddressPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::WebhookApi;

my $api_instance = WWW::SwaggerClient::WebhookApi->new();
my $apiecoKey = apiecoKey_example; # String | apikey for use API
my $body1 = WWW::SwaggerClient::Object::Body1->new(); # Body1 | 

eval { 
    $api_instance->receiverAddressPost(apiecoKey => $apiecoKey, body1 => $body1);
};
if ($@) {
    warn "Exception when calling WebhookApi->receiverAddressPost: $@\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.WebhookApi()
apiecoKey = apiecoKey_example # String | apikey for use API (default to WsLdHK46I5Wfr5xgI0ynjjyiw9Fyhydu)
body1 =  # Body1 |  (optional)

try: 
    # آدرس: توسط پذیرنده در وب سرویس issue تنظیم می شود
    api_instance.receiver_address_post(apiecoKey, body1=body1)
except ApiException as e:
    print("Exception when calling WebhookApi->receiverAddressPost: %s\n" % e)

Parameters

Header parameters
Name Description
apieco-key*
String
apikey for use API
Required
Body parameters
Name Description
body1
{
Required: baseValue,expirationTime,orderNo,referenceNo,signature,stateId,token,webhookUrl
referenceNo:
string

شماره رهگیری پرداخت در جیب

orderNo:
string

شماره سفارش در سیستم پذیرنده

stateId:
number

کد وضعیت پرداخت

baseValue:
number

مبلغ پایه به بیت کوین، این فیلد برابر است با فیلد value در ورودی وب سرویس issue

coin:
string

کوینی که کاربر بر روی آن تراکنش انجام داده است

value:
number

مبلغ درخواستی بر روی کوین انتخابی

paidValue:
number

مبلغ پرداختی بر روی کوین انتخابی

rate:
number

نرخ تبدیل مبلغ پایه به مبلغ درخواستی کوین انتخابی

expirationTime:
string

تاریخ و زمان انقضای پرداخت

finalizedTime:
string

تاریخ و زمان نهایی شدن پرداخت

token:
string

token پرداخت

signature:
string

امضای دیجیتال درگاه

webhookUrl:
string

webhook url تنظیم شده برای پرداخت

callbackUrl:
string

callback url تنظیم شده برای پرداخت

}

Responses

Status: 200 - 200 response