Jump to

• Request
• Response
• Examples

Create a Loan

post

/bcws/webresources/v1.0/loans

Creates a new loan.

Request

There are no request parameters for this operation.

Supported Media Types

• application/xml
• application/json

Request Body - application/xml ()

The details of the loan to create.

Root Schema : schema

Type: object

Show Source

• accountRef: object ResourceRef
• amount(required): number
  The loan amount.
• channel(required): string
  The channel requesting the loan. For example, USSD or IVR.
• extension: object extension
  The extended attributes.
• locale(required): string
  The locale associated with the loan.
• resourceId(required): number
  The ID of the resource associated with the loan.
• service: object Service
  A service associated with the bundle.
• type: integer (int32)
  The type of loan. Can be one of the following:

  • 0: Currency or emergency loan
  • 1: Data loan
  • 2: Hybrid loan
• zoneMapName(required): string
  The name of the zonemap associated with the loan.
• zoneMapTarget(required): string
  The zone map associated with the loan.

{
    "required":[
        "amount",
        "channel",
        "locale",
        "resourceId",
        "zoneMapName",
        "zoneMapTarget"
    ],
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "accountRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "service":{
            "$ref":"#/components/schemas/Service"
        },
        "amount":{
            "type":"number",
            "description":"The loan amount."
        },
        "resourceId":{
            "type":"number",
            "description":"The ID of the resource associated with the loan."
        },
        "locale":{
            "type":"string",
            "description":"The locale associated with the loan."
        },
        "zoneMapTarget":{
            "type":"string",
            "description":"The zone map associated with the loan."
        },
        "zoneMapName":{
            "type":"string",
            "description":"The name of the zonemap associated with the loan."
        },
        "channel":{
            "type":"string",
            "description":"The channel requesting the loan. For example, USSD or IVR."
        },
        "type":{
            "type":"integer",
            "description":"The type of loan. Can be one of the following: <ul><li><b>0</b>: Currency or emergency loan</li><li><b>1</b>: Data loan</li><li><b>2</b>: Hybrid loan</li><ul>",
            "format":"int32"
        }
    },
    "xml":{
        "name":"applyLoan"
    }
}

Nested Schema : ResourceRef

Type: object

Show Source

• id(required): string
  The ID.
• uri: string
  The Uniform Resource Identifier (URI) associated with the resource.

{
    "required":[
        "id"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID."
        },
        "uri":{
            "type":"string",
            "description":"The Uniform Resource Identifier (URI) associated with the resource."
        }
    }
}

Nested Schema : extension

Type: object

The extended attributes.

Nested Schema : Service

Type: object

A service associated with the bundle.

Show Source

• serviceKey: string
  The service key.
• serviceType: string
  The service type.

{
    "type":"object",
    "properties":{
        "serviceKey":{
            "type":"string",
            "description":"The service key."
        },
        "serviceType":{
            "type":"string",
            "description":"The service type."
        }
    },
    "description":"A service associated with the bundle."
}

Request Body - application/json ()

The details of the loan to create.

Root Schema : schema

Type: object

Show Source

• accountRef: object ResourceRef
• amount(required): number
  The loan amount.
• channel(required): string
  The channel requesting the loan. For example, USSD or IVR.
• extension: object extension
  The extended attributes.
• locale(required): string
  The locale associated with the loan.
• resourceId(required): number
  The ID of the resource associated with the loan.
• service: object Service
  A service associated with the bundle.
• type: integer (int32)
  The type of loan. Can be one of the following:

  • 0: Currency or emergency loan
  • 1: Data loan
  • 2: Hybrid loan
• zoneMapName(required): string
  The name of the zonemap associated with the loan.
• zoneMapTarget(required): string
  The zone map associated with the loan.

{
    "required":[
        "amount",
        "channel",
        "locale",
        "resourceId",
        "zoneMapName",
        "zoneMapTarget"
    ],
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "accountRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "service":{
            "$ref":"#/components/schemas/Service"
        },
        "amount":{
            "type":"number",
            "description":"The loan amount."
        },
        "resourceId":{
            "type":"number",
            "description":"The ID of the resource associated with the loan."
        },
        "locale":{
            "type":"string",
            "description":"The locale associated with the loan."
        },
        "zoneMapTarget":{
            "type":"string",
            "description":"The zone map associated with the loan."
        },
        "zoneMapName":{
            "type":"string",
            "description":"The name of the zonemap associated with the loan."
        },
        "channel":{
            "type":"string",
            "description":"The channel requesting the loan. For example, USSD or IVR."
        },
        "type":{
            "type":"integer",
            "description":"The type of loan. Can be one of the following: <ul><li><b>0</b>: Currency or emergency loan</li><li><b>1</b>: Data loan</li><li><b>2</b>: Hybrid loan</li><ul>",
            "format":"int32"
        }
    },
    "xml":{
        "name":"applyLoan"
    }
}

Nested Schema : ResourceRef

Type: object

Show Source

• id(required): string
  The ID.
• uri: string
  The Uniform Resource Identifier (URI) associated with the resource.

{
    "required":[
        "id"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID."
        },
        "uri":{
            "type":"string",
            "description":"The Uniform Resource Identifier (URI) associated with the resource."
        }
    }
}

Nested Schema : extension

Type: object

The extended attributes.

Nested Schema : Service

Type: object

A service associated with the bundle.

Show Source

• serviceKey: string
  The service key.
• serviceType: string
  The service type.

{
    "type":"object",
    "properties":{
        "serviceKey":{
            "type":"string",
            "description":"The service key."
        },
        "serviceType":{
            "type":"string",
            "description":"The service type."
        }
    },
    "description":"A service associated with the bundle."
}

Back to Top

Response

201 Response

The loan was created successfully.

400 Response

The request isn't valid.

500 Response

An internal server error occurred.

Back to Top

Examples

This example shows how to create a loan by submitting a POST request on the REST resource using cURL. For more information about cURL, see "Use cURL".

cURL Command

curl -X POST 'http://hostname:port/bcws/webresources/version/loans' -H 'content-type: application/json' -d @createLoan.json

where:

• hostname is the URL for the Billing Care REST server.
• port is the port for the Billing Care REST server.
• version is the version of the API you're using, such as v1.0.
• createLoan.json is the JSON file that specifies the loan to create.

Example of Request Body

This example shows the contents of the createLoan.json file sent as the request body.

{
    "accountRef": {
        "id": "0.0.0.1+-account+103319"
    },
    "amount": 50,
    "resourceId": 1000095,
    "channel" : "USSD",
    "type" : 2
}

Example of Response Body

This example shows the contents of the response body in JSON format.

{
  "extension": null,
  "availableLoanBalance": 50,
  "currentBalance": 1955,
  "amount": 50,
  "loanFee": 10,
  "tax": 0,
  "balances": [
    {
      "amount": -800,
      "type": 1000095
    },
    {
      "amount": -1000,
      "type": 840
    }
  ],
  "availableLoanLimit": 9760,
  "creditLimit": 10000,
  "loanObj": {
    "id": "0.0.0.1+-event-billing-loan_debit+335412619122889132",
    "uri": null
  },
  "loanFeeObj": {
    "id": "0.0.0.1+-event-billing-loan_fee+335412619122891436",
    "uri": null
  }
}

Back to Top