Skip to content
API Registry
/
/
Insert payment

Ledger/Sales service (1.0)

Using Swagger documentation in Postman


You can find instructions on how to convert swagger documentation to Postman collection here.
There is a known problem in Postman with env variables being imported as parameters (:schemaName instead of {{schemaName}}. More info on the issue can be found here.
Possible workaround is to find and replace all parameters with env variables inside Postman. For example search for :schemaName and replace with {{schemaName}}. Instructions how to do it in Postman are here.

Authorization

To obtain a token, start by visiting the identifier service documentation and make a request with your username and password.
Once you receive the response, copy the access_token and use it for making requests to ledger services.
Download OpenAPI description
bundled.json
bundled.yaml
Languages
Servers
Mock server

https://ledger.docs.insly.com/_mock/apis/ledger/bundled/

Beta

https://ledger.app.beta.insly.training/

Demo

https://ledger.app.demo.insly.com/

Quote Create

Operations

Quote Data

Operations

Quote Edit

Operations

Quote Calculation

Operations

Quote Documents

Operations

Quote Referrals

Operations

Quote Binding

Operations

Quote Issue

Operations

Policy Data

Operations

Policy Documents

Operations

Policy Termination

Operations

Schemes

Operations

Customers by identity

Operations

Payments

Operations

Insert payment

Request

Security
bearerAuth
Headers
X-TENANT-IDstringrequired

Tenant tag

Example: {$inputs.tenant}
Bodyapplication/jsonrequired
One of:
dataobject
data.​brokerobject
data.​broker.​shortNamestring
data.​paymentSuminteger(decimal)
data.​descriptionstring
data.​paymentDatestring(date)
data.​paymentTypestring
data.​paymentCurrencystring
curl -i -X POST \
  https://ledger.docs.insly.com/_mock/apis/ledger/bundled/api/v1/ledger/brokerpayments \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'X-TENANT-ID: {$inputs.tenant}' \
  -d '{
    "data": {
      "broker": {
        "shortName": "string"
      },
      "paymentSum": 0,
      "description": "string",
      "paymentDate": "2019-08-24",
      "paymentType": "string",
      "paymentCurrency": "string"
    }
  }'

Responses

Stored request data.

Bodyapplication/json
dataArray of objects(payments)
data[].​entry_datestring(date)
data[].​paymentReceivedDatestring(date)
data[].​paymentSumnumber
data[].​paymentCurrencystring
data[].​payerstring

customer id or broker name

data[].​descriptionstring

payment description

data[].​brokerstringDeprecated

broker name

Response
application/json
{
  "data": [
    { … }
  ]
}

Allocate payment

Request

Security
bearerAuth
Headers
X-TENANT-IDstringrequired

Tenant tag

Example: {$inputs.tenant}
curl -i -X POST \
  https://ledger.docs.insly.com/_mock/apis/ledger/bundled/api/v1/ledger/brokerpayments/allocate \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'X-TENANT-ID: {$inputs.tenant}'

Responses

Request hash for async pooling.

Bodyapplication/json
requestIdstring(uuid)

Request ID

Example: "8bb0e40f-6841-47fc-a283-b6a43c6e299e"
Response
application/json
{
  "requestId": "8bb0e40f-6841-47fc-a283-b6a43c6e299e"
}

Invoice

Operations

Policy Technical MTA

Operations

Async Request

Operations