---
agentTools:
  projectIndex: https://docs.blinqpay.io/llms.txt
---

# Deposit(Collection)

Deposit operation allows you to submit a deposit (collection) request for processing

| Fields             | Required | Description                                                                                                                                                     |
| :----------------- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| amount             | true     | Transaction Amount (The amount to be paid by the customer) Minimum 100 Naira                                                                                    |
| firstName          | true     | Customer's first name                                                                                                                                           |
| lastName           | true     | Customer's  last name                                                                                                                                           |
| country            | true     | The ISO 3166-1 alpha-3, three character country code in upper case <https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3#Officially_assigned_code_elements>         |
| state              | true     | State Name                                                                                                                                                      |
| city               | true     | Valid City name                                                                                                                                                 |
| zip                | true     | Valid Zip Code                                                                                                                                                  |
| address            | true     | Address of customer                                                                                                                                             |
| email              | true     | Customer's email Address                                                                                                                                        |
| countryCode        | true     | Country code                                                                                                                                                    |
| operator           | true     | The operator code refers to the specific mobile network operator (MNO) this request should go to. You can find more information and all the supported operators |
| paymentReference   | true     | The unique reference identifying the transaction at your end                                                                                                    |
| phoneNo            | true     | Phone no where the payment request is sent to                                                                                                                   |
| paymentDescription | true     | Payment Description                                                                                                                                             |
| currency           | true     | The ISO 4217 three character currency code in upper case <https://en.wikipedia.org/wiki/ISO_4217#Active_codes>                                                  |
| ipAddress          | true     | IP address of user device, eg 98.41.205.246                                                                                                                     |
| callbackUrl        | true     | Callback URL where we redirect after transaction process completed.                                                                                             |

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Deposit (Collection)",
    "version": "1.0"
  },
  "servers": [
    {
      "url": "https://api.blinqpay.io/api/v1"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "apiKey",
        "in": "header",
        "name": "Authorization",
        "x-bearer-format": "bearer"
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/mobilemoney/deposit": {
      "post": {
        "summary": "Deposit(Collection)",
        "description": "Deposit operation allows you to submit a deposit (collection) request for processing",
        "operationId": "depositcollection",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "RAW_BODY": {
                    "type": "string",
                    "default": "{   \"amount\": \"500\",   \"firstName\": \"Daniel\",   \"lastName\": \"Mak\",   \"country\": \"UGA\",   \"state\": \"Central\",   \"city\": \"Kampala\",   \"zip\": \"10102\",   \"address\": \"Address\",   \"email\": \"test@gmail.com\",   \"countryCode\": \"+256\",   \"paymentReference\": \"MST-21P99599594\",   \"phoneNo\": \"256123456010\",   \"operator\": \"MTN_MOMO_UGA\",   \"paymentDescription\": \"Test transaction\",   \"currency\": \"UGX\",   \"ipAddress\": \"192.145.118.85\",   \"callbackUrl\": \"https://blinqpay.io\" }",
                    "format": "json"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {}
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {}
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true,
  "_id": "646b2b0e979619000de2d06d:646b28a9b728e2074739ca6d"
}
```