IDPay Web Service API

https://idpay.ir/web-service/v1.1
Admin
IDPay is a REST-based payment gateway API that enables developers to integrate payment processing,...
Tokens:17,101
Snippets:70
Trust Score:10
Update:3 months ago
Show doc for...
Tokens:
Raw
### List Transactions Request Example

Source: https://idpay.ir/web-service/v1.1/index.html

This example shows a basic POST request to the transactions endpoint. Optional URL parameters like 'page' and 'page_size' can be used for pagination.

```bash
POST https://api.idpay.ir/v1.1/payment/transactions
```

--------------------------------

### API Key Authentication Header

Source: https://idpay.ir/web-service/v1.1/index.html

To authenticate API requests, include your unique API key in the 'X-API-KEY' header. Replace the example key with your actual API key.

```http
X-API-KEY: 6a7f99eb-7c20-4412-a972-6dfb7cd253a4
```

--------------------------------

### Verify Transaction with Node.js

Source: https://idpay.ir/web-service/v1.1/index.html

This Node.js example uses the 'request' library to send a POST request for transaction verification. It configures the request options including URL, headers, and JSON body.

```javascript
var request = require('request');

var options = {
  method: 'POST',
  url: 'https://api.idpay.ir/v1.1/payment/verify',
  headers: {
    'Content-Type': 'application/json',
    'X-API-KEY': '6a7f99eb-7c20-4412-a972-6dfb7cd253a4',
    'X-SANDBOX': 1,
  },
  body: {
    'id': 'd2e353189823079e1e4181772cff5292',
    'order_id': '101',
  },
  json: true,
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

```

--------------------------------

### Get Transaction List

Source: https://idpay.ir/web-service/v1.1/index.html

Fetches a list of transactions based on provided filters and pagination parameters.

```APIDOC
## POST /v1.1/payment/transactions

### Description
Retrieves a list of transactions with optional filtering and pagination.

### Method
POST

### Endpoint
https://api.idpay.ir/v1.1/payment/transactions

### Parameters
#### Query Parameters
- **page** (number) - Optional - The page number, starting from 0. Defaults to 0.
- **page_size** (number) - Optional - The number of records per page. Defaults to the last 25 transactions.

#### Request Body
- **id** (string) - Optional - The unique identifier received when creating the order.
- **order_id** (string) - Optional - The merchant's order number (max 50 characters).
- **amount** (number) - Optional - The transaction amount in Rials. Must be between 1,000 and 500,000,000 Rials.
- **status** (array) - Optional - An array of transaction statuses.
- **track_id** (string) - Optional - The IDPay tracking code.
- **payment_card_no** (string) - Optional - The payment card number of the payer (format: 123456******1234).
- **payment_hashed_card_no** (string) - Optional - The SHA256 hashed payment card number of the payer.
- **payment_date** (object) - Optional - A range object for the payment transaction, including minimum and maximum timestamps.
- **settlement_date** (object) - Optional - A range object for the transaction settlement with the merchant, including minimum and maximum timestamps.

### Response
#### Success Response (200)
- **attachment** (object) - Contains metadata about the transaction list.
  - **timestamp** (number) - Timestamp of the attachment.
  - **total_count** (number) - Total number of transactions.
  - **page_count** (number) - Total number of pages.
  - **current_page** (number) - The current page number.
  - **total_amount** (string) - The total amount of all transactions.
  - **page_amount** (number) - The total amount for the current page.
- **records** (array) - A list of transaction objects.
  - **status** (string) - Transaction status.
  - **track_id** (string) - IDPay tracking code.
  - **id** (string) - Unique transaction ID.
  - **order_id** (string) - Merchant's order ID.
  - **amount** (string) - Transaction amount.
  - **wage** (object) - Transaction fee information.
    - **by** (string) - Fee recipient ('payee' or 'payer').
    - **type** (string) - Fee type ('amount', 'percent', 'stair').
    - **amount** (string) - Fee amount.
  - **date** (timestamp) - Transaction creation timestamp.
  - **payer** (object) - Payer information.
    - **name** (string) - Payer's name.
    - **phone** (string) - Payer's phone number.
    - **mail** (string) - Payer's email.
    - **desc** (string) - Payer's description.
  - **payment** (object) - Payment information.
    - **track_id** (string) - Payment tracking ID.
    - **amount** (number) - Payable amount.
    - **card_no** (string) - Payer's card number.
    - **hashed_card_no** (string) - Hashed payer's card number.
    - **date** (timestamp) - Payment transaction timestamp.
  - **verify** (object) - Verification information.
    - **date** (timestamp) - Verification timestamp.
  - **settlement** (object) - Settlement information.
    - **account** (object) - Bank account details.
      - **id** (string) - Account ID.
      - **iban** (string) - IBAN.
      - **number** (string) - Account number.
      - **bank** (object) - Bank details.
        - **id** (string) - Bank ID.
        - **title** (string) - Bank title.
    - **wallet** (object) - IDPay wallet details.
      - **track_id** (number) - Settlement tracking ID.
    - **track_id** (number) - Settlement tracking ID.
    - **amount** (number) - Settled amount.
    - **date** (timestamp) - Settlement timestamp.

#### Error Response (403, 406)
- **error_code** (number) - Error code.
- **error_message** (string) - Error message.

### Request Example
```json
{
  "order_id": "101",
  "amount": 10000,
  "status": ["100"]
}
```

### Response Example (200)
```json
{
  "attachment": {
    "timestamp": 1601376343,
    "total_count": 1,
    "page_count": 1,
    "current_page": 0,
    "total_amount": "10000",
    "page_amount": 10000
  },
  "records": [
    {
      "status": "100",
      "track_id": "10012",
      "id": "d2e353189823079e1e4181772cff5292",
      "order_id": "101",
      "amount": "10000",
      "wage": {
        "by": "payee",
        "type": "percent",
        "amount": "2500"
      },
      "date": "1546288200",
      "payer": {
        "name": "قاسم رادمان",
        "phone": "09382198592",
        "mail": "my@site.com",
        "desc": "توضیحات پرداخت کننده"
      },
      "payment": {
        "track_id": "888001",
        "amount": "10000",
        "card_no": "123456******1234",
        "hashed_card_no": "E59FA6241C94B8836E3D03120DF33E80FD988888BBA0A122240C2E7D23B48295",
        "date": "1546288500"
      },
      "verify": {
        "date": "1546288800"
      },
      "settlement": {
        "account": {
          "id": "26338651",
          "iban": "IR550150000000712300672907",
          "number": "712300672907",
          "bank": {
            "id": "1",
            "title": "بانک سپه"
          }
        },
        "track_id": "12345678900",
        "amount": "7500",
        "date": "1546398000"
      }
    }
  ]
}
```

### Response Example (406)
```json
{
  "error_code": 41,
  "error_message": "فیلتر وضعیت تراکنش ها می بایست آرایه ای (لیستی) از وضعیت های مجاز در مستندات باشد."
}
```
```

--------------------------------

### Successful Transaction Verification Response

Source: https://idpay.ir/web-service/v1.1/index.html

This is an example of a successful JSON response after verifying a transaction. It includes transaction details, payment information, and verification timestamps.

```json
{
  "status": "100",
  "track_id": "10012",
  "id": "d2e353189823079e1e4181772cff5292",
  "order_id": "101",
  "amount": "10000",
  "date": "1546288200",
  "payment": {
    "track_id": "888001",
    "amount": "10000",
    "card_no": "123456******1234",
    "hashed_card_no": "E59FA6241C94B8836E3D03120DF33E80FD988888BBA0A122240C2E7D23B48295",
    "date": "1546288500"
  },
  "verify": {
    "date": "1546288800"
  }
}
```

--------------------------------

### Transaction Inquiry

Source: https://idpay.ir/web-service/v1.1/index.html

Use this endpoint to get the current status of a transaction by providing its unique ID and the order ID.

```APIDOC
## POST /v1.1/payment/inquiry

### Description
Retrieves the latest status of a transaction.

### Method
POST

### Endpoint
https://api.idpay.ir/v1.1/payment/inquiry

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **id** (string) - Required - The unique transaction ID obtained during transaction creation.
- **order_id** (string) - Required - The merchant's order ID sent during transaction creation.

### Request Example
```json
{
  "id": "d2e353189823079e1e4181772cff5292",
  "order_id": "101"
}
```

### Response
#### Success Response (200)
- **status** (number) - Transaction status.
- **track_id** (number) - IDPay tracking code.
- **id** (string) - The unique transaction ID.
- **order_id** (string) - The merchant's order ID.
- **amount** (number) - The amount recorded during transaction creation.
- **wage** (object) - Transaction commission information.
  - **by** (string) - Commission recipient (payee or payer).
  - **type** (string) - Type of transaction commission (amount, percent, stair).
  - **amount** (number) - The commission amount.
- **date** (timestamp) - Transaction creation time.
- **payer** (object) - Transaction payer information.
  - **name** (string) - Payer's name.
  - **phone** (string) - Payer's mobile number.
  - **mail** (string) - Payer's email.
  - **desc** (string) - Payer's description.
- **payment** (object) - Transaction payment information.
  - **track_id** (string) - Payment tracking code.
  - **amount** (number) - Payable amount.
  - **card_no** (string) - Payer's card number (e.g., `123456******1234`).
  - **hashed_card_no** (string) - Hashed payer's card number (SHA256).
  - **date** (timestamp) - Transaction payment time.
- **verify** (object) - Transaction verification information.
  - **date** (timestamp) - Transaction verification time.
- **settlement** (object) - Transaction settlement information.
  - **track_id** (number) - Settlement tracking code.
  - **amount** (number) - Settled amount.
  - **date** (timestamp) - Time of settlement to the merchant's bank account.

#### Response Example (Success)
```json
{
  "status": "100",
  "track_id": "10012",
  "id": "d2e353189823079e1e4181772cff5292",
  "order_id": "101",
  "amount": "10000",
  "wage": {
    "by": "payee",
    "type": "percent",
    "amount": "2500"
  },
  "date": "1546288200",
  "payer": {
    "name": "قاسم رادمان",
    "phone": "09382198592",
    "mail": "my@site.com",
    "desc": "توضیحات پرداخت کننده"
  },
  "payment": {
    "track_id": "888001",
    "amount": "10000",
    "card_no": "123456******1234",
    "hashed_card_no": "E59FA6241C94B8836E3D03120DF33E80FD988888BBA0A122240C2E7D23B48295",
    "date": "1546288500"
  },
  "verify": {
    "date": "1546288800"
  },
  "settlement": {
    "track_id": "12345678900",
    "amount": "7500",
    "date": "1546398000"
  }
}
```

#### Error Response (406)
- **error_code** (number) - Error code.
- **error_message** (string) - Error message.

#### Response Example (Error)
```json
{
  "error_code": 32,
  "error_message": "شماره سفارش `order_id` نباید خالی باشد."
}
```
```

--------------------------------

### Verify Transaction with Go

Source: https://idpay.ir/web-service/v1.1/index.html

This Go program demonstrates how to perform a transaction verification. It constructs the request payload, sets headers, and sends the POST request using the default HTTP client.

```go
url := "https://api.idpay.ir/v1.1/payment/verify"

data := map[string]string{
  "id":       "d2e353189823079e1e4181772cff5292",
  "order_id": "101",
}

payload, _ := json.Marshal(data)

req, _ := http.NewRequest("POST", url, bytes.NewBuffer(payload))

req.Header.Set("Content-Type", "application/json")
req.Header.Set("X-API-KEY", "6a7f99eb-7c20-4412-a972-6dfb7cd253a4")
req.Header.Set("X-SANDBOX", 1)

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)

fmt.Println(string(body))
```

--------------------------------

### List Transactions with Go

Source: https://idpay.ir/web-service/v1.1/index.html

This Go program shows how to make an HTTP POST request to retrieve transaction data. It marshals the data to JSON and sets the necessary request headers.

```go
url := "https://api.idpay.ir/v1.1/payment/transactions?page=0&page_size=5"

data := map[string]interface{}{
  "id": "e22952579725883bbad9f8fa429134bf",
  "order_id": 101,
  "amount": 10000,
  "status": []string{"100"},
  "track_id": "27384837",
  "payment_card_no": "636214******5409",
  "payment_hashed_card_no": "B913D97F01CE42601181135DF3D0F81DA9E98E61BE3E3AB4436E6345D6AB0AEA",
  "payment_date": map[string]int{"min": 1600005000, "max": 1600006000},
  "settlement_date": map[string]int{"min": 1600005746, "max": 1600006000}
}

payload, _ := json.Marshal(data)

req, _ := http.NewRequest("POST", url, bytes.NewBuffer(payload))

req.Header.Set("Content-Type", "application/json")
req.Header.Set("X-API-KEY", "6a7f99eb-7c20-4412-a972-6dfb7cd253a4")
req.Header.Set("X-SANDBOX", "0")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)

fmt.Println(string(body))
```

--------------------------------

### Get Transaction List

Source: https://idpay.ir/web-service/v1.1/index.html

This endpoint retrieves a list of transactions. You can filter the results by providing various parameters in the request body and query parameters for pagination.

```APIDOC
## POST /v1.1/payment/transactions

### Description
Retrieves a list of transactions with filtering capabilities.

### Method
POST

### Endpoint
https://api.idpay.ir/v1.1/payment/transactions

### Query Parameters
- **page** (integer) - Optional - The page number for pagination.
- **page_size** (integer) - Optional - The number of items per page.

### Parameters
#### Request Body
- **id** (string) - Optional - Transaction ID.
- **order_id** (integer) - Optional - Order ID.
- **amount** (integer) - Optional - Transaction amount.
- **status** (array of strings) - Optional - Transaction status. Possible values include '100'.
- **track_id** (string) - Optional - Tracking ID.
- **payment_card_no** (string) - Optional - Masked payment card number.
- **payment_hashed_card_no** (string) - Optional - Hashed payment card number.
- **payment_date** (object) - Optional - Payment date range. Should contain 'min' and 'max' Unix timestamps.
  - **min** (integer) - Minimum payment timestamp.
  - **max** (integer) - Maximum payment timestamp.
- **settlement_date** (object) - Optional - Settlement date range. Should contain 'min' and 'max' Unix timestamps.
  - **min** (integer) - Minimum settlement timestamp.
  - **max** (integer) - Maximum settlement timestamp.

### Request Example
```json
{
  "id": "e22952579725883bbad9f8fa429134bf",
  "order_id": 101,
  "amount": 10000,
  "status": ["100"],
  "track_id": "27384837",
  "payment_card_no": "636214******5409",
  "payment_hashed_card_no": "B913D97F01CE42601181135DF3D0F81DA9E98E61BE3E3AB4436E6345D6AB0AEA",
  "payment_date": {"min": 1600005000, "max": 1600006000},
  "settlement_date": {"min": 1600005746, "max": 1600006000}
}
```

### Headers
- **Content-Type**: application/json
- **X-API-KEY**: [Your API Key]
- **X-SANDBOX**: 0 (for production, 1 for sandbox)

### Response
#### Success Response (200)
- **data** (array) - List of transaction objects.
- **total** (integer) - Total number of transactions.
- **currentPage** (integer) - Current page number.
- **pageSize** (integer) - Items per page.

#### Response Example
```json
{
  "data": [
    {
      "id": "transaction_id_1",
      "order_id": 101,
      "amount": 10000,
      "status": "100",
      "track_id": "27384837",
      "payment_date": "2020-09-14T10:30:00.000Z",
      "created_at": "2020-09-14T10:30:00.000Z"
    }
  ],
  "total": 1,
  "currentPage": 0,
  "pageSize": 25
}
```
```

--------------------------------

### Sandbox Mode Header

Source: https://idpay.ir/web-service/v1.1/index.html

Enable sandbox mode for testing by sending 'X-SANDBOX' with a value of '1' or 'true' in the header. This simulates transactions without actual charges and bypasses website/IP restrictions.

```http
X-SANDBOX: 1
```

--------------------------------

### Create Payment Request

Source: https://idpay.ir/web-service/v1.1/idpay-v1.1.postman_collection.json

Initiates a payment transaction. Ensure the `X-API-KEY` and `X-SANDBOX` headers are correctly set. The `callback` URL must be registered with IDPay.

```json
{
	"order_id": 101,
	"amount": 10000,
	"name": "قاسم رادمان",
	"phone": "09382198592",
	"mail": "my@site.com",
	"desc": "توضیحات پرداخت کننده",
	"callback": "https://example.com/callback"
}
```

--------------------------------

### List Transactions with PHP

Source: https://idpay.ir/web-service/v1.1/index.html

This PHP script demonstrates how to fetch transaction data using cURL. It sets up the request parameters, headers, and executes the POST request.

```php
<?php
$params = array(
  "id" => "e22952579725883bbad9f8fa429134bf",
  "order_id" => 101,
  "amount" => 10000,
  "status" => ["100"],
  "track_id" => "27384837",
  "payment_card_no" => "636214******5409",
  "payment_hashed_card_no" => "B913D97F01CE42601181135DF3D0F81DA9E98E61BE3E3AB4436E6345D6AB0AEA",
  "payment_date" => ["min" => 1600005000, "max" => 1600006000],
  "settlement_date" => ["min" => 1600005746, "max" => 1600006000]
);

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.idpay.ir/v1.1/payment/transactions?page=0&page_size=5');
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($params));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
  'Content-Type: application/json',
  'X-API-KEY: 6a7f99eb-7c20-4412-a972-6dfb7cd253a4',
  'X-SANDBOX: 0'
));

$result = curl_exec($ch);
curl_close($ch);

var_dump($result);


```

--------------------------------

### Sandbox Mode

Source: https://idpay.ir/web-service/v1.1/index.html

For testing API functionality, you can enable sandbox mode by sending the 'X-SANDBOX' key in the request header. This simulates all subsequent processes without actual transactions.

```APIDOC
## Sandbox Mode

### Description
For testing API functionality, you can enable sandbox mode by sending the 'X-SANDBOX' key in the request header. This simulates all subsequent processes without actual transactions. In sandbox mode, website and IP address restrictions are not applied, allowing requests from any callback URL or IP.

### Method
Optional for all requests.

### Headers
- **X-SANDBOX** (boolean) - Optional - Set to `true` or `1` to enable sandbox mode. Defaults to `false` or `0`.

### Example
`X-SANDBOX: 1`
```

--------------------------------

### Error Response for Invalid Status Filter

Source: https://idpay.ir/web-service/v1.1/index.html

An error response (e.g., status code 406) is returned if the provided filters are invalid. This example shows an error message for an incorrectly formatted status filter.

```json
{
  "error_code": 41,
  "error_message": "فیلتر وضعیت تراکنش ها می بایست آرایه ای (لیستی) از وضعیت های مجاز در مستندات باشد."
}
```

--------------------------------

### Verify Transaction with PHP

Source: https://idpay.ir/web-service/v1.1/index.html

This PHP script demonstrates how to verify a transaction using cURL. It sets up the request parameters, headers, and executes the request, then outputs the result.

```php
<?php
$params = array(
  'id' => 'd2e353189823079e1e4181772cff5292',
  'order_id' => '101',
);

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.idpay.ir/v1.1/payment/verify');
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($params));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
  'Content-Type: application/json',
  'X-API-KEY: 6a7f99eb-7c20-4412-a972-6dfb7cd253a4',
  'X-SANDBOX: 1',
));

$result = curl_exec($ch);
curl_close($ch);

var_dump($result);

?>
```

--------------------------------

### ایجاد تراکنش با cURL

Source: https://idpay.ir/web-service/v1.1/index.html

برای ایجاد یک تراکنش جدید، از این دستور cURL استفاده کنید. پارامترهای ضروری شامل order_id، amount و callback هستند. کلیدهای X-API-KEY و X-SANDBOX نیز باید در هدر درخواست گنجانده شوند.

```bash
curl -X POST https://api.idpay.ir/v1.1/payment \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: 6a7f99eb-7c20-4412-a972-6dfb7cd253a4' \
  -H 'X-SANDBOX: 1' \
  -d '{
  "order_id": 101,
  "amount": 10000,
  "name": "قاسم رادمان",
  "phone": "09382198592",
  "mail": "my@site.com",
  "desc": "توضیحات پرداخت کننده",
  "callback": "https://example.com/callback"
}'
```

--------------------------------

### ایجاد تراکنش با Node.js

Source: https://idpay.ir/web-service/v1.1/index.html

این نمونه کد Node.js با استفاده از کتابخانه 'request' یک درخواست POST به API آیدی‌پی برای ایجاد تراکنش ارسال می‌کند. پارامترهای تراکنش در بدنه درخواست JSON قرار می‌گیرند و کلیدهای API و Sandbox در هدر مشخص می‌شوند.

```javascript
var request = require('request');

var options = {
  method: 'POST',
  url: 'https://api.idpay.ir/v1.1/payment',
  headers: {
    'Content-Type': 'application/json',
    'X-API-KEY': '6a7f99eb-7c20-4412-a972-6dfb7cd253a4',
    'X-SANDBOX': 1,
  },
  body: {
    'order_id': '101',
    'amount': 10000,
    'name': 'قاسم رادمان',
    'phone': '09382198592',
    'mail': 'my@site.com',
    'desc': 'توضیحات پرداخت کننده',
    'callback': 'https://example.com/callback',
  },
  json: true,
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
```

--------------------------------

### ایجاد تراکنش با Go

Source: https://idpay.ir/web-service/v1.1/index.html

این کد Go نحوه ایجاد یک تراکنش با استفاده از API آیدی‌پی را نشان می‌دهد. درخواست POST با پارامترهای تراکنش در بدنه JSON و کلیدهای API و Sandbox در هدر ارسال می‌شود. پاسخ API در خروجی چاپ می‌شود.

```go
url := "https://api.idpay.ir/v1.1/payment"

data := map[string]string{
  "order_id": "101",
  "amount":   "10000",
  "name":     "قاسم رادمان",
  "phone":    "09382198592",
  "mail":     "my@site.com",
  "desc":     "توضیحات پرداخت کننده",
  "callback": "https://example.com/callback",
}

payload, _ := json.Marshal(data)

req, _ := http.NewRequest("POST", url, bytes.NewBuffer(payload))

req.Header.Set("Content-Type", "application/json")
req.Header.Set("X-API-KEY", "6a7f99eb-7c20-4412-a972-6dfb7cd253a4")
req.Header.Set("X-SANDBOX", 1)

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)

fmt.Println(string(body))
```

--------------------------------

### استعلام وضعیت تراکنش با Node.js

Source: https://idpay.ir/web-service/v1.1/index.html

این نمونه کد Node.js با استفاده از کتابخانه 'request' وضعیت تراکنش را استعلام می‌کند. اطمینان حاصل کنید که تمام هدرها و بدنه درخواست به درستی پیکربندی شده‌اند.

```javascript
var request = require('request');

var options = {
  method: 'POST',
  url: 'https://api.idpay.ir/v1.1/payment/inquiry',
  headers: {
    'Content-Type': 'application/json',
    'X-API-KEY': '6a7f99eb-7c20-4412-a972-6dfb7cd253a4',
    'X-SANDBOX': 1,
  },
  body: {
    'id': 'd2e353189823079e1e4181772cff5292',
    'order_id': '101',
  },
  json: true,
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

```

--------------------------------

### List Transactions with cURL

Source: https://idpay.ir/web-service/v1.1/index.html

Use this cURL command to make a POST request to retrieve transaction data. Ensure you include your API key and set the appropriate headers.

```bash
curl -X POST https://api.idpay.ir/v1.1/payment/transactions?page=0&page_size=25 \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: 6a7f99eb-7c20-4412-a972-6dfb7cd253a4' \
  -H 'X-SANDBOX: 0' \
  -d '{
  "id": "e22952579725883bbad9f8fa429134bf",
  "order_id": 101,
  "amount": 10000,
  "status": ["100"],
  "track_id": "27384837",
  "payment_card_no": "636214******5409",
  "payment_hashed_card_no": "B913D97F01CE42601181135DF3D0F81DA9E98E61BE3E3AB4436E6345D6AB0AEA",
  "payment_date": {"min": 1600005000, "max": 1600006000},
  "settlement_date": {"min": 1600005746, "max": 1600006000}
}'
```

--------------------------------

### Create Payment

Source: https://idpay.ir/web-service/v1.1/idpay-v1.1.postman_collection.json

Initiates a new payment request. This endpoint generates a payment link that the user will be redirected to for completing the transaction.

```APIDOC
## POST /v1.1/payment

### Description
Initiates a new payment request. This endpoint generates a payment link that the user will be redirected to for completing the transaction.

### Method
POST

### Endpoint
https://api.idpay.ir/v1.1/payment

### Headers
- **Content-Type**: application/json
- **X-API-KEY**: Your unique API key
- **X-SANDBOX**: Set to "1" for sandbox mode, "0" for production (default is "0")

### Request Body
- **order_id** (integer) - Required - Unique identifier for the order.
- **amount** (integer) - Required - The payment amount in Rials.
- **name** (string) - Optional - The name of the payer.
- **phone** (string) - Optional - The phone number of the payer.
- **mail** (string) - Optional - The email address of the payer.
- **desc** (string) - Optional - A description for the payment.
- **callback** (string) - Required - The URL to redirect the user to after payment completion.

### Request Example
```json
{
  "order_id": 101,
  "amount": 10000,
  "name": "قاسم رادمان",
  "phone": "09382198592",
  "mail": "my@site.com",
  "desc": "توضیحات پرداخت کننده",
  "callback": "https://example.com/callback"
}
```

### Response
#### Success Response (201 Created)
- **id** (string) - The unique ID generated for the payment.
- **link** (string) - The URL for the payment gateway.

#### Response Example
```json
{
    "id": "e22952579725883bbad9f8fa429134bf",
    "link": "http://idpay.local/p/ws/e22952579725883bbad9f8fa429134bf"
}
```

#### Error Response (406 Not Acceptable)
- **error_code** (integer) - The error code.
- **error_message** (string) - A description of the error.

#### Error Response Example (Error Code 38)
```json
{
    "error_code": 38,
    "error_message": "درخواست شما از آدرس https://new-domain.com ارسال شده است. دامنه آدرس بازگشت `callback` با آدرس ثبت شده در وب سرویس همخوانی ندارد."
}
```
```

--------------------------------

### استعلام وضعیت تراکنش با Go

Source: https://idpay.ir/web-service/v1.1/index.html

این کد Go نحوه ارسال درخواست POST برای استعلام وضعیت تراکنش را نشان می‌دهد. پارامترهای JSON و هدرهای لازم باید به درستی تنظیم شوند.

```go
url := "https://api.idpay.ir/v1.1/payment/inquiry"

data := map[string]string{
  "id":       "d2e353189823079e1e4181772cff5292",
  "order_id": "101",
}

payload, _ := json.Marshal(data)

req, _ := http.NewRequest("POST", url, bytes.NewBuffer(payload))

req.Header.Set("Content-Type", "application/json")
req.Header.Set("X-API-KEY", "6a7f99eb-7c20-4412-a972-6dfb7cd253a4")
req.Header.Set("X-SANDBOX", "1")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)

fmt.Println(string(body))

```

--------------------------------

### Payment Creation Error Response (Error Code 38)

Source: https://idpay.ir/web-service/v1.1/idpay-v1.1.postman_collection.json

An error response indicating that the `callback` domain does not match the registered domain. Ensure the `callback` URL in the request is correctly configured.

```json
{
    "error_code": 38,
    "error_message": "درخواست شما از آدرس https://new-domain.com ارسال شده است. دامنه آدرس بازگشت `callback` با آدرس ثبت شده در وب سرویس همخوانی ندارد."
}
```

--------------------------------

### Successful Payment Creation Response

Source: https://idpay.ir/web-service/v1.1/idpay-v1.1.postman_collection.json

A successful response to the payment creation request includes a unique payment `id` and a `link` to redirect the user for payment.

```json
{
    "id": "e22952579725883bbad9f8fa429134bf",
    "link": "http://idpay.local/p/ws/e22952579725883bbad9f8fa429134bf"
}
```

--------------------------------

### ایجاد تراکنش با PHP

Source: https://idpay.ir/web-service/v1.1/index.html

این کد PHP نحوه ارسال درخواست POST به API آیدی‌پی برای ایجاد تراکنش را نشان می‌دهد. پارامترهای تراکنش در یک آرایه تعریف شده و با استفاده از cURL ارسال می‌شوند. کلیدهای API و Sandbox در هدر درخواست قرار می‌گیرند.

```php
<?php
$params = array(
  'order_id' => '101',
  'amount' => 10000,
  'name' => 'قاسم رادمان',
  'phone' => '09382198592',
  'mail' => 'my@site.com',
  'desc' => 'توضیحات پرداخت کننده',
  'callback' => 'https://example.com/callback',
);

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.idpay.ir/v1.1/payment');
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($params));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
  'Content-Type: application/json',
  'X-API-KEY: 6a7f99eb-7c20-4412-a972-6dfb7cd253a4',
  'X-SANDBOX: 1'
));

$result = curl_exec($ch);
curl_close($ch);

var_dump($result);

?>
```

--------------------------------

### استعلام وضعیت تراکنش با Curl

Source: https://idpay.ir/web-service/v1.1/index.html

برای دریافت آخرین وضعیت یک تراکنش، از این دستور curl استفاده کنید. اطمینان حاصل کنید که هدرهای لازم شامل کلید API و اطلاعات تراکنش را به درستی تنظیم کرده‌اید.

```bash
curl -X POST https://api.idpay.ir/v1.1/payment/inquiry \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: 6a7f99eb-7c20-4412-a972-6dfb7cd253a4' \
  -H 'X-SANDBOX: 1' \
  -d '{
  "id": "d2e353189823079e1e4181772cff5292",
  "order_id": "101"
}'
```

--------------------------------

### Authentication

Source: https://idpay.ir/web-service/v1.1/index.html

To use IdPay APIs, an API Key is required. Obtain your API Key from your IdPay dashboard under 'My Web Services'. This key must be sent in the header of all requests.

```APIDOC
## Authentication

### Description
To use IdPay APIs, an API Key is required. Obtain your API Key from your IdPay dashboard under 'My Web Services'. This key must be sent in the header of all requests.

### Method
All requests require authentication.

### Headers
- **X-API-KEY** (string) - Required - Your unique API key for authentication. It should be 36 characters long.

### Example
`X-API-KEY: 6a7f99eb-7c20-4412-a972-6dfb7cd253a4`
```

--------------------------------

### ایجاد تراکنش

Source: https://idpay.ir/web-service/v1.1/index.html

این عملیات به شما امکان می‌دهد تا یک تراکنش جدید را با ارائه جزئیات سفارش، مبلغ، اطلاعات پرداخت‌کننده و آدرس بازگشت، ایجاد کنید.

```APIDOC
## POST /v1.1/payment

### Description
ایجاد یک تراکنش جدید برای پرداخت.

### Method
POST

### Endpoint
https://api.idpay.ir/v1.1/payment

### Parameters
#### Header Parameters
- **X-API-KEY** (string) - Required - کلید API شما برای احراز هویت.
- **X-SANDBOX** (string) - Optional - برای فعال کردن حالت آزمایشی، مقدار آن را '1' قرار دهید.

#### Request Body
- **order_id** (string) - Required - شماره سفارش منحصر به فرد پذیرنده. حداکثر طول: 50 کاراکتر.
- **amount** (number) - Required - مبلغ تراکنش به ریال. باید بین 1,000 تا 500,000,000 ریال باشد.
- **name** (string) - Optional - نام پرداخت کننده. حداکثر طول: 255 کاراکتر.
- **phone** (string) - Optional - شماره تلفن همراه پرداخت کننده. طول: 11 کاراکتر. مثال: '09382198592'.
- **mail** (string) - Optional - آدرس ایمیل پرداخت کننده. حداکثر طول: 255 کاراکتر.
- **desc** (string) - Optional - توضیحات تراکنش. حداکثر طول: 255 کاراکتر.
- **callback** (string) - Required - آدرس URL که پس از تکمیل پرداخت، کاربر به آن هدایت می‌شود. حداکثر طول: 2048 کاراکتر.

### Request Example
```json
{
  "order_id": "101",
  "amount": 10000,
  "name": "قاسم رادمان",
  "phone": "09382198592",
  "mail": "my@site.com",
  "desc": "توضیحات پرداخت کننده",
  "callback": "https://example.com/callback"
}
```

### Response
#### Success Response (201 Created)
- **id** (string) - کلید منحصر به فرد تراکنش.
- **link** (string) - لینک پرداخت برای هدایت کاربر به درگاه پرداخت.

#### Response Example
```json
{
  "id": "d2e353189823079e1e4181772cff5292",
  "link": "https://idpay.ir/p/ws-sandbox/d2e353189823079e1e4181772cff5292"
}
```

#### Error Response (406)
- **error_code** (number) - کد خطا.
- **error_message** (string) - پیام خطا.

#### Error Response Example
```json
{
  "error_code": 32,
  "error_message": "شماره سفارش `order_id` نباید خالی باشد."
}
```
```
Tokens:
Raw