MagicPay

https://magicpay.gitbook.io
Admin
MagicPay provides a robust API for seamless card payment processing, secure transactions, and wallet...
Tokens:513,901
Snippets:1,476
Trust Score:10
Update:1 year ago
Show doc for...
Tokens:
Raw
### MagicPay API - Installments

Source: https://magicpay.gitbook.io/magicpay-documentation/payments-and-wallet/make-deposit-3d-init

This section details the API endpoints related to installment plans within MagicPay. It covers querying available credit card bins and checking installment options for purchases.

```APIDOC
APIDOC:
  Query Bins:
    Endpoint: /installments/bins
    Method: GET
    Description: Queries credit card bins for installment information.
    Query Parameters:
      card_number_prefix: string (required)
    Response:
      bins: array of objects

  Installment Query:
    Endpoint: /installments/query
    Method: POST
    Description: Queries available installment plans for a purchase.
    Request Body:
      amount: integer (required)
      card_bin: string (required)
      merchant_id: string (required)
    Response:
      installments: array of objects
```

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

### MagicPay API - Installments

Source: https://magicpay.gitbook.io/magicpay-documentation/payments-and-wallet/create-wallet

This section details the API endpoints related to installment plans within MagicPay. It covers querying available credit card bins and checking installment options for purchases.

```APIDOC
APIDOC:
  Query Bins:
    Endpoint: /installments/bins
    Method: GET
    Description: Queries credit card bins for installment information.
    Query Parameters:
      card_number_prefix: string (required)
    Response:
      bins: array of objects

  Installment Query:
    Endpoint: /installments/query
    Method: POST
    Description: Queries available installment plans for a purchase.
    Request Body:
      amount: integer (required)
      card_bin: string (required)
      merchant_id: string (required)
    Response:
      installments: array of objects
```

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

### MagicPay API - Installments

Source: https://magicpay.gitbook.io/magicpay-documentation/payments-and-wallet/3d-secure-payment-initialization

This section details the API endpoints related to installment plans within MagicPay. It covers querying available credit card bins and checking installment options for purchases.

```APIDOC
APIDOC:
  Query Bins:
    Endpoint: /installments/bins
    Method: GET
    Description: Queries credit card bins for installment information.
    Query Parameters:
      card_number_prefix: string (required)
    Response:
      bins: array of objects

  Installment Query:
    Endpoint: /installments/query
    Method: POST
    Description: Queries available installment plans for a purchase.
    Request Body:
      amount: integer (required)
      card_bin: string (required)
      merchant_id: string (required)
    Response:
      installments: array of objects
```

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

### Installment Query API

Source: https://magicpay.gitbook.io/magicpay-documentation/installments/installment-query

Retrieves installment information based on a BIN number. Supports GET requests and returns detailed installment data upon success or specific error messages for various failure conditions.

```APIDOC
Installment Query API:
  Endpoint: /installment/v1/installments/{bin_number}
  Method: GET
  Description: Return the installments based on the provided BIN number.
  Parameters:
    - bin_number (Required): Bin number to filter the installments.
  Responses:
    - 200 OK:
        Description: Successful retrieval of installment data.
        Content:
          {
            "id": 1,
            "binNumber": "123456",
            "price": 100.0,
            "cardType": "Credit",
            "cardAssociation": "Visa",
            "cardBrand": "Visa Gold",
            "bankName": "Example Bank",
            "bankCode": "123",
            "force3ds": true,
            "cvcRequired": true,
            "commercial": true,
            "merchantId": 1
          }
    - 401 Unauthorized: Authentication failed.
    - 403 Forbidden: Insufficient permissions.
    - 404 Not Found:
        Description: Installment not found for the given BIN number.
        Content:
          {
            "error": "Installment not found"
          }
    - 400 Bad Request: Invalid BIN number format or other request errors.
    - 500 Internal Server Error: Server-side error.
```

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

### MagicPay API - Product Information

Source: https://magicpay.gitbook.io/magicpay-documentation/payments-and-wallet/make-deposit-3d-init

This section provides API endpoints for retrieving product-related information from MagicPay. It includes fetching menus, product lists, campaign details, rules, stories, and categories.

```APIDOC
APIDOC:
  Get Menu:
    Endpoint: /products/menu
    Method: GET
    Description: Retrieves the available menu.
    Response:
      menu: array of objects

  Get Products:
    Endpoint: /products
    Method: GET
    Description: Retrieves a list of available products.
    Query Parameters:
      category_id: string (optional)
    Response:
      products: array of objects

  Get Campaigns:
    Endpoint: /products/campaigns
    Method: GET
    Description: Retrieves active campaigns.
    Response:
      campaigns: array of objects

  Get Rules:
    Endpoint: /products/rules
    Method: GET
    Description: Retrieves product-related rules.
    Response:
      rules: array of objects

  Get Story:
    Endpoint: /products/story
    Method: GET
    Description: Retrieves product stories.
    Response:
      stories: array of objects

  Get Category:
    Endpoint: /products/categories
    Method: GET
    Description: Retrieves product categories.
    Response:
      categories: array of objects
```

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

### Get Menu API Endpoint

Source: https://magicpay.gitbook.io/magicpay-documentation/products/get-menu

Retrieves the menu contents for a specific merchant. It details the GET request method, URL structure, and provides example responses for different HTTP status codes (200, 403, 400, 401, 500). The 200 response includes a structured menu with headers and item details like name, description, and price.

```APIDOC
GET /menu/{merchant_id}

Description:
Returns the contents of the menu for a given merchant.

Parameters:
- merchant_id: The unique identifier for the merchant.

Responses:
- 200 OK:
  {
    "header": "Sıcak İçecekler",
    "data": [
      {
        "name": "Çay",
        "description": "Bir adet kurabiye ile servis edilen Türk çayı",
        "price": "10.0 TL"
      },
      {
        "name": "Kahve",
        "description": "Taze kavrulmuş kahve",
        "price": "20.0 TL"
      },
      {
        "name": "Salep",
        "description": "Geleneksel salep içecek",
        "price": "25.0 TL"
      }
    ]
  },
  {
    "header": "Soğuk İçecekler",
    "data": [
      {
        "name": "Limonata",
        "description": "Taze sıkılmış limon suyu ile yapılan limonata",
        "price": "22.0 TL"
      },
      {
        "name": "Meyve Suyu",
        "description": "Taze meyvelerle sıkılmış meyve suyu",
        "price": "35.0 TL"
      },
      {
        "name": "Su",
        "description": "Soğuk içme suyu",
        "price": "5.0 TL"
      }
    ]
  },
  {
    "header": "Kahvaltı",
    "data": [
      {
        "name": "Simit",
        "description": "Susamlı simit, beyaz peynir ve zeytin ile servis edilir",
        "price": "45.0 TL"
      },
      {
        "name": "Menemen",
        "description": "Yumurta, domates ve yeşil biberle yapılan menemen ",
        "price": "85.0 TL"
      },
      {
        "name": "Kahvaltı Tabağı",
        "description": "Sucuk, pastırma, beyaz peynir ve zeytinle servis edilen kahvaltı tabağı",
        "price": "135.0 TL"
      }
    ]
  }
- 403 Forbidden
- 400 Bad Request
- 401 Unauthorized
- 500 Internal Server Error
```

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

### MagicPay API - Product Information

Source: https://magicpay.gitbook.io/magicpay-documentation/api-key/create-api-key-by-permission

This section provides API endpoints for retrieving product-related information from MagicPay. It includes fetching menus, product lists, campaign details, rules, stories, and categories.

```APIDOC
APIDOC:
  Get Menu:
    Endpoint: /products/menu
    Method: GET
    Description: Retrieves the available menu.
    Response:
      menu: array of objects

  Get Products:
    Endpoint: /products
    Method: GET
    Description: Retrieves a list of available products.
    Query Parameters:
      category_id: string (optional)
    Response:
      products: array of objects

  Get Campaigns:
    Endpoint: /products/campaigns
    Method: GET
    Description: Retrieves active campaigns.
    Response:
      campaigns: array of objects

  Get Rules:
    Endpoint: /products/rules
    Method: GET
    Description: Retrieves product-related rules.
    Response:
      rules: array of objects

  Get Story:
    Endpoint: /products/story
    Method: GET
    Description: Retrieves product stories.
    Response:
      stories: array of objects

  Get Category:
    Endpoint: /products/categories
    Method: GET
    Description: Retrieves product categories.
    Response:
      categories: array of objects
```

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

### Get Commission By Id

Source: https://magicpay.gitbook.io/magicpay-documentation/pos/get-commission-by-id

Retrieves commission details for a specific POS (Point of Sale) by its ID. This endpoint allows fetching commission information, including status, installment details, and various commission rates for different card types and merchant configurations.

```APIDOC
GET /merchant/v1/merchant-poses/{pos_id}/commissions

**Parameters:**
- pos_id (path parameter): The unique identifier of the POS.

**Responses:**
- 200 OK:
  {
    "data": {
      "items": [
        {
          "id": 5423,
          "status": "PASSIVE",
          "installment": 1,
          "blockageDay": 0,
          "cardBrandName": 0,
          "bankOnUsCreditCardCommissionRate": 0,
          "bankNotOnUsCreditCardCommissionRate": 0,
          "bankOnUsDebitCardCommissionRate": 0,
          "bankNotOnUsDebitCardCommissionRate": 0,
          "bankForeignCardCommissionRate": 0,
          "merchantCommissionRate": 0
        }
      ],
      "size": 1
    }
  }
- 403 Forbidden: Indicates insufficient permissions to access the resource.
- 400 Bad Request: The request was malformed or invalid.
- 401 Unauthorized: Authentication failed.
- 500 Internal Server Error: An unexpected error occurred on the server.
```

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

### MagicPay API Documentation

Source: https://magicpay.gitbook.io/magicpay-documentation/products/create-products

This section consolidates various API endpoints for MagicPay, covering core functionalities like payments, wallet management, user operations, member management, installments, and product information.

```APIDOC
Payments and Wallet:
  Create Card Payment: https://magicpay.gitbook.io/magicpay-documentation/payments-and-wallet/create-card-payment
  3D Secure Payment Initialization: https://magicpay.gitbook.io/magicpay-documentation/payments-and-wallet/3d-secure-payment-initialization
  3D Secure Payment Completion: https://magicpay.gitbook.io/magicpay-documentation/payments-and-wallet/3d-secure-payment-completion
  Query Payment: https://magicpay.gitbook.io/magicpay-documentation/payments-and-wallet/query-payment
  Reward Inquiry: https://magicpay.gitbook.io/magicpay-documentation/payments-and-wallet/reward-inquiry
  Create Wallet: https://magicpay.gitbook.io/magicpay-documentation/payments-and-wallet/create-wallet
  Get Member Wallet: https://magicpay.gitbook.io/magicpay-documentation/payments-and-wallet/get-member-wallet
  Make Deposit: https://magicpay.gitbook.io/magicpay-documentation/payments-and-wallet/make-deposit
  Search Wallet Transactions: https://magicpay.gitbook.io/magicpay-documentation/payments-and-wallet/search-wallet-transactions
  Send Remittance: https://magicpay.gitbook.io/magicpay-documentation/payments-and-wallet/send-remittance
  Receive Remittance: https://magicpay.gitbook.io/magicpay-documentation/payments-and-wallet/receive-remittance
  Retrieve Remittance: https://magicpay.gitbook.io/magicpay-documentation/payments-and-wallet/retrieve-remittance
  Get Refundable Amount: https://magicpay.gitbook.io/magicpay-documentation/payments-and-wallet/get-refundable-amount
  Make Deposit (3D Init): https://magicpay.gitbook.io/magicpay-documentation/payments-and-wallet/make-deposit-3d-init
  Make Deposit (3D Complete): https://magicpay.gitbook.io/magicpay-documentation/payments-and-wallet/make-deposit-3d-complete
  Retrieve Merchant Wallet: https://magicpay.gitbook.io/magicpay-documentation/payments-and-wallet/retrieve-merchant-wallet
  Create Refund Transaction: https://magicpay.gitbook.io/magicpay-documentation/payments-and-wallet/create-refund-transaction
  Get Refunds: https://magicpay.gitbook.io/magicpay-documentation/payments-and-wallet/get-refunds
  Reset Merchant Wallet Balance: https://magicpay.gitbook.io/magicpay-documentation/payments-and-wallet/reset-merchant-wallet-balance
  Refund Payment: https://magicpay.gitbook.io/magicpay-documentation/payments-and-wallet/refund-payment
  Get Refund By Id: https://magicpay.gitbook.io/magicpay-documentation/payments-and-wallet/get-refund-by-id
  Get Refund Transaction By Id: https://magicpay.gitbook.io/magicpay-documentation/payments-and-wallet/get-refund-transaction-by-id
  Refund Payment Transaction: https://magicpay.gitbook.io/magicpay-documentation/payments-and-wallet/refund-payment-transaction
```

```APIDOC
Users:
  User Authenticate: https://magicpay.gitbook.io/magicpay-documentation/users/user-authenticate
  Create User: https://magicpay.gitbook.io/magicpay-documentation/users/create-user
  Update User: https://magicpay.gitbook.io/magicpay-documentation/users/update-user
```

```APIDOC
Members:
  Create Member: https://magicpay.gitbook.io/magicpay-documentation/members/create-member
  Update Member: https://magicpay.gitbook.io/magicpay-documentation/members/update-member
  Get Member: https://magicpay.gitbook.io/magicpay-documentation/members/get-member
  Query Member: https://magicpay.gitbook.io/magicpay-documentation/members/query-member
```

```APIDOC
Installments:
  Query Bins: https://magicpay.gitbook.io/magicpay-documentation/installments/query-bins
  Installment Query: https://magicpay.gitbook.io/magicpay-documentation/installments/installment-query
```

```APIDOC
Products:
  Get Menu: https://magicpay.gitbook.io/magicpay-documentation/products/get-menu
  Get Products: https://magicpay.gitbook.io/magicpay-documentation/products/get-products
  Get Campaigns: https://magicpay.gitbook.io/magicpay-documentation/products/get-campaigns
  Get Rules: https://magicpay.gitbook.io/magicpay-documentation/products/get-rules
  Get Story: https://magicpay.gitbook.io/magicpay-documentation/products/get-story
  Get Category: https://magicpay.gitbook.io/magicpay-documentation/products/get-category
```

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

### Get POS Metadata API

Source: https://magicpay.gitbook.io/magicpay-documentation/pos/get-pos-metadata

This API endpoint allows merchants to retrieve metadata associated with different Point of Sale (POS) systems. The metadata includes configuration details such as currency, installment support, hostname, API paths, and security configurations for various banking partners. The response is a JSON object containing a list of POS items, each with specific attributes.

```APIDOC
APIDOC:
  Endpoint: /merchant/v1/pos-metadata/
  Method: GET
  Description: Retrieves a list of POS metadata configurations.
  Parameters:
    None
  Responses:
    200 OK:
      Description: Successfully retrieved POS metadata.
      Content:
        application/json:
          Schema:
            type: object
            properties:
              data:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          description: Unique identifier for the POS configuration.
                        currency:
                          type: string
                          description: The currency supported by the POS (e.g., TRY, USD).
                        installments:
                          type: boolean
                          description: Indicates if installment payments are supported.
                        isItInTheNewPosnetSystem:
                          type: boolean
                          description: Flag indicating if the POS is part of the new Posnet system.
                        orderNo:
                          type: string
                          description: Order number associated with the POS configuration.
                        hostname:
                          type: string
                          description: The hostname or IP address of the POS gateway.
                        apiPath:
                          type: string
                          description: The API path for communication with the POS gateway.
                        threedSecurePath:
                          type: string
                          nullable: true
                          description: The URL for 3D Secure authentication, if applicable.
                        supportedCardAssociations:
                          type: array
                          items:
                            type: string
                          description: List of supported card associations (e.g., Visa, Mastercard).
                        status:
                          type: string
                          description: The current status of the POS configuration (e.g., ACTIVE).
                        acceptForeignCards:
                          type: boolean
                          description: Indicates if foreign cards are accepted.
                        posName:
                          type: string
                          description: The name of the POS provider (e.g., T.C.ZİRAAT BANKASI A.Ş.).
                        payWithoutCvc:
                          type: boolean
                          description: Indicates if payment is allowed without CVV.
                        newThreedsFlow:
                          type: boolean
                          description: Flag for a new 3D Secure flow.
                        mode:
                          type: string
                          description: The operational mode of the POS (e.g., P for Production, PROD).
                        siteUrl:
                          type: string
                          description: The website URL associated with the POS provider.
                        apiPort:
                          type: string
                          description: The port number for API communication.
                        enabledPaymentAuthTypes:
                          type: array
                          items:
                            type: string
                          description: List of enabled payment authentication types.
                  page:
                    type: integer
                    description: Current page number for paginated results.
                  size:
                    type: integer
                    description: Number of items per page.
                  totalSize:
                    type: integer
                    description: Total number of POS configurations available.
    400 Bad Request:
      Description: Invalid request parameters.
    401 Unauthorized:
      Description: Authentication failed.
    403 Forbidden:
      Description: Access denied.
    500 Internal Server Error:
      Description: Server error occurred.
  Example:
    GET /merchant/v1/pos-metadata/
    Response (200 OK):
      {
        "data": {
          "items": [
            {
              "id": 50,
              "currency": "TRY",
              "installments": true,
              "isItInTheNewPosnetSystem": false,
              "orderNo": "5",
              "hostname": "sanalpos2.ziraatbank.com.tr",
              "apiPath": "/fim/api",
              "threedSecurePath": "https://sanalpos2.ziraatbank.com.tr/fim/est3Dgate",
              "supportedCardAssociations": [
                "association1"
              ],
              "status": "ACTIVE",
              "acceptForeignCards": true,
              "posName": "T.C.ZİRAAT BANKASI A.Ş.",
              "payWithoutCvc": true,
              "newThreedsFlow": false,
              "mode": "P",
              "siteUrl": "",
              "apiPort": "443",
              "enabledPaymentAuthTypes": [
                "type1"
              ]
            }
          ],
          "page": 0,
          "size": 29,
          "totalSize": 13
        }
      }
```

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

### MagicPay API Documentation

Source: https://magicpay.gitbook.io/magicpay-documentation/users/create-user

This section consolidates various API endpoints for MagicPay, covering core functionalities like payments, wallet management, user operations, member management, installments, and product information.

```APIDOC
Payments and Wallet:
  Create Card Payment: https://magicpay.gitbook.io/magicpay-documentation/payments-and-wallet/create-card-payment
  3D Secure Payment Initialization: https://magicpay.gitbook.io/magicpay-documentation/payments-and-wallet/3d-secure-payment-initialization
  3D Secure Payment Completion: https://magicpay.gitbook.io/magicpay-documentation/payments-and-wallet/3d-secure-payment-completion
  Query Payment: https://magicpay.gitbook.io/magicpay-documentation/payments-and-wallet/query-payment
  Reward Inquiry: https://magicpay.gitbook.io/magicpay-documentation/payments-and-wallet/reward-inquiry
  Create Wallet: https://magicpay.gitbook.io/magicpay-documentation/payments-and-wallet/create-wallet
  Get Member Wallet: https://magicpay.gitbook.io/magicpay-documentation/payments-and-wallet/get-member-wallet
  Make Deposit: https://magicpay.gitbook.io/magicpay-documentation/payments-and-wallet/make-deposit
  Search Wallet Transactions: https://magicpay.gitbook.io/magicpay-documentation/payments-and-wallet/search-wallet-transactions
  Send Remittance: https://magicpay.gitbook.io/magicpay-documentation/payments-and-wallet/send-remittance
  Receive Remittance: https://magicpay.gitbook.io/magicpay-documentation/payments-and-wallet/receive-remittance
  Retrieve Remittance: https://magicpay.gitbook.io/magicpay-documentation/payments-and-wallet/retrieve-remittance
  Get Refundable Amount: https://magicpay.gitbook.io/magicpay-documentation/payments-and-wallet/get-refundable-amount
  Make Deposit (3D Init): https://magicpay.gitbook.io/magicpay-documentation/payments-and-wallet/make-deposit-3d-init
  Make Deposit (3D Complete): https://magicpay.gitbook.io/magicpay-documentation/payments-and-wallet/make-deposit-3d-complete
  Retrieve Merchant Wallet: https://magicpay.gitbook.io/magicpay-documentation/payments-and-wallet/retrieve-merchant-wallet
  Create Refund Transaction: https://magicpay.gitbook.io/magicpay-documentation/payments-and-wallet/create-refund-transaction
  Get Refunds: https://magicpay.gitbook.io/magicpay-documentation/payments-and-wallet/get-refunds
  Reset Merchant Wallet Balance: https://magicpay.gitbook.io/magicpay-documentation/payments-and-wallet/reset-merchant-wallet-balance
  Refund Payment: https://magicpay.gitbook.io/magicpay-documentation/payments-and-wallet/refund-payment
  Get Refund By Id: https://magicpay.gitbook.io/magicpay-documentation/payments-and-wallet/get-refund-by-id
  Get Refund Transaction By Id: https://magicpay.gitbook.io/magicpay-documentation/payments-and-wallet/get-refund-transaction-by-id
  Refund Payment Transaction: https://magicpay.gitbook.io/magicpay-documentation/payments-and-wallet/refund-payment-transaction
```

```APIDOC
Users:
  User Authenticate: https://magicpay.gitbook.io/magicpay-documentation/users/user-authenticate
  Create User: https://magicpay.gitbook.io/magicpay-documentation/users/create-user
  Update User: https://magicpay.gitbook.io/magicpay-documentation/users/update-user
```

```APIDOC
Members:
  Create Member: https://magicpay.gitbook.io/magicpay-documentation/members/create-member
  Update Member: https://magicpay.gitbook.io/magicpay-documentation/members/update-member
  Get Member: https://magicpay.gitbook.io/magicpay-documentation/members/get-member
  Query Member: https://magicpay.gitbook.io/magicpay-documentation/members/query-member
```

```APIDOC
Installments:
  Query Bins: https://magicpay.gitbook.io/magicpay-documentation/installments/query-bins
  Installment Query: https://magicpay.gitbook.io/magicpay-documentation/installments/installment-query
```

```APIDOC
Products:
  Get Menu: https://magicpay.gitbook.io/magicpay-documentation/products/get-menu
  Get Products: https://magicpay.gitbook.io/magicpay-documentation/products/get-products
  Get Campaigns: https://magicpay.gitbook.io/magicpay-documentation/products/get-campaigns
  Get Rules: https://magicpay.gitbook.io/magicpay-documentation/products/get-rules
  Get Story: https://magicpay.gitbook.io/magicpay-documentation/products/get-story
  Get Category: https://magicpay.gitbook.io/magicpay-documentation/products/get-category
```

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

### MagicPay API - Product Information

Source: https://magicpay.gitbook.io/magicpay-documentation/payments-and-wallet/3d-secure-payment-initialization

This section provides API endpoints for retrieving product-related information from MagicPay. It includes fetching menus, product lists, campaign details, rules, stories, and categories.

```APIDOC
APIDOC:
  Get Menu:
    Endpoint: /products/menu
    Method: GET
    Description: Retrieves the available menu.
    Response:
      menu: array of objects

  Get Products:
    Endpoint: /products
    Method: GET
    Description: Retrieves a list of available products.
    Query Parameters:
      category_id: string (optional)
    Response:
      products: array of objects

  Get Campaigns:
    Endpoint: /products/campaigns
    Method: GET
    Description: Retrieves active campaigns.
    Response:
      campaigns: array of objects

  Get Rules:
    Endpoint: /products/rules
    Method: GET
    Description: Retrieves product-related rules.
    Response:
      rules: array of objects

  Get Story:
    Endpoint: /products/story
    Method: GET
    Description: Retrieves product stories.
    Response:
      stories: array of objects

  Get Category:
    Endpoint: /products/categories
    Method: GET
    Description: Retrieves product categories.
    Response:
      categories: array of objects
```

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

### MagicPay API - Installments

Source: https://magicpay.gitbook.io/magicpay-documentation/submerchants

This section details the API endpoints related to installment plans within MagicPay. It covers querying available credit card bins and checking installment options for purchases.

```APIDOC
APIDOC:
  Query Bins:
    Endpoint: /installments/bins
    Method: GET
    Description: Queries credit card bins for installment information.
    Query Parameters:
      card_number_prefix: string (required)
    Response:
      bins: array of objects

  Installment Query:
    Endpoint: /installments/query
    Method: POST
    Description: Queries available installment plans for a purchase.
    Request Body:
      amount: integer (required)
      card_bin: string (required)
      merchant_id: string (required)
    Response:
      installments: array of objects
```

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

### MagicPay API Documentation

Source: https://magicpay.gitbook.io/magicpay-documentation/testing-environments

This section consolidates various API endpoints for MagicPay, covering core functionalities like payments, wallet management, user operations, member management, installments, and product information.

```APIDOC
Payments and Wallet:
  Create Card Payment: https://magicpay.gitbook.io/magicpay-documentation/payments-and-wallet/create-card-payment
  3D Secure Payment Initialization: https://magicpay.gitbook.io/magicpay-documentation/payments-and-wallet/3d-secure-payment-initialization
  3D Secure Payment Completion: https://magicpay.gitbook.io/magicpay-documentation/payments-and-wallet/3d-secure-payment-completion
  Query Payment: https://magicpay.gitbook.io/magicpay-documentation/payments-and-wallet/query-payment
  Reward Inquiry: https://magicpay.gitbook.io/magicpay-documentation/payments-and-wallet/reward-inquiry
  Create Wallet: https://magicpay.gitbook.io/magicpay-documentation/payments-and-wallet/create-wallet
  Get Member Wallet: https://magicpay.gitbook.io/magicpay-documentation/payments-and-wallet/get-member-wallet
  Make Deposit: https://magicpay.gitbook.io/magicpay-documentation/payments-and-wallet/make-deposit
  Search Wallet Transactions: https://magicpay.gitbook.io/magicpay-documentation/payments-and-wallet/search-wallet-transactions
  Send Remittance: https://magicpay.gitbook.io/magicpay-documentation/payments-and-wallet/send-remittance
  Receive Remittance: https://magicpay.gitbook.io/magicpay-documentation/payments-and-wallet/receive-remittance
  Retrieve Remittance: https://magicpay.gitbook.io/magicpay-documentation/payments-and-wallet/retrieve-remittance
  Get Refundable Amount: https://magicpay.gitbook.io/magicpay-documentation/payments-and-wallet/get-refundable-amount
  Make Deposit (3D Init): https://magicpay.gitbook.io/magicpay-documentation/payments-and-wallet/make-deposit-3d-init
  Make Deposit (3D Complete): https://magicpay.gitbook.io/magicpay-documentation/payments-and-wallet/make-deposit-3d-complete
  Retrieve Merchant Wallet: https://magicpay.gitbook.io/magicpay-documentation/payments-and-wallet/retrieve-merchant-wallet
  Create Refund Transaction: https://magicpay.gitbook.io/magicpay-documentation/payments-and-wallet/create-refund-transaction
  Get Refunds: https://magicpay.gitbook.io/magicpay-documentation/payments-and-wallet/get-refunds
  Reset Merchant Wallet Balance: https://magicpay.gitbook.io/magicpay-documentation/payments-and-wallet/reset-merchant-wallet-balance
  Refund Payment: https://magicpay.gitbook.io/magicpay-documentation/payments-and-wallet/refund-payment
  Get Refund By Id: https://magicpay.gitbook.io/magicpay-documentation/payments-and-wallet/get-refund-by-id
  Get Refund Transaction By Id: https://magicpay.gitbook.io/magicpay-documentation/payments-and-wallet/get-refund-transaction-by-id
  Refund Payment Transaction: https://magicpay.gitbook.io/magicpay-documentation/payments-and-wallet/refund-payment-transaction
```

```APIDOC
Users:
  User Authenticate: https://magicpay.gitbook.io/magicpay-documentation/users/user-authenticate
  Create User: https://magicpay.gitbook.io/magicpay-documentation/users/create-user
  Update User: https://magicpay.gitbook.io/magicpay-documentation/users/update-user
```

```APIDOC
Members:
  Create Member: https://magicpay.gitbook.io/magicpay-documentation/members/create-member
  Update Member: https://magicpay.gitbook.io/magicpay-documentation/members/update-member
  Get Member: https://magicpay.gitbook.io/magicpay-documentation/members/get-member
  Query Member: https://magicpay.gitbook.io/magicpay-documentation/members/query-member
```

```APIDOC
Installments:
  Query Bins: https://magicpay.gitbook.io/magicpay-documentation/installments/query-bins
  Installment Query: https://magicpay.gitbook.io/magicpay-documentation/installments/installment-query
```

```APIDOC
Products:
  Get Menu: https://magicpay.gitbook.io/magicpay-documentation/products/get-menu
  Get Products: https://magicpay.gitbook.io/magicpay-documentation/products/get-products
  Get Campaigns: https://magicpay.gitbook.io/magicpay-documentation/products/get-campaigns
  Get Rules: https://magicpay.gitbook.io/magicpay-documentation/products/get-rules
  Get Story: https://magicpay.gitbook.io/magicpay-documentation/products/get-story
  Get Category: https://magicpay.gitbook.io/magicpay-documentation/products/get-category
```

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

### MagicPay API - Installments

Source: https://magicpay.gitbook.io/magicpay-documentation/submerchants/submerchant-transaction-approve

This section details the API endpoints related to installment plans within MagicPay. It covers querying available credit card bins and checking installment options for purchases.

```APIDOC
APIDOC:
  Query Bins:
    Endpoint: /installments/bins
    Method: GET
    Description: Queries credit card bins for installment information.
    Query Parameters:
      card_number_prefix: string (required)
    Response:
      bins: array of objects

  Installment Query:
    Endpoint: /installments/query
    Method: POST
    Description: Queries available installment plans for a purchase.
    Request Body:
      amount: integer (required)
      card_bin: string (required)
      merchant_id: string (required)
    Response:
      installments: array of objects
```

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

### MagicPay API - Installments

Source: https://magicpay.gitbook.io/magicpay-documentation/pos/update-pos-by-id

This section details the API endpoints related to installment plans within MagicPay. It covers querying available credit card bins and checking installment options for purchases.

```APIDOC
APIDOC:
  Query Bins:
    Endpoint: /installments/bins
    Method: GET
    Description: Queries credit card bins for installment information.
    Query Parameters:
      card_number_prefix: string (required)
    Response:
      bins: array of objects

  Installment Query:
    Endpoint: /installments/query
    Method: POST
    Description: Queries available installment plans for a purchase.
    Request Body:
      amount: integer (required)
      card_bin: string (required)
      merchant_id: string (required)
    Response:
      installments: array of objects
```

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

### MagicPay API Documentation

Source: https://magicpay.gitbook.io/magicpay-documentation/subscription/get-subscription-products

This section consolidates various API endpoints for MagicPay, covering core functionalities like payments, wallet management, user operations, member management, installments, and product information.

```APIDOC
Payments and Wallet:
  Create Card Payment: https://magicpay.gitbook.io/magicpay-documentation/payments-and-wallet/create-card-payment
  3D Secure Payment Initialization: https://magicpay.gitbook.io/magicpay-documentation/payments-and-wallet/3d-secure-payment-initialization
  3D Secure Payment Completion: https://magicpay.gitbook.io/magicpay-documentation/payments-and-wallet/3d-secure-payment-completion
  Query Payment: https://magicpay.gitbook.io/magicpay-documentation/payments-and-wallet/query-payment
  Reward Inquiry: https://magicpay.gitbook.io/magicpay-documentation/payments-and-wallet/reward-inquiry
  Create Wallet: https://magicpay.gitbook.io/magicpay-documentation/payments-and-wallet/create-wallet
  Get Member Wallet: https://magicpay.gitbook.io/magicpay-documentation/payments-and-wallet/get-member-wallet
  Make Deposit: https://magicpay.gitbook.io/magicpay-documentation/payments-and-wallet/make-deposit
  Search Wallet Transactions: https://magicpay.gitbook.io/magicpay-documentation/payments-and-wallet/search-wallet-transactions
  Send Remittance: https://magicpay.gitbook.io/magicpay-documentation/payments-and-wallet/send-remittance
  Receive Remittance: https://magicpay.gitbook.io/magicpay-documentation/payments-and-wallet/receive-remittance
  Retrieve Remittance: https://magicpay.gitbook.io/magicpay-documentation/payments-and-wallet/retrieve-remittance
  Get Refundable Amount: https://magicpay.gitbook.io/magicpay-documentation/payments-and-wallet/get-refundable-amount
  Make Deposit (3D Init): https://magicpay.gitbook.io/magicpay-documentation/payments-and-wallet/make-deposit-3d-init
  Make Deposit (3D Complete): https://magicpay.gitbook.io/magicpay-documentation/payments-and-wallet/make-deposit-3d-complete
  Retrieve Merchant Wallet: https://magicpay.gitbook.io/magicpay-documentation/payments-and-wallet/retrieve-merchant-wallet
  Create Refund Transaction: https://magicpay.gitbook.io/magicpay-documentation/payments-and-wallet/create-refund-transaction
  Get Refunds: https://magicpay.gitbook.io/magicpay-documentation/payments-and-wallet/get-refunds
  Reset Merchant Wallet Balance: https://magicpay.gitbook.io/magicpay-documentation/payments-and-wallet/reset-merchant-wallet-balance
  Refund Payment: https://magicpay.gitbook.io/magicpay-documentation/payments-and-wallet/refund-payment
  Get Refund By Id: https://magicpay.gitbook.io/magicpay-documentation/payments-and-wallet/get-refund-by-id
  Get Refund Transaction By Id: https://magicpay.gitbook.io/magicpay-documentation/payments-and-wallet/get-refund-transaction-by-id
  Refund Payment Transaction: https://magicpay.gitbook.io/magicpay-documentation/payments-and-wallet/refund-payment-transaction
```

```APIDOC
Users:
  User Authenticate: https://magicpay.gitbook.io/magicpay-documentation/users/user-authenticate
  Create User: https://magicpay.gitbook.io/magicpay-documentation/users/create-user
  Update User: https://magicpay.gitbook.io/magicpay-documentation/users/update-user
```

```APIDOC
Members:
  Create Member: https://magicpay.gitbook.io/magicpay-documentation/members/create-member
  Update Member: https://magicpay.gitbook.io/magicpay-documentation/members/update-member
  Get Member: https://magicpay.gitbook.io/magicpay-documentation/members/get-member
  Query Member: https://magicpay.gitbook.io/magicpay-documentation/members/query-member
```

```APIDOC
Installments:
  Query Bins: https://magicpay.gitbook.io/magicpay-documentation/installments/query-bins
  Installment Query: https://magicpay.gitbook.io/magicpay-documentation/installments/installment-query
```

```APIDOC
Products:
  Get Menu: https://magicpay.gitbook.io/magicpay-documentation/products/get-menu
  Get Products: https://magicpay.gitbook.io/magicpay-documentation/products/get-products
  Get Campaigns: https://magicpay.gitbook.io/magicpay-documentation/products/get-campaigns
  Get Rules: https://magicpay.gitbook.io/magicpay-documentation/products/get-rules
  Get Story: https://magicpay.gitbook.io/magicpay-documentation/products/get-story
  Get Category: https://magicpay.gitbook.io/magicpay-documentation/products/get-category
```

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

### Product Management API

Source: https://magicpay.gitbook.io/magicpay-documentation/payments-and-wallet/make-deposit-3d-init

APIs for retrieving, creating, and updating product information. Includes endpoints for categories, rules, campaigns, stories, and products themselves.

```APIDOC
GET /products/category/{id}
  Description: Retrieves a specific category by its ID.

GET /products/rules/{id}
  Description: Retrieves specific rules by their ID.

GET /products/campaigns/{id}
  Description: Retrieves specific campaigns by their ID.

GET /products/stories/{id}
  Description: Retrieves specific stories by their ID.

GET /products/{id}
  Description: Retrieves specific products by their ID.

POST /products/products
  Description: Creates a new product.

POST /products/campaigns
  Description: Creates a new campaign.

POST /products/stories
  Description: Creates a new story.

POST /products/rules
  Description: Creates new rules.

POST /products/category
  Description: Creates a new category.

PUT /products/products
  Description: Updates an existing product.

PUT /products/rules
  Description: Updates existing rules.

PUT /products/stories
  Description: Updates existing stories.

PUT /products/campaigns
  Description: Updates existing campaigns.

PUT /products/category
  Description: Updates an existing category.
```

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

### MagicPay API - Installments

Source: https://magicpay.gitbook.io/magicpay-documentation/pos/get-pos

This section details the API endpoints related to installment plans within MagicPay. It covers querying available credit card bins and checking installment options for purchases.

```APIDOC
APIDOC:
  Query Bins:
    Endpoint: /installments/bins
    Method: GET
    Description: Queries credit card bins for installment information.
    Query Parameters:
      card_number_prefix: string (required)
    Response:
      bins: array of objects

  Installment Query:
    Endpoint: /installments/query
    Method: POST
    Description: Queries available installment plans for a purchase.
    Request Body:
      amount: integer (required)
      card_bin: string (required)
      merchant_id: string (required)
    Response:
      installments: array of objects
```

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

### MagicPay API - Installments

Source: https://magicpay.gitbook.io/magicpay-documentation/pos/get-pos-metadata

This section details the API endpoints related to installment plans within MagicPay. It covers querying available credit card bins and checking installment options for purchases.

```APIDOC
APIDOC:
  Query Bins:
    Endpoint: /installments/bins
    Method: GET
    Description: Queries credit card bins for installment information.
    Query Parameters:
      card_number_prefix: string (required)
    Response:
      bins: array of objects

  Installment Query:
    Endpoint: /installments/query
    Method: POST
    Description: Queries available installment plans for a purchase.
    Request Body:
      amount: integer (required)
      card_bin: string (required)
      merchant_id: string (required)
    Response:
      installments: array of objects
```
Tokens:
Raw