### Update Transaction Status (Success)

Source: https://developer.arifpay.net/images/api.json

This example demonstrates updating a transaction to 'SUCCESS'. It is part of the original request for updating a transaction, typically used in testing or specific scenarios.

```json
{
    "status":"SUCCESS"
}
```

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

### Update Transaction Status (Failed)

Source: https://developer.arifpay.net/images/api.json

Use this endpoint to update the status of a transaction. This example shows updating a transaction to 'FAILED'. Ensure the request body matches the expected JSON structure.

```json
{
     // "paymentType": "CBE", TELEBIRR_USSD
   "paymentType": "TELEBIRR_USSD", 
   "transactionId": "",    
    "status": "FAILED",
    "userName": "Ezra",
    "password": "Pa$$w0rd"

}
```

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

### Create Checkout Session - JSON Request

Source: https://developer.arifpay.net/images/api.json

Use this endpoint to initiate a checkout session. Ensure all required fields like URLs, payment methods, and item details are correctly populated. The `paymentMethods` array can include options like 'ZAMZAM'.

```json
{
  "cancelUrl": "https://example.com",
  "phone": "251983832880",
  "email": "telebinTest@gmail.com",
  "nonce": "AAAa13asajdsdsads",
  "successUrl": "https://example.com/success",
  "errorUrl": "https://example.com/error",
  "notifyUrl": "https://6628969e54afcabd07363a69.mockapi.io/notification/Test",
  "paymentMethods": ["ZAMZAM"],
  "expireDate": "2029-12-31T23:59:59Z",
  "items": [
    {
      "name": "Product 1",
      "quantity": 1,
      "price": 1,
      "description": "Sample product"
    }
  ],
  "beneficiaries": [
    {
      "accountNumber": "1000000000000",
      "bank": "AWINETAA",
      "amount": 1
    }
  ],
  "lang": "EN",
  "currency":"USD"
}
```

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

### Create Checkout Session

Source: https://developer.arifpay.net/images/api.json

Initiates a checkout session with specified items, beneficiary details, and return URLs. This is used to create a payment session for the user.

```APIDOC
## POST /api/checkout/session

### Description
Creates a checkout session for processing payments.

### Method
POST

### Endpoint
/api/checkout/session

### Parameters
#### Request Body
- **cancelUrl** (string) - Required - The URL to redirect to if the user cancels the payment.
- **phone** (string) - Required - The phone number of the customer.
- **email** (string) - Required - The email address of the customer.
- **nonce** (string) - Required - A unique nonce for the transaction.
- **errorUrl** (string) - Required - The URL to redirect to if an error occurs.
- **notifyUrl** (string) - Required - The URL to receive payment notifications.
- **successUrl** (string) - Required - The URL to redirect to upon successful payment.
- **paymentMethods** (array) - Required - An array of payment methods to be used (e.g., ["TELEBIRR_USSD"]).
- **expireDate** (string) - Required - The expiration date and time for the session (ISO 8601 format).
- **items** (array) - Required - A list of items included in the checkout.
  - **name** (string) - Required - The name of the item.
  - **quantity** (integer) - Required - The quantity of the item.
  - **price** (number) - Required - The price of the item.
  - **description** (string) - Optional - A description of the item.
  - **image** (string) - Optional - A URL to an image of the item.
- **beneficiaries** (array) - Required - A list of beneficiaries for the payment.
  - **accountNumber** (string) - Required - The account number of the beneficiary.
  - **bank** (string) - Required - The bank of the beneficiary.
  - **amount** (number) - Required - The amount to be paid to the beneficiary.
- **lang** (string) - Required - The language for the checkout session (e.g., "EN").

### Request Example
```json
{
    "cancelUrl": "https://example.com",
    "phone":"251952926213",
    "email":"natnael@arifpay.net",
    "nonce": "6a3a7ho-assa9",
    "errorUrl": "http://error.com",
    "notifyUrl": "BASE_URL/test/callback",
    "successUrl": "http://example.com",
    "paymentMethods": [
        "TELEBIRR_USSD"
    ],
    "expireDate": "2025-02-01T03:45:27",
    "items": [
        {
            "name": "ሙዝ",
            "quantity": 1,
            "price": 0.01,
            "description": "Fresh Corner preimuim Banana.",
            "image": "https://4.imimg.com/data4/KK/KK/GLADMIN-/product-8789_bananas_golden-500x500.jpg"
        }
    ],
    "beneficiaries": [
        {
            "accountNumber": "01320811436100",
            "bank": "AWINETAA",
            "amount": 0.01
        }
    ],
    "lang": "EN"
}
```
```

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

### Create Checkout Session

Source: https://developer.arifpay.net/images/api.json

Initiates a checkout session with specified items, payment methods, and URLs for success, cancellation, and error handling.

```APIDOC
## POST /api/checkout/session

### Description
Creates a new checkout session for processing payments.

### Method
POST

### Endpoint
https://gateway.arifpay.org/api/checkout/session

### Headers
- **x-arifpay-key** (text) - Required - Your ArifPay API Key

### Request Body
- **cancelUrl** (string) - Required - URL to redirect to if the session is cancelled.
- **phone** (string) - Required - Customer's phone number.
- **email** (string) - Required - Customer's email address.
- **nonce** (string) - Required - A unique nonce for the transaction.
- **successUrl** (string) - Required - URL to redirect to upon successful payment.
- **errorUrl** (string) - Required - URL to redirect to if an error occurs.
- **notifyUrl** (string) - Required - URL to receive payment notifications.
- **paymentMethods** (array) - Required - List of payment methods to enable (e.g., ["ZAMZAM"]).
- **expireDate** (string) - Required - ISO 8601 format date and time for session expiration.
- **items** (array) - Required - List of items in the checkout session.
  - **name** (string) - Required - Name of the item.
  - **quantity** (number) - Required - Quantity of the item.
  - **price** (number) - Required - Price per unit of the item.
  - **description** (string) - Optional - Description of the item.
- **beneficiaries** (array) - Required - List of beneficiaries for the payment.
  - **accountNumber** (string) - Required - Beneficiary account number.
  - **bank** (string) - Required - Beneficiary bank name.
  - **amount** (number) - Required - Amount to be paid to the beneficiary.
- **lang** (string) - Required - Language code for the checkout session (e.g., "EN").
- **currency** (string) - Required - Currency code for the transaction (e.g., "USD").

### Request Example
```json
{
 "cancelUrl": "https://example.com",
 "phone": "251983832880",
 "email": "telebinTest@gmail.com",
 "nonce": "AAAa13asajdsdsads",
 "successUrl": "https://example.com/success",
 "errorUrl": "https://example.com/error",
 "notifyUrl": "https://6628969e54afcabd07363a69.mockapi.io/notification/Test",
 "paymentMethods": ["ZAMZAM"],
 "expireDate": "2029-12-31T23:59:59Z",
 "items": [
 {
 "name": "Product 1",
 "quantity": 1,
 "price": 1,
 "description": "Sample product"
 }
 ],
 "beneficiaries": [
 {
 "accountNumber": "1000000000000",
 "bank": "AWINETAA",
 "amount": 1
 }
 ],
 "lang": "EN",
 "currency":"USD"
}
```

### Response
#### Success Response (200)
(Response details not provided in source)

#### Response Example
(Response example not provided in source)
```

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

### Create Checkout Session

Source: https://developer.arifpay.net/images/api.json

Initiates a checkout session with specified items and payment details.

```APIDOC
## POST /api/checkout/session

### Description
Creates a new checkout session for processing payments. This endpoint allows you to define items, payment methods, and redirection URLs.

### Method
POST

### Endpoint
BASE_URL/api/checkout/session

### Parameters
#### Request Body
- **cancelUrl** (string) - Required - The URL to redirect to if the user cancels the payment.
- **phone** (string) - Required - The phone number associated with the transaction.
- **email** (string) - Required - The email address for transaction notifications.
- **nonce** (string) - Required - A unique identifier for the transaction.
- **errorUrl** (string) - Required - The URL to redirect to if an error occurs.
- **notifyUrl** (string) - Required - The URL to receive payment notifications.
- **successUrl** (string) - Required - The URL to redirect to upon successful payment.
- **paymentMethods** (array) - Required - A list of payment methods to be used (e.g., ["AMOLE"]).
- **expireDate** (string) - Required - The expiration date and time for the checkout session (ISO 8601 format).
- **items** (array) - Required - A list of items included in the order.
  - **name** (string) - Required - The name of the item.
  - **quantity** (integer) - Required - The quantity of the item.
  - **price** (number) - Required - The price of the item.
  - **description** (string) - Optional - A description of the item.
  - **image** (string) - Optional - A URL to the item's image.
- **beneficiaries** (array) - Optional - A list of beneficiaries for fund distribution.
  - **accountNumber** (string) - Required - The bank account number.
  - **bank** (string) - Required - The name of the bank.
  - **amount** (number) - Required - The amount to be transferred to the beneficiary.
- **lang** (string) - Optional - The language code for the checkout interface (e.g., "EN").

### Request Example
```json
{
    "cancelUrl": "https://example.com",
    "phone":"251944294981",
    "email":"natnael@arifpay.net",
    "nonce": "6a3a71hoi-9",
    "errorUrl": "http://error.com",
    "notifyUrl": "BASE_URL/test/callback",
    "successUrl": "http://example.com",
    "paymentMethods": [
        "AMOLE"
    ],
    "expireDate": "2025-02-01T03:45:27",
    "items": [
        {
            "name": "ሙዝ",
            "quantity": 5,
            "price": 2,
            "description": "Fresh Corner preimuim Banana.",
            "image": "https://4.imimg.com/data4/KK/KK/GLADMIN-/product-8789_bananas_golden-500x500.jpg"
        },
        {
            "name": "ሙዝ",
            "quantity": 5,
            "price": 2,
            "description": "Fresh Corner preimuim Banana.",
            "image": "https://4.imimg.com/data4/KK/KK/GLADMIN-/product-8789_bananas_golden-500x500.jpg"
        }
    ],
    "beneficiaries": [
        {
            "accountNumber": "01320811436100",
            "bank": "AWINETAA",
            "amount": 20.0
        }
    ],
    "lang": "EN"
}
```

### Response
(Response details not provided in the source)
```

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

### Create Checkout Session

Source: https://developer.arifpay.net/images/api.json

Create a new checkout session with details such as URLs, customer information, and itemized purchases. The `paymentMethods` array specifies the available payment options.

```json
{
  "cancelUrl": "https://cancel.com",
  "lang" : "EN",
  "phone": "251954926213",
  "email": "Bulk@gmail.com",
  "nonce": "Bulk_BaULKTEST2",
  "errorUrl": "http://error.com",
  "notifyUrl": "http://success.com",
  "successUrl": "http://success.com",
  "paymentMethods": [
    "CBE"
  ],
  "expireDate": "2025-01-14T23:18:11.755Z",
  "items": [
    {
      "name": "bulk",
      "quantity": 1,
      "price": 1,
      "description": "bulk",
      "image": "https://img.jpg"
    }
  ],
  "beneficiaries": [
    {
      "accountNumber": "01320811436100",
      "bank": "AWINETAA",
      "amount": 1
    }
  ]
}
```

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

### Create Checkout Session - POST

Source: https://developer.arifpay.net/images/api.json

Use this endpoint to create a new checkout session. Ensure you include your API key in the headers and provide all necessary details in the request body, such as URLs, contact information, items, and beneficiary details.

```json
{
    "name": "Create Checkout Session",
    "request": {
        "auth": {
            "type": "noauth"
        },
        "method": "POST",
        "header": [
            {
                "key": "x-arifpay-key",
                "value": "Your API KEY",
                "type": "text"
            }
        ],
        "body": {
            "mode": "raw",
            "raw": "{\r\n \"cancelUrl\": \"https://example.com\",\r\n \"phone\": \"251983832880\",\r\n \"email\": \"telebinTest@gmail.com\",\r\n \"nonce\": \"AAAa13asajdsdsads\",\r\n \"successUrl\": \"https://example.com/success\",\r\n \"errorUrl\": \"https://example.com/error\",\r\n \"notifyUrl\": \"https://6628969e54afcabd07363a69.mockapi.io/notification/Test\",\r\n \"paymentMethods\": [\"ZAMZAM\"] ,\r\n \"expireDate\": \"2029-12-31T23:59:59Z\",\r\n \"items\": [\r\n {\r\n \"name\": \"Product 1\",\r\n \"quantity\": 1,\r\n \"price\": 1,\r\n \"description\": \"Sample product\"\r\n }\r\n ],\r\n \"beneficiaries\": [\r\n {\r\n \"accountNumber\": \"1000000000000\",\r\n \"bank\": \"AWINETAA\",\r\n \"amount\": 1\r\n }\r\n ],\r\n \"lang\": \"EN\",\r\n \"currency\":\"USD\"\r\n}",
            "options": {
                "raw": {
                    "language": "json"
                }
            }
        },
        "url": {
            "raw": "BASE_URL/api/checkout/session",
            "protocol": "https",
            "host": [
                "gateway",
                "arifpay",
                "org"
            ],
            "path": [
                "api",
                "checkout",
                "session"
            ]
        }
    },
    "response": []
}
```

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

### Create Session API Request

Source: https://developer.arifpay.net/images/api.json

This is a template for creating a new session. It requires an 'x-arifpay-key' in the header for authentication.

```json
{
    "name": "Create Session",
    "request": {
        "auth": {
            "type": "noauth"
        },
        "method": "POST",
        "header": [
            {
                "key": "x-arifpay-key",
                "value": "Your API KEY",
                "type": "text"
            }
        ],
        "body": {
            "mode": "raw",
            "raw": ""
        }
    }
}
```

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

### Create CBE Checkout Session

Source: https://developer.arifpay.net/images/api.json

This snippet demonstrates how to create a checkout session with CBE. It includes details such as callback URLs, payment methods, item information, and beneficiary bank details. Requires an API key.

```json
{
    "cancelUrl": "https://example.com",
    "phone":"251952926213",
    "email":"natnael@arifpay.net",
    "nonce": "6a3a7ho-assa9",
    "errorUrl": "http://error.com",
    "notifyUrl": "BASE_URL/test/callback",
    "successUrl": "http://example.com",
    "paymentMethods": [
        "TELEBIRR_USSD"
    ],
    "expireDate": "2025-02-01T03:45:27",
    "items": [
        {
            "name": "ሙዝ",
            "quantity": 1,
            "price": 0.01,
            "description": "Fresh Corner preimuim Banana.",
            "image": "https://4.imimg.com/data4/KK/KK/GLADMIN-/product-8789_bananas_golden-500x500.jpg"
        }
    ],
    "beneficiaries": [
        {
            "accountNumber": "01320811436100",
            "bank": "AWINETAA",
            "amount": 0.01
        }
    ],
    "lang": "EN"
}
```

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

### Create Checkout Session (CBE)

Source: https://developer.arifpay.net/images/api.json

Use this endpoint to create a checkout session for CBE payments. Ensure all required fields like URLs, contact information, and item details are correctly provided.

```json
{
  "cancelUrl": "https://cancel.com",
  "lang" : "EN",
  "phone": "251954926213",
  "email": "Bulk@gmail.com",
  "nonce": "Bulk_BaULKTEST2",
  "errorUrl": "http://error.com",
  "notifyUrl": "http://success.com",
  "successUrl": "http://success.com",
  "paymentMethods": [
    "CBE"
  ],
  "expireDate": "2025-01-14T23:18:11.755Z",
  "items": [
    {
      "name": "bulk",
      "quantity": 1,
      "price": 1,
      "description": "bulk",
      "image": "https://img.jpg"
    }
  ],
  "beneficiaries": [
    {
      "accountNumber": "01320811436100",
      "bank": "AWINETAA",
      "amount": 1,
    //   "lang": "EN"
    }
  ]
}
```

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

### Create Checkout Session

Source: https://developer.arifpay.net/images/api.json

Initiates a checkout session for processing payments.

```APIDOC
## POST /api/checkout/session

### Description
Creates a new checkout session for payment processing.

### Method
POST

### Endpoint
https://gateway.arifpay.net/api/checkout/session

### Request Body
This endpoint does not explicitly define a request body in the provided source.

### Response
#### Success Response (200)
- The response structure for a successful request is not detailed in the source.
```

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

### Create Checkout Session

Source: https://developer.arifpay.net/images/api.json

Initiates a checkout session for processing payments. This endpoint requires an API key for authentication.

```APIDOC
## POST /api/checkout/session

### Description
Creates a new checkout session for processing payments. This endpoint is used to initiate a payment transaction.

### Method
POST

### Endpoint
https://gateway.arifpay.org/api/checkout/session

### Headers
- **x-arifpay-key** (string) - Required - Your unique ArifPay API key.

### Request Body
- **cancelUrl** (string) - Required - The URL to redirect the user to if the payment is cancelled.
- **phone** (string) - Required - The phone number of the customer.
- **email** (string) - Required - The email address of the customer.
- **nonce** (string) - Required - A unique, unpredictable string used for security purposes.
- **successUrl** (string) - Required - The URL to redirect the user to upon successful payment.
- **errorUrl** (string) - Required - The URL to redirect the user to if an error occurs during payment.
- **notifyUrl** (string) - Required - The URL to receive payment notifications.
- **paymentMethods** (array of strings) - Required - A list of payment methods to be available (e.g., ["ZAMZAM"]).
- **expireDate** (string) - Required - The expiration date and time for the checkout session in ISO 8601 format.
- **items** (array of objects) - Required - A list of items included in the transaction.
  - **name** (string) - Required - The name of the item.
  - **quantity** (integer) - Required - The quantity of the item.
  - **price** (number) - Required - The price of the item.
  - **description** (string) - Optional - A description of the item.
- **beneficiaries** (array of objects) - Required - A list of beneficiaries for the transaction.
  - **accountNumber** (string) - Required - The account number of the beneficiary.
  - **bank** (string) - Required - The bank code or name of the beneficiary.
  - **amount** (number) - Required - The amount to be transferred to the beneficiary.
- **lang** (string) - Required - The language code for the checkout interface (e.g., "EN").
- **currency** (string) - Required - The currency code for the transaction (e.g., "USD").

### Request Example
```json
{
  "cancelUrl": "https://example.com",
  "phone": "251983832880",
  "email": "telebinTest@gmail.com",
  "nonce": "AAAa13asajdsdsads",
  "successUrl": "https://example.com/success",
  "errorUrl": "https://example.com/error",
  "notifyUrl": "https://6628969e54afcabd07363a69.mockapi.io/notification/Test",
  "paymentMethods": ["ZAMZAM"],
  "expireDate": "2029-12-31T23:59:59Z",
  "items": [
    {
      "name": "Product 1",
      "quantity": 1,
      "price": 1,
      "description": "Sample product"
    }
  ],
  "beneficiaries": [
    {
      "accountNumber": "1000000000000",
      "bank": "AWINETAA",
      "amount": 1
    }
  ],
  "lang": "EN",
  "currency":"USD"
}
```

### Response
(Response details not provided in the source)
```

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

### Create Checkout Session

Source: https://developer.arifpay.net/images/api.json

Initiates a checkout session with ArifPay, allowing customers to make payments. Requires a valid API key.

```APIDOC
## POST /api/checkout/session

### Description
Creates a new checkout session for processing payments.

### Method
POST

### Endpoint
https://gateway.arifpay.net/api/checkout/session

### Headers
- **x-arifpay-key** (string) - Required - Your unique ArifPay API key.

### Request Body
- **cancelUrl** (string) - Required - URL to redirect to if the payment is cancelled.
- **lang** (string) - Optional - Language code for the checkout page (e.g., "EN").
- **phone** (string) - Required - Customer's phone number.
- **email** (string) - Required - Customer's email address.
- **nonce** (string) - Required - A unique identifier for the transaction.
- **errorUrl** (string) - Required - URL to redirect to if an error occurs during payment.
- **notifyUrl** (string) - Required - URL to notify upon successful payment.
- **successUrl** (string) - Required - URL to redirect to upon successful payment.
- **paymentMethods** (array of strings) - Required - List of accepted payment methods (e.g., ["CBE"]).
- **expireDate** (string) - Required - Expiration date for the checkout session in ISO 8601 format.
- **items** (array of objects) - Required - List of items to be purchased.
  - **name** (string) - Required - Name of the item.
  - **quantity** (integer) - Required - Quantity of the item.
  - **price** (number) - Required - Price of the item.
  - **description** (string) - Optional - Description of the item.
  - **image** (string) - Optional - URL of the item's image.
- **beneficiaries** (array of objects) - Required - List of beneficiaries for the payment.
  - **accountNumber** (string) - Required - Beneficiary's account number.
  - **bank** (string) - Required - Beneficiary's bank name.
  - **amount** (number) - Required - Amount to be paid to the beneficiary.
  - **lang** (string) - Optional - Language code for the beneficiary.

### Request Example
```json
{
  "cancelUrl": "https://cancel.com",
  "lang" : "EN",
  "phone": "251954926213",
  "email": "Bulk@gmail.com",
  "nonce": "Bulk_BaULKTEST2",
  "errorUrl": "http://error.com",
  "notifyUrl": "http://success.com",
  "successUrl": "http://success.com",
  "paymentMethods": [
    "CBE"
  ],
  "expireDate": "2025-01-14T23:18:11.755Z",
  "items": [
    {
      "name": "bulk",
      "quantity": 1,
      "price": 1,
      "description": "bulk",
      "image": "https://img.jpg"
    }
  ],
  "beneficiaries": [
    {
      "accountNumber": "01320811436100",
      "bank": "AWINETAA",
      "amount": 1
    }
  ]
}
```

### Response
#### Success Response (200)
(Response structure not provided in source)
```

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

### Create Checkout Session

Source: https://developer.arifpay.net/images/api.json

Initiates a checkout session with ArifPay, allowing for various payment methods and configurations.

```APIDOC
## POST /api/checkout/session

### Description
Creates a new checkout session for processing payments.

### Method
POST

### Endpoint
https://gateway.arifpay.net/api/checkout/session

### Request Body
- **cancelUrl** (string) - Required - The URL to redirect to if the payment is cancelled.
- **phone** (string) - Required - The phone number of the customer.
- **email** (string) - Required - The email address of the customer.
- **nonce** (string) - Required - A unique nonce for the transaction.
- **errorUrl** (string) - Required - The URL to redirect to in case of an error.
- **notifyUrl** (string) - Required - The URL to send payment notifications to.
- **successUrl** (string) - Required - The URL to redirect to upon successful payment.
- **paymentMethods** (array) - Required - A list of payment methods to enable (e.g., ["TELEBIRR_USSD"]).
- **expireDate** (string) - Required - The expiration date and time for the checkout session (ISO 8601 format).
- **items** (array) - Required - A list of items included in the order.
  - **name** (string) - Required - The name of the item.
  - **quantity** (integer) - Required - The quantity of the item.
  - **price** (number) - Required - The price of the item.
  - **description** (string) - Optional - A description of the item.
- **beneficiaries** (array) - Required - A list of beneficiaries for the payment.
  - **accountNumber** (string) - Required - The account number of the beneficiary.
  - **bank** (string) - Required - The bank name of the beneficiary.
  - **amount** (number) - Required - The amount to be paid to the beneficiary.
- **lang** (string) - Required - The language code for the checkout session (e.g., "EN").

### Request Example
```json
{
    "cancelUrl": "https://example1.com",
    "phone":"251922655097",
    "email":"Ex@gmail.net",
    "nonce": "251asdsaddsasad93554asdasd8208sadas",
    "errorUrl": "http://error.com",
    "notifyUrl": "https://664db983ede9a2b5565497ee.mockapi.io/user",
    "successUrl": "http://example.com",
    "paymentMethods": [
        "TELEBIRR_USSD"
    ],
    "expireDate": "2026-02-10T15:54:55",
    "items": [
        {
            "name": "ሙዝ",
            "quantity": 1,
            "price": 3,
            "description": "test"
        }
    ],
    "beneficiaries": [
        {
            "accountNumber": "01320811436100",
            "bank": "AWINETAA",
            "amount": 3
        }
    ],
    "lang": "EN"
}
```

### Response
(Response details not provided in the source)
```

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

### Create Checkout Session

Source: https://developer.arifpay.net/images/api.json

Initiates a checkout session for processing payments. This endpoint is used to create a payment session with various details including items, beneficiaries, and URLs for redirection.

```APIDOC
## POST /api/checkout/session

### Description
Creates a checkout session for payment processing.

### Method
POST

### Endpoint
https://gateway.arifpay.net/api/checkout/session

### Request Body
- **cancelUrl** (string) - Required - The URL to redirect to if the payment is cancelled.
- **lang** (string) - Required - The language code for the payment interface (e.g., "EN").
- **phone** (string) - Required - The customer's phone number.
- **email** (string) - Required - The customer's email address.
- **nonce** (string) - Required - A unique nonce for transaction security.
- **errorUrl** (string) - Required - The URL to redirect to if an error occurs.
- **notifyUrl** (string) - Required - The URL to notify upon successful payment.
- **successUrl** (string) - Required - The URL to redirect to upon successful payment.
- **paymentMethods** (array) - Required - A list of payment methods to be offered (e.g., ["CBE"]).
- **expireDate** (string) - Required - The expiration date and time for the payment session in ISO 8601 format.
- **items** (array) - Required - A list of items included in the payment.
  - **name** (string) - Required - The name of the item.
  - **quantity** (number) - Required - The quantity of the item.
  - **price** (number) - Required - The price of the item.
  - **description** (string) - Optional - A description of the item.
  - **image** (string) - Optional - A URL to the item's image.
- **beneficiaries** (array) - Required - A list of beneficiaries for the payment.
  - **accountNumber** (string) - Required - The beneficiary's account number.
  - **bank** (string) - Required - The beneficiary's bank name.
  - **amount** (number) - Required - The amount to be paid to the beneficiary.

### Request Example
```json
{
  "cancelUrl": "https://cancel.com",
  "lang" : "EN",
  "phone": "251954926213",
  "email": "Bulk@gmail.com",
  "nonce": "Bulk_BaULKTEST2",
  "errorUrl": "http://error.com",
  "notifyUrl": "http://success.com",
  "successUrl": "http://success.com",
  "paymentMethods": [
    "CBE"
  ],
  "expireDate": "2025-01-14T23:18:11.755Z",
  "items": [
    {
      "name": "bulk",
      "quantity": 1,
      "price": 1,
      "description": "bulk",
      "image": "https://img.jpg"
    }
  ],
  "beneficiaries": [
    {
      "accountNumber": "01320811436100",
      "bank": "AWINETAA",
      "amount": 1
    }
  ]
}
```
```

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

### Binget Initiate Transfer

Source: https://developer.arifpay.net/images/api.json

Initiates a Binget transfer by providing session ID and phone number.

```APIDOC
## POST /api/checkout/binget/initiate

### Description
Initiates a Binget transfer.

### Method
POST

### Endpoint
https://gateway.arifpay.net/api/checkout/binget/direct/transfer

### Parameters
#### Request Body
- **sessionId** (text) - Required - The session ID for the transfer.
- **phoneNumber** (text) - Required - The phone number to initiate the transfer to.
```

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

### Create Checkout Session

Source: https://developer.arifpay.net/images/api.json

Use this endpoint to create a checkout session for processing payments. Ensure all required fields in the request body are correctly populated, including items, beneficiary details, and callback URLs.

```json
{
    "cancelUrl": "https://example.com",
    "phone":"251944294981",
    "email":"natnael@arifpay.net",
    "nonce": "6a3a71hoi-9",
    "errorUrl": "http://error.com",
    "notifyUrl": "BASE_URL/test/callback",
    "successUrl": "http://example.com",
    "paymentMethods": [
        "AMOLE"
    ],
    "expireDate": "2025-02-01T03:45:27",
    "items": [
        {
            "name": "ሙዝ",
            "quantity": 5,
            "price": 2,
            "description": "Fresh Corner preimuim Banana.",
            "image": "https://4.imimg.com/data4/KK/KK/GLADMIN-/product-8789_bananas_golden-500x500.jpg"
        },
        {
            "name": "ሙዝ",
            "quantity": 5,
            "price": 2,
            "description": "Fresh Corner preimuim Banana.",
            "image": "https://4.imimg.com/data4/KK/KK/GLADMIN-/product-8789_bananas_golden-500x500.jpg"
        }
    ],
    "beneficiaries": [
        {
            "accountNumber": "01320811436100",
            "bank": "AWINETAA",
            "amount": 20.0
        }
    ],
    "lang": "EN"
}
```

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

### Create Checkout Session API Request (CBE)

Source: https://developer.arifpay.net/images/api.json

This snippet outlines a POST request for creating a checkout session using the CBE integration. It specifies the API key in the header and the request body format.

```json
{
    "name": "CBE",
    "item": [
        {
            "name": "Create Check out session id Copy 2",
            "request": {
                "method": "POST",
                "header": [
                    {
                        "key": "x-arifpay-key",
                        "value": "Your API KEY",
                        "type": "text"
                    }
                ],
                "body": {
                    "mode": "raw"
                }
            }
        }
    ]
}
```

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

### Create Checkout Session

Source: https://developer.arifpay.net/images/api.json

Creates a new checkout session for processing payments.

```APIDOC
## POST /api/checkout/session

### Description
Initiates a new checkout session, allowing customers to select payment methods and complete transactions.

### Method
POST

### Endpoint
https://gateway.arifpay.net/api/checkout/session

### Parameters
#### Request Body
- **cancelUrl** (string) - Required - The URL to redirect to if the user cancels the payment.
- **lang** (string) - Required - The language code for the checkout interface (e.g., "EN").
- **phone** (string) - Required - The customer's phone number.
- **email** (string) - Required - The customer's email address.
- **nonce** (string) - Required - A unique identifier for the transaction.
- **errorUrl** (string) - Required - The URL to redirect to if an error occurs during payment.
- **notifyUrl** (string) - Required - The URL to receive payment notifications.
- **successUrl** (string) - Required - The URL to redirect to upon successful payment.
- **paymentMethods** (array of strings) - Required - A list of available payment methods (e.g., ["CBE"]).
- **expireDate** (string) - Required - The expiration date and time for the checkout session in ISO 8601 format.
- **items** (array of objects) - Required - A list of items included in the checkout.
  - **name** (string) - Required - The name of the item.
  - **quantity** (number) - Required - The quantity of the item.
  - **price** (number) - Required - The price of the item.
  - **description** (string) - Optional - A description of the item.
  - **image** (string) - Optional - A URL to the item's image.
- **beneficiaries** (array of objects) - Required - A list of beneficiaries for the payment.
  - **accountNumber** (string) - Required - The beneficiary's account number.
  - **bank** (string) - Required - The beneficiary's bank name.
  - **amount** (number) - Required - The amount to be paid to the beneficiary.
  - **lang** (string) - Optional - The language code for the beneficiary details.
```

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

### Account Inquiry API Request

Source: https://developer.arifpay.net/images/api.json

Use this endpoint to query account details. Ensure the 'x-arifpay-key' header is populated with your API key.

```json
{
			"name": "account inqury",
			"request": {
				"method": "POST",
				"header": [
					{
						"key": "x-arifpay-key",
						"value": "",
						"type": "text"
					}
				],
				"url": {
					"raw": "BASE_URL/api/checkout/b2b/acount/query?accountNumber=account here&shortCodes=CBE",
					"protocol": "https",
					"host": [
						"gateway",
						"arifpay",
						"org"
					],
					"path": [
						"api",
						"checkout",
						"b2b",
						"acount",
						"query"
					],
					"query": [
						{
							"key": "accountNumber",
							"value": "account here"
						},
						{
							"key": "shortCodes",
							"value": "CBE"
						}
					]
				}
			},
			"response": []
		}
```

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

### Direct Transfer

Source: https://developer.arifpay.net/images/api.json

Initiates a direct transfer using provided OTP, account number, and session ID.

```APIDOC
## POST /api/checkout/kacha/direct/transfer

### Description
Initiates a direct transfer with the provided OTP, account number, and session ID.

### Method
POST

### Endpoint
https://gateway.arifpay.org/api/checkout/kacha/direct/transfer

### Parameters
#### Request Body
- **otp** (string) - Required - The One-Time Password for verification.
- **accountNumber** (string) - Required - The destination account number.
- **sessionId** (string) - Required - The session identifier.

### Request Example
{
  "otp": "6063",
  "accountNumber": "0026590620101",
  "sessionId": "68CCC232D2A8"
}

### Response
#### Success Response (200)
(Response details not provided in the source)
```

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

### Account Inquiry

Source: https://developer.arifpay.net/images/api.json

This endpoint allows you to query account details.

```APIDOC
## POST /api/checkout/b2b/acount/query

### Description
Queries account information.

### Method
POST

### Endpoint
/api/checkout/b2b/acount/query

### Query Parameters
- **accountNumber** (string) - Required - The account number to query.
- **shortCodes** (string) - Required - Short codes for the query.
```

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

### Awash Direct Transfer API Request

Source: https://developer.arifpay.net/images/api.json

This snippet shows the structure for initiating a direct transfer via the Awash gateway. Ensure your API key is correctly set in the headers.

```json
{
                                            "protocol": "https",
                                            "host": [
                                                "gateway",
                                                "arifpay",
                                                "org"
                                            ],
                                            "path": [
                                                "api",
                                                "checkout",
                                                "awash",
                                                "direct",
                                                "transfer"
                                            ]
                                        }
```

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

### Create Checkout Session - JSON Payload

Source: https://developer.arifpay.net/images/api.json

Use this JSON payload to create a checkout session. Ensure all required fields like URLs, phone, email, and item details are correctly populated.

```json
{
    "cancelUrl": "https://example1.com",
    "phone":"251922655097",
    "email":"Ex@gmail.net",
    "nonce": "251asdsaddsasad93554asdasd8208sadas",
    "errorUrl": "http://error.com",
    "notifyUrl": "https://664db983ede9a2b5565497ee.mockapi.io/user",
    "successUrl": "http://example.com",
    "paymentMethods": [
        "TELEBIRR_USSD"
    ],
    "expireDate": "2026-02-10T15:54:55",
    "items": [
        {
            "name": "ሙዝ",
            "quantity": 1,
            "price": 3,
            "description": "test"
        }
    ],
    "beneficiaries": [
        {
            "accountNumber": "01320811436100",
            "bank": "AWINETAA",
            "amount": 3
        }
    ],
    "lang": "EN"
}
```

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

### Checkout Session API Request

Source: https://developer.arifpay.net/images/api.json

This snippet shows the structure for a POST request to create a checkout session. Ensure you replace 'Your API KEY' with your actual ArifPay API key.

```json
{
    "sessionId": "AC2F8BF0D3F7",
    "phoneNumber": "251954926213"
}

```

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

### Binget OTP Verify

Source: https://developer.arifpay.net/images/api.json

Verifies the OTP sent for a Binget transaction.

```APIDOC
## POST /api/checkout/binget/verify-otp

### Description
Verifies the OTP for a Binget transaction.

### Method
POST

### Endpoint
https://gateway.arifpay.net/api/checkout/hellocash/direct/verify

### Parameters
#### Request Body
- **sessionId** (text) - Required - The session ID of the transaction.
- **otp** (text) - Required - The One-Time Password received.
```

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

### Create Checkout Session Request

Source: https://developer.arifpay.net/images/api.json

Use this JSON payload to create a new checkout session. Ensure all required fields like URLs, contact information, payment methods, and item details are correctly populated. The `expireDate` should be in ISO 8601 format.

```json
{
  "cancelUrl": "https://cancel.com",
  "lang" : "EN",
  "phone": "251954926213",
  "email": "Bulk@gmail.com",
  "nonce": "Bulk_BaULKTEST2",
  "errorUrl": "http://error.com",
  "notifyUrl": "http://success.com",
  "successUrl": "http://success.com",
  "paymentMethods": [
    "CBE"
  ],
  "expireDate": "2025-01-14T23:18:11.755Z",
  "items": [
    {
      "name": "bulk",
      "quantity": 1,
      "price": 1,
      "description": "bulk",
      "image": "https://img.jpg"
    }
  ],
  "beneficiaries": [
    {
      "accountNumber": "01320811436100",
      "bank": "AWINETAA",
      "amount": 1
    }
  ]
}
```

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

### HelloCash OTP Verify

Source: https://developer.arifpay.net/images/api.json

Verifies the OTP for a HelloCash direct payment.

```APIDOC
## POST /api/checkout/hellocash/direct/verifyOTP

### Description
Verifies the One-Time Password (OTP) for a HelloCash direct payment transaction.

### Method
POST

### Endpoint
(Endpoint details not provided in source)

### Headers
- **x-arifpay-key** (text) - Required - Your ArifPay API key

### Request Body
(Request body details not provided in source)

### Request Example
(Request example not provided in source)

### Response
#### Success Response (200)
(Response details not provided in source)

#### Response Example
(Response example not provided in source)
```