Jibimo for Business APIs

API and SDK Documentation

Version: 1.2.0

Welcome to Jibimo for Business APIs

Thank you for using Jibimo for business payment API. With this API you can make some amazing transactions using our system to anyone who you have they phone number. This will include sending money as well as receiving it from people. by saying people we mean anyone who may or may not be using Jibimo application. So you don't need to care about it. All you need to do, is to get an administration panel from us and then use our API to communicate with us. Our goal was to create a simple API for you so the tricky part will be done in Jibimo and you don't need to hassle for any problem or error in your part. So let's get started using Jibimo API.

Login to Panel

You can login to your panel at https://jibimo.com/panel using the credentials that your account manager at Jibimo has provided you before. Also for testing proposes you can add a sandbox after jibimo.com and use our sandbox API to test your application. So for testing our API you can go to your panel at https://jibimo.com/sandbox/business/home. Then input your username and password in login form and get into your panel.

Changing Password

For your own security, please head up to Password section to change your auto-generated password to another one. On the side menu bar, press on the Change Password item and when the form is shown, input your new password and press Save button to change it. We will suggest you to keep changing this password in specific period of time, e.g every month. So this will ensure that no body can access your password for ever and also keep in mind that if you lost your password, you need to call our support to reset it to another default password for you.

Generating Personal Access Token

For accessing API, you should use your personal access token which is also will be generated through Credential Codes section. This access token will only show to you the first time you create it. It will never show you back for security reasons. When you are creating these access tokens, you will be asked for some scopes which is related to how you want to limit that token. For the time being we have two scopes, one is for requesting money from people and another is for sending money to them. If you want to be able to both sending and receiving money with that token, simple check both scopes. When the scope was generated and showed up to you, keep it in a safe place. Later in your code you need to send it to Jibimo API endpoint.

Using Personal Token

When you generate access token, you can use it in your request headers in Authorization part. e.g:

Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1Ni...

Receiving JSON Responses From Jibimo

When you are interacting with our API, probably you need to receive JSON results from our server, so it will more developer friendly to set the Accept header to application/json value, so our server will return you back JSON result every time. This is quiet useful in you application also, so you will ensure that allways you will get JSON result. Simply set this header in all of your requests:

Accept: application/json

Request Payment From User

In order to get cash from users, you can use this API. You can pass the mobile_number of user, amount, privacy, description, return_url and tracker_id to the api/business/request_transaction endpoint and then we will create a transaction for you and return you back with a payment gateway URL which you must redirect your user to that URL. Then user will pay you either with Jibimo account (If they have a Jibimo account) or directly with internet payment gateway. After that, we redirect back user to your provided return_url or your default callback URL if there is nor return_url in request. You will need to verify status of the transaction with our verification API which is at api/business/request_transaction/{transaction_id} endpoint. This endpoint will tell you the current status of that transaction.

Pay to User Using Jibimo

If you want to pay user, you can call our api/business/pay endpoint and send the mobile_number of user, amount, privacy, description and tracker_id of transaction to the API, then it will be charged to user account in Jibimo. If user was registered in jibimo, it will be get the money immediately. Otherwise we will send an SMS to user for starting the register process in Jibimo and receive the money after registering in Jibimo. In another words, we are limiting this API to Jibimo accounts only. So if you want to send the money to a user regardless of Jibimo account, you should use or extended pay account.

Directly Pay to People Using IBAN

For a better experience of sending money to people, you can use our extended pay API at api/business/extended-pay endpoint. This API is like our normal pay API but with some more data. In this endpoint you must pass IBAN number of whom you want to send the money. So we will ensure that we can deliver money to that person. If the user was in Jibimo, we will send money to their account in Jibimo and automatically withdraw it to that IBAN number that you provided. Otherwise if that person was not in Jibimo, we will only withdraw that money to the IBAN that you provided. Please keep in mind, that because these transactions are using Paya cycle of Iran's central bank, they will done in specific period of time which you need to ask from Jibimo support in case of any questions.

Default

app\Http\Controllers\Business\ExtendedPayTransactionControllerShow

Check status of an extended payment transaction

/api/business/extended-pay/{transaction_id}

Usage and SDK Samples

curl -X GET "https://api.apieco.ir/jibimo/api/business/extended-pay/{transaction_id}"

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

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

public class DefaultApiExample {

    public static void main(String[] args) {
        
        DefaultApi apiInstance = new DefaultApi();
        String authorization = authorization_example; // String | Access token which must be started with `Bearer ` plus a space and access token. e.g. `Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1Ni...`
        Integer transactionId = 56; // Integer | Transaction ID
        String accept = accept_example; // String | Type of response which you want to get from server.
        try {
            apiInstance.app\Http\Controllers\Business\ExtendedPayTransactionControllerShow(authorization, transactionId, accept);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#app\Http\Controllers\Business\ExtendedPayTransactionControllerShow");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String authorization = authorization_example; // String | Access token which must be started with `Bearer ` plus a space and access token. e.g. `Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1Ni...`
        Integer transactionId = 56; // Integer | Transaction ID
        String accept = accept_example; // String | Type of response which you want to get from server.
        try {
            apiInstance.app\Http\Controllers\Business\ExtendedPayTransactionControllerShow(authorization, transactionId, accept);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#app\Http\Controllers\Business\ExtendedPayTransactionControllerShow");
            e.printStackTrace();
        }
    }
}

String *authorization = authorization_example; // Access token which must be started with `Bearer ` plus a space and access token. e.g. `Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1Ni...`
Integer *transactionId = 56; // Transaction ID
String *accept = accept_example; // Type of response which you want to get from server. (optional)

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

// Check status of an extended payment transaction
[apiInstance app\Http\Controllers\Business\ExtendedPayTransactionControllerShowWith:authorization
    transactionId:transactionId
    accept:accept
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var JibimoForBusinessApIs = require('jibimo_for_business_ap_is');

var api = new JibimoForBusinessApIs.DefaultApi()
var authorization = authorization_example; // {{String}} Access token which must be started with `Bearer ` plus a space and access token. e.g. `Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1Ni...`
var transactionId = 56; // {{Integer}} Transaction ID
var opts = { 
  'accept': accept_example // {{String}} Type of response which you want to get from server.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.app\Http\Controllers\Business\ExtendedPayTransactionControllerShow(authorization, transactionId, opts, callback);

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

namespace Example
{
    public class app\Http\Controllers\Business\ExtendedPayTransactionControllerShowExample
    {
        public void main()
        {

            var apiInstance = new DefaultApi();
            var authorization = authorization_example;  // String | Access token which must be started with `Bearer ` plus a space and access token. e.g. `Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1Ni...`
            var transactionId = 56;  // Integer | Transaction ID
            var accept = accept_example;  // String | Type of response which you want to get from server. (optional) 

            try
            {
                // Check status of an extended payment transaction
                apiInstance.app\Http\Controllers\Business\ExtendedPayTransactionControllerShow(authorization, transactionId, accept);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.app\Http\Controllers\Business\ExtendedPayTransactionControllerShow: " + e.Message );
            }
        }
    }
}

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

$api_instance = new Swagger\Client\ApiDefaultApi();
$authorization = authorization_example; // String | Access token which must be started with `Bearer ` plus a space and access token. e.g. `Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1Ni...`
$transactionId = 56; // Integer | Transaction ID
$accept = accept_example; // String | Type of response which you want to get from server.

try {
    $api_instance->app\Http\Controllers\Business\ExtendedPayTransactionControllerShow($authorization, $transactionId, $accept);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->app\Http\Controllers\Business\ExtendedPayTransactionControllerShow: ', $e->getMessage(), PHP_EOL;
}
?>

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

my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $authorization = authorization_example; # String | Access token which must be started with `Bearer ` plus a space and access token. e.g. `Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1Ni...`
my $transactionId = 56; # Integer | Transaction ID
my $accept = accept_example; # String | Type of response which you want to get from server.

eval { 
    $api_instance->app\Http\Controllers\Business\ExtendedPayTransactionControllerShow(authorization => $authorization, transactionId => $transactionId, accept => $accept);
};
if ($@) {
    warn "Exception when calling DefaultApi->app\Http\Controllers\Business\ExtendedPayTransactionControllerShow: $@\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.DefaultApi()
authorization = authorization_example # String | Access token which must be started with `Bearer ` plus a space and access token. e.g. `Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1Ni...`
transactionId = 56 # Integer | Transaction ID
accept = accept_example # String | Type of response which you want to get from server. (optional)

try: 
    # Check status of an extended payment transaction
    api_instance.app\http\controllers\business\extended_pay_transaction_controller_show(authorization, transactionId, accept=accept)
except ApiException as e:
    print("Exception when calling DefaultApi->app\Http\Controllers\Business\ExtendedPayTransactionControllerShow: %s\n" % e)

Parameters

Path parameters

Name	Description
transaction_id*	Integer Transaction ID Required

Header parameters

Name	Description
Authorization*	String Access token which must be started with `Bearer ` plus a space and access token. e.g. `Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1Ni...` Required
Accept	String Type of response which you want to get from server.

Responses

Status: 200 - Status of transaction in JSON which contains `id` which is transaction ID, `tracker_id`, `amount`, `payee`, `payer`, `privacy`, `status`, `created_at`, `updated_at` and `description`.

app\Http\Controllers\Business\ExtendedPayTransactionControllerStore

Pay to users with more features such as direct pay with IBAN number

/api/business/extended-pay

Usage and SDK Samples

curl -X POST "https://api.apieco.ir/jibimo/api/business/extended-pay"

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

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

public class DefaultApiExample {

    public static void main(String[] args) {
        
        DefaultApi apiInstance = new DefaultApi();
        Body body = ; // Body | Extended pay request body
        String authorization = authorization_example; // String | Access token which must be started with `Bearer ` plus a space and access token. e.g. `Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1Ni...`
        String accept = accept_example; // String | Type of response which you want to get from server.
        try {
            apiInstance.app\Http\Controllers\Business\ExtendedPayTransactionControllerStore(body, authorization, accept);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#app\Http\Controllers\Business\ExtendedPayTransactionControllerStore");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        Body body = ; // Body | Extended pay request body
        String authorization = authorization_example; // String | Access token which must be started with `Bearer ` plus a space and access token. e.g. `Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1Ni...`
        String accept = accept_example; // String | Type of response which you want to get from server.
        try {
            apiInstance.app\Http\Controllers\Business\ExtendedPayTransactionControllerStore(body, authorization, accept);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#app\Http\Controllers\Business\ExtendedPayTransactionControllerStore");
            e.printStackTrace();
        }
    }
}

Body *body = ; // Extended pay request body
String *authorization = authorization_example; // Access token which must be started with `Bearer ` plus a space and access token. e.g. `Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1Ni...`
String *accept = accept_example; // Type of response which you want to get from server. (optional)

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

// Pay to users with more features such as direct pay with IBAN number
[apiInstance app\Http\Controllers\Business\ExtendedPayTransactionControllerStoreWith:body
    authorization:authorization
    accept:accept
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var JibimoForBusinessApIs = require('jibimo_for_business_ap_is');

var api = new JibimoForBusinessApIs.DefaultApi()
var body = ; // {{Body}} Extended pay request body
var authorization = authorization_example; // {{String}} Access token which must be started with `Bearer ` plus a space and access token. e.g. `Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1Ni...`
var opts = { 
  'accept': accept_example // {{String}} Type of response which you want to get from server.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.app\Http\Controllers\Business\ExtendedPayTransactionControllerStore(bodyauthorization, opts, callback);

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

namespace Example
{
    public class app\Http\Controllers\Business\ExtendedPayTransactionControllerStoreExample
    {
        public void main()
        {

            var apiInstance = new DefaultApi();
            var body = new Body(); // Body | Extended pay request body
            var authorization = authorization_example;  // String | Access token which must be started with `Bearer ` plus a space and access token. e.g. `Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1Ni...`
            var accept = accept_example;  // String | Type of response which you want to get from server. (optional) 

            try
            {
                // Pay to users with more features such as direct pay with IBAN number
                apiInstance.app\Http\Controllers\Business\ExtendedPayTransactionControllerStore(body, authorization, accept);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.app\Http\Controllers\Business\ExtendedPayTransactionControllerStore: " + e.Message );
            }
        }
    }
}

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

$api_instance = new Swagger\Client\ApiDefaultApi();
$body = ; // Body | Extended pay request body
$authorization = authorization_example; // String | Access token which must be started with `Bearer ` plus a space and access token. e.g. `Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1Ni...`
$accept = accept_example; // String | Type of response which you want to get from server.

try {
    $api_instance->app\Http\Controllers\Business\ExtendedPayTransactionControllerStore($body, $authorization, $accept);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->app\Http\Controllers\Business\ExtendedPayTransactionControllerStore: ', $e->getMessage(), PHP_EOL;
}
?>

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

my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $body = WWW::SwaggerClient::Object::Body->new(); # Body | Extended pay request body
my $authorization = authorization_example; # String | Access token which must be started with `Bearer ` plus a space and access token. e.g. `Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1Ni...`
my $accept = accept_example; # String | Type of response which you want to get from server.

eval { 
    $api_instance->app\Http\Controllers\Business\ExtendedPayTransactionControllerStore(body => $body, authorization => $authorization, accept => $accept);
};
if ($@) {
    warn "Exception when calling DefaultApi->app\Http\Controllers\Business\ExtendedPayTransactionControllerStore: $@\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.DefaultApi()
body =  # Body | Extended pay request body
authorization = authorization_example # String | Access token which must be started with `Bearer ` plus a space and access token. e.g. `Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1Ni...`
accept = accept_example # String | Type of response which you want to get from server. (optional)

try: 
    # Pay to users with more features such as direct pay with IBAN number
    api_instance.app\http\controllers\business\extended_pay_transaction_controller_store(body, authorization, accept=accept)
except ApiException as e:
    print("Exception when calling DefaultApi->app\Http\Controllers\Business\ExtendedPayTransactionControllerStore: %s\n" % e)

Parameters

Header parameters

Name	Description
Authorization*	String Access token which must be started with `Bearer ` plus a space and access token. e.g. `Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1Ni...` Required
Accept	String Type of response which you want to get from server.

Body parameters

Name	Description
body *

Responses

Status: 200 - The amount will be added to the user's Jibimo account and then will be directed to your callback URL with a JSON result of `id` which is transaction ID, `tracker_id`, `amount`, `payee`, `payer`, `privacy`, `status`, `created_at`, `updated_at` and `description`.

Status: 401 - An "Unauthorized" error.

Status: 422 - An array of errors.

app\Http\Controllers\Business\PayTransactionControllerShow

Check status of a payment transaction

/api/business/pay/{transaction_id}

Usage and SDK Samples

curl -X GET "https://api.apieco.ir/jibimo/api/business/pay/{transaction_id}"

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

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

public class DefaultApiExample {

    public static void main(String[] args) {
        
        DefaultApi apiInstance = new DefaultApi();
        String authorization = authorization_example; // String | Access token which must be started with `Bearer ` plus a space and access token. e.g. `Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1Ni...`
        Integer transactionId = 56; // Integer | Transaction ID
        String accept = accept_example; // String | Type of response which you want to get from server.
        try {
            apiInstance.app\Http\Controllers\Business\PayTransactionControllerShow(authorization, transactionId, accept);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#app\Http\Controllers\Business\PayTransactionControllerShow");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String authorization = authorization_example; // String | Access token which must be started with `Bearer ` plus a space and access token. e.g. `Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1Ni...`
        Integer transactionId = 56; // Integer | Transaction ID
        String accept = accept_example; // String | Type of response which you want to get from server.
        try {
            apiInstance.app\Http\Controllers\Business\PayTransactionControllerShow(authorization, transactionId, accept);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#app\Http\Controllers\Business\PayTransactionControllerShow");
            e.printStackTrace();
        }
    }
}

String *authorization = authorization_example; // Access token which must be started with `Bearer ` plus a space and access token. e.g. `Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1Ni...`
Integer *transactionId = 56; // Transaction ID
String *accept = accept_example; // Type of response which you want to get from server. (optional)

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

// Check status of a payment transaction
[apiInstance app\Http\Controllers\Business\PayTransactionControllerShowWith:authorization
    transactionId:transactionId
    accept:accept
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var JibimoForBusinessApIs = require('jibimo_for_business_ap_is');

var api = new JibimoForBusinessApIs.DefaultApi()
var authorization = authorization_example; // {{String}} Access token which must be started with `Bearer ` plus a space and access token. e.g. `Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1Ni...`
var transactionId = 56; // {{Integer}} Transaction ID
var opts = { 
  'accept': accept_example // {{String}} Type of response which you want to get from server.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.app\Http\Controllers\Business\PayTransactionControllerShow(authorization, transactionId, opts, callback);

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

namespace Example
{
    public class app\Http\Controllers\Business\PayTransactionControllerShowExample
    {
        public void main()
        {

            var apiInstance = new DefaultApi();
            var authorization = authorization_example;  // String | Access token which must be started with `Bearer ` plus a space and access token. e.g. `Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1Ni...`
            var transactionId = 56;  // Integer | Transaction ID
            var accept = accept_example;  // String | Type of response which you want to get from server. (optional) 

            try
            {
                // Check status of a payment transaction
                apiInstance.app\Http\Controllers\Business\PayTransactionControllerShow(authorization, transactionId, accept);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.app\Http\Controllers\Business\PayTransactionControllerShow: " + e.Message );
            }
        }
    }
}

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

$api_instance = new Swagger\Client\ApiDefaultApi();
$authorization = authorization_example; // String | Access token which must be started with `Bearer ` plus a space and access token. e.g. `Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1Ni...`
$transactionId = 56; // Integer | Transaction ID
$accept = accept_example; // String | Type of response which you want to get from server.

try {
    $api_instance->app\Http\Controllers\Business\PayTransactionControllerShow($authorization, $transactionId, $accept);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->app\Http\Controllers\Business\PayTransactionControllerShow: ', $e->getMessage(), PHP_EOL;
}
?>

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

my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $authorization = authorization_example; # String | Access token which must be started with `Bearer ` plus a space and access token. e.g. `Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1Ni...`
my $transactionId = 56; # Integer | Transaction ID
my $accept = accept_example; # String | Type of response which you want to get from server.

eval { 
    $api_instance->app\Http\Controllers\Business\PayTransactionControllerShow(authorization => $authorization, transactionId => $transactionId, accept => $accept);
};
if ($@) {
    warn "Exception when calling DefaultApi->app\Http\Controllers\Business\PayTransactionControllerShow: $@\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.DefaultApi()
authorization = authorization_example # String | Access token which must be started with `Bearer ` plus a space and access token. e.g. `Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1Ni...`
transactionId = 56 # Integer | Transaction ID
accept = accept_example # String | Type of response which you want to get from server. (optional)

try: 
    # Check status of a payment transaction
    api_instance.app\http\controllers\business\pay_transaction_controller_show(authorization, transactionId, accept=accept)
except ApiException as e:
    print("Exception when calling DefaultApi->app\Http\Controllers\Business\PayTransactionControllerShow: %s\n" % e)

Parameters

Path parameters

Name	Description
transaction_id*	Integer Transaction ID Required

Header parameters

Name	Description
Authorization*	String Access token which must be started with `Bearer ` plus a space and access token. e.g. `Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1Ni...` Required
Accept	String Type of response which you want to get from server.

Responses

Status: 200 - Status of transaction in JSON which contains `id` which is transaction ID, `tracker_id`, `amount`, `payee`, `payer`, `privacy`, `status`, `created_at`, `updated_at` and `description`.

app\Http\Controllers\Business\PayTransactionControllerStore

Pay to user

/api/business/pay

Usage and SDK Samples

curl -X POST "https://api.apieco.ir/jibimo/api/business/pay"

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

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

public class DefaultApiExample {

    public static void main(String[] args) {
        
        DefaultApi apiInstance = new DefaultApi();
        Body_1 body = ; // Body_1 | Normal pay request body
        String authorization = authorization_example; // String | Access token which must be started with `Bearer ` plus a space and access token. e.g. `Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1Ni...`
        String accept = accept_example; // String | Type of response which you want to get from server.
        try {
            apiInstance.app\Http\Controllers\Business\PayTransactionControllerStore(body, authorization, accept);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#app\Http\Controllers\Business\PayTransactionControllerStore");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        Body_1 body = ; // Body_1 | Normal pay request body
        String authorization = authorization_example; // String | Access token which must be started with `Bearer ` plus a space and access token. e.g. `Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1Ni...`
        String accept = accept_example; // String | Type of response which you want to get from server.
        try {
            apiInstance.app\Http\Controllers\Business\PayTransactionControllerStore(body, authorization, accept);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#app\Http\Controllers\Business\PayTransactionControllerStore");
            e.printStackTrace();
        }
    }
}

Body_1 *body = ; // Normal pay request body
String *authorization = authorization_example; // Access token which must be started with `Bearer ` plus a space and access token. e.g. `Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1Ni...`
String *accept = accept_example; // Type of response which you want to get from server. (optional)

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

// Pay to user
[apiInstance app\Http\Controllers\Business\PayTransactionControllerStoreWith:body
    authorization:authorization
    accept:accept
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var JibimoForBusinessApIs = require('jibimo_for_business_ap_is');

var api = new JibimoForBusinessApIs.DefaultApi()
var body = ; // {{Body_1}} Normal pay request body
var authorization = authorization_example; // {{String}} Access token which must be started with `Bearer ` plus a space and access token. e.g. `Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1Ni...`
var opts = { 
  'accept': accept_example // {{String}} Type of response which you want to get from server.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.app\Http\Controllers\Business\PayTransactionControllerStore(bodyauthorization, opts, callback);

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

namespace Example
{
    public class app\Http\Controllers\Business\PayTransactionControllerStoreExample
    {
        public void main()
        {

            var apiInstance = new DefaultApi();
            var body = new Body_1(); // Body_1 | Normal pay request body
            var authorization = authorization_example;  // String | Access token which must be started with `Bearer ` plus a space and access token. e.g. `Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1Ni...`
            var accept = accept_example;  // String | Type of response which you want to get from server. (optional) 

            try
            {
                // Pay to user
                apiInstance.app\Http\Controllers\Business\PayTransactionControllerStore(body, authorization, accept);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.app\Http\Controllers\Business\PayTransactionControllerStore: " + e.Message );
            }
        }
    }
}

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

$api_instance = new Swagger\Client\ApiDefaultApi();
$body = ; // Body_1 | Normal pay request body
$authorization = authorization_example; // String | Access token which must be started with `Bearer ` plus a space and access token. e.g. `Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1Ni...`
$accept = accept_example; // String | Type of response which you want to get from server.

try {
    $api_instance->app\Http\Controllers\Business\PayTransactionControllerStore($body, $authorization, $accept);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->app\Http\Controllers\Business\PayTransactionControllerStore: ', $e->getMessage(), PHP_EOL;
}
?>

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

my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $body = WWW::SwaggerClient::Object::Body_1->new(); # Body_1 | Normal pay request body
my $authorization = authorization_example; # String | Access token which must be started with `Bearer ` plus a space and access token. e.g. `Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1Ni...`
my $accept = accept_example; # String | Type of response which you want to get from server.

eval { 
    $api_instance->app\Http\Controllers\Business\PayTransactionControllerStore(body => $body, authorization => $authorization, accept => $accept);
};
if ($@) {
    warn "Exception when calling DefaultApi->app\Http\Controllers\Business\PayTransactionControllerStore: $@\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.DefaultApi()
body =  # Body_1 | Normal pay request body
authorization = authorization_example # String | Access token which must be started with `Bearer ` plus a space and access token. e.g. `Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1Ni...`
accept = accept_example # String | Type of response which you want to get from server. (optional)

try: 
    # Pay to user
    api_instance.app\http\controllers\business\pay_transaction_controller_store(body, authorization, accept=accept)
except ApiException as e:
    print("Exception when calling DefaultApi->app\Http\Controllers\Business\PayTransactionControllerStore: %s\n" % e)

Parameters

Header parameters

Name	Description
Authorization*	String Access token which must be started with `Bearer ` plus a space and access token. e.g. `Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1Ni...` Required
Accept	String Type of response which you want to get from server.

Body parameters

Name	Description
body *

Responses

Status: 200 - The amount will be added to the user's Jibimo account and then will be directed to your callback URL with a JSON result of `id` which is transaction ID, `tracker_id`, `amount`, `payee`, `payer`, `privacy`, `status`, `created_at`, `updated_at` and `description`.

Status: 401 - An "Unauthorized" error.

Status: 422 - An array of errors.

app\Http\Controllers\Business\RequestTransactionControllerShow

Check status of a payment request transaction

/api/business/request_transaction/{transaction_id}

Usage and SDK Samples

curl -X GET "https://api.apieco.ir/jibimo/api/business/request_transaction/{transaction_id}"

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

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

public class DefaultApiExample {

    public static void main(String[] args) {
        
        DefaultApi apiInstance = new DefaultApi();
        String authorization = authorization_example; // String | Access token which must be started with `Bearer ` plus a space and access token. e.g. `Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1Ni...`
        Integer transactionId = 56; // Integer | Transaction ID
        String accept = accept_example; // String | Type of response which you want to get from server.
        try {
            apiInstance.app\Http\Controllers\Business\RequestTransactionControllerShow(authorization, transactionId, accept);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#app\Http\Controllers\Business\RequestTransactionControllerShow");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String authorization = authorization_example; // String | Access token which must be started with `Bearer ` plus a space and access token. e.g. `Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1Ni...`
        Integer transactionId = 56; // Integer | Transaction ID
        String accept = accept_example; // String | Type of response which you want to get from server.
        try {
            apiInstance.app\Http\Controllers\Business\RequestTransactionControllerShow(authorization, transactionId, accept);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#app\Http\Controllers\Business\RequestTransactionControllerShow");
            e.printStackTrace();
        }
    }
}

String *authorization = authorization_example; // Access token which must be started with `Bearer ` plus a space and access token. e.g. `Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1Ni...`
Integer *transactionId = 56; // Transaction ID
String *accept = accept_example; // Type of response which you want to get from server. (optional)

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

// Check status of a payment request transaction
[apiInstance app\Http\Controllers\Business\RequestTransactionControllerShowWith:authorization
    transactionId:transactionId
    accept:accept
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var JibimoForBusinessApIs = require('jibimo_for_business_ap_is');

var api = new JibimoForBusinessApIs.DefaultApi()
var authorization = authorization_example; // {{String}} Access token which must be started with `Bearer ` plus a space and access token. e.g. `Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1Ni...`
var transactionId = 56; // {{Integer}} Transaction ID
var opts = { 
  'accept': accept_example // {{String}} Type of response which you want to get from server.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.app\Http\Controllers\Business\RequestTransactionControllerShow(authorization, transactionId, opts, callback);

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

namespace Example
{
    public class app\Http\Controllers\Business\RequestTransactionControllerShowExample
    {
        public void main()
        {

            var apiInstance = new DefaultApi();
            var authorization = authorization_example;  // String | Access token which must be started with `Bearer ` plus a space and access token. e.g. `Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1Ni...`
            var transactionId = 56;  // Integer | Transaction ID
            var accept = accept_example;  // String | Type of response which you want to get from server. (optional) 

            try
            {
                // Check status of a payment request transaction
                apiInstance.app\Http\Controllers\Business\RequestTransactionControllerShow(authorization, transactionId, accept);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.app\Http\Controllers\Business\RequestTransactionControllerShow: " + e.Message );
            }
        }
    }
}

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

$api_instance = new Swagger\Client\ApiDefaultApi();
$authorization = authorization_example; // String | Access token which must be started with `Bearer ` plus a space and access token. e.g. `Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1Ni...`
$transactionId = 56; // Integer | Transaction ID
$accept = accept_example; // String | Type of response which you want to get from server.

try {
    $api_instance->app\Http\Controllers\Business\RequestTransactionControllerShow($authorization, $transactionId, $accept);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->app\Http\Controllers\Business\RequestTransactionControllerShow: ', $e->getMessage(), PHP_EOL;
}
?>

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

my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $authorization = authorization_example; # String | Access token which must be started with `Bearer ` plus a space and access token. e.g. `Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1Ni...`
my $transactionId = 56; # Integer | Transaction ID
my $accept = accept_example; # String | Type of response which you want to get from server.

eval { 
    $api_instance->app\Http\Controllers\Business\RequestTransactionControllerShow(authorization => $authorization, transactionId => $transactionId, accept => $accept);
};
if ($@) {
    warn "Exception when calling DefaultApi->app\Http\Controllers\Business\RequestTransactionControllerShow: $@\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.DefaultApi()
authorization = authorization_example # String | Access token which must be started with `Bearer ` plus a space and access token. e.g. `Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1Ni...`
transactionId = 56 # Integer | Transaction ID
accept = accept_example # String | Type of response which you want to get from server. (optional)

try: 
    # Check status of a payment request transaction
    api_instance.app\http\controllers\business\request_transaction_controller_show(authorization, transactionId, accept=accept)
except ApiException as e:
    print("Exception when calling DefaultApi->app\Http\Controllers\Business\RequestTransactionControllerShow: %s\n" % e)

Parameters

Path parameters

Name	Description
transaction_id*	Integer Transaction ID Required

Header parameters

Name	Description
Authorization*	String Access token which must be started with `Bearer ` plus a space and access token. e.g. `Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1Ni...` Required
Accept	String Type of response which you want to get from server.

Responses

Status: 200 - Status of transaction in JSON which contains `id` which is transaction ID, `tracker_id`, `amount`, `payee`, `payer`, `privacy`, `status`, `created_at`, `updated_at` and `description`.

app\Http\Controllers\Business\RequestTransactionControllerStore

Request cash from a user

/api/business/request_transaction

Usage and SDK Samples

curl -X POST "https://api.apieco.ir/jibimo/api/business/request_transaction"

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

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

public class DefaultApiExample {

    public static void main(String[] args) {
        
        DefaultApi apiInstance = new DefaultApi();
        Body_2 body = ; // Body_2 | Here you can see normal pay request
        String authorization = authorization_example; // String | Access token which must be started with `Bearer ` plus a space and access token. e.g. `Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1Ni...`
        String accept = accept_example; // String | Type of response which you want to get from server.
        try {
            apiInstance.app\Http\Controllers\Business\RequestTransactionControllerStore(body, authorization, accept);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#app\Http\Controllers\Business\RequestTransactionControllerStore");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        Body_2 body = ; // Body_2 | Here you can see normal pay request
        String authorization = authorization_example; // String | Access token which must be started with `Bearer ` plus a space and access token. e.g. `Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1Ni...`
        String accept = accept_example; // String | Type of response which you want to get from server.
        try {
            apiInstance.app\Http\Controllers\Business\RequestTransactionControllerStore(body, authorization, accept);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#app\Http\Controllers\Business\RequestTransactionControllerStore");
            e.printStackTrace();
        }
    }
}

Body_2 *body = ; // Here you can see normal pay request
String *authorization = authorization_example; // Access token which must be started with `Bearer ` plus a space and access token. e.g. `Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1Ni...`
String *accept = accept_example; // Type of response which you want to get from server. (optional)

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

// Request cash from a user
[apiInstance app\Http\Controllers\Business\RequestTransactionControllerStoreWith:body
    authorization:authorization
    accept:accept
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var JibimoForBusinessApIs = require('jibimo_for_business_ap_is');

var api = new JibimoForBusinessApIs.DefaultApi()
var body = ; // {{Body_2}} Here you can see normal pay request
var authorization = authorization_example; // {{String}} Access token which must be started with `Bearer ` plus a space and access token. e.g. `Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1Ni...`
var opts = { 
  'accept': accept_example // {{String}} Type of response which you want to get from server.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.app\Http\Controllers\Business\RequestTransactionControllerStore(bodyauthorization, opts, callback);

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

namespace Example
{
    public class app\Http\Controllers\Business\RequestTransactionControllerStoreExample
    {
        public void main()
        {

            var apiInstance = new DefaultApi();
            var body = new Body_2(); // Body_2 | Here you can see normal pay request
            var authorization = authorization_example;  // String | Access token which must be started with `Bearer ` plus a space and access token. e.g. `Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1Ni...`
            var accept = accept_example;  // String | Type of response which you want to get from server. (optional) 

            try
            {
                // Request cash from a user
                apiInstance.app\Http\Controllers\Business\RequestTransactionControllerStore(body, authorization, accept);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.app\Http\Controllers\Business\RequestTransactionControllerStore: " + e.Message );
            }
        }
    }
}

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

$api_instance = new Swagger\Client\ApiDefaultApi();
$body = ; // Body_2 | Here you can see normal pay request
$authorization = authorization_example; // String | Access token which must be started with `Bearer ` plus a space and access token. e.g. `Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1Ni...`
$accept = accept_example; // String | Type of response which you want to get from server.

try {
    $api_instance->app\Http\Controllers\Business\RequestTransactionControllerStore($body, $authorization, $accept);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->app\Http\Controllers\Business\RequestTransactionControllerStore: ', $e->getMessage(), PHP_EOL;
}
?>

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

my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $body = WWW::SwaggerClient::Object::Body_2->new(); # Body_2 | Here you can see normal pay request
my $authorization = authorization_example; # String | Access token which must be started with `Bearer ` plus a space and access token. e.g. `Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1Ni...`
my $accept = accept_example; # String | Type of response which you want to get from server.

eval { 
    $api_instance->app\Http\Controllers\Business\RequestTransactionControllerStore(body => $body, authorization => $authorization, accept => $accept);
};
if ($@) {
    warn "Exception when calling DefaultApi->app\Http\Controllers\Business\RequestTransactionControllerStore: $@\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.DefaultApi()
body =  # Body_2 | Here you can see normal pay request
authorization = authorization_example # String | Access token which must be started with `Bearer ` plus a space and access token. e.g. `Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1Ni...`
accept = accept_example # String | Type of response which you want to get from server. (optional)

try: 
    # Request cash from a user
    api_instance.app\http\controllers\business\request_transaction_controller_store(body, authorization, accept=accept)
except ApiException as e:
    print("Exception when calling DefaultApi->app\Http\Controllers\Business\RequestTransactionControllerStore: %s\n" % e)

Parameters

Header parameters

Name	Description
Authorization*	String Access token which must be started with `Bearer ` plus a space and access token. e.g. `Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1Ni...` Required
Accept	String Type of response which you want to get from server.

Body parameters

Name	Description
body *

Responses

Status: 200 - The amount will be added to your business account, and then user will be directed to your callback URL with a JSON result of `id` which is transaction ID, `tracker_id`, `amount`, `payee`, `payer`, `privacy`, `status`, `created_at`, `updated_at` and `description`.