Skip to content

@sourceloop/payment-service v19.0.0

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

payment microservice

Base URLs:

SubscriptionTransactionsController

SubscriptionTransactionsController.subscriptionandtransactionscreate

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
const inputBody = '{}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'text/html'
};

fetch('/create-subscription-and-pay',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
const fetch = require('node-fetch');
const inputBody = {};
const headers = {
  'Content-Type':'application/json',
  'Accept':'text/html'
};

fetch('/create-subscription-and-pay',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /create-subscription-and-pay

Permissions
CreateSubscription
2

Body parameter

1
{}

Parameters

Name In Type Required Description
body body object false none

Example responses

Responses

Status Meaning Description Schema
302 Found Subscription model instance None

Response Schema

SubscriptionTransactionsController.subscriptionTransactionscharge

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
const inputBody = '{}';
const headers = {
  'Content-Type':'application/x-www-form-urlencoded',
  'Accept':'application/json'
};

fetch('/subscription/transaction/charge',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
const fetch = require('node-fetch');
const inputBody = {};
const headers = {
  'Content-Type':'application/x-www-form-urlencoded',
  'Accept':'application/json'
};

fetch('/subscription/transaction/charge',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /subscription/transaction/charge

Body parameter

1
{}

Parameters

Name In Type Required Description
body body object false none

Example responses

Responses

Status Meaning Description Schema
200 OK Subscription model instance None

Response Schema

OrdersController

OrdersController.count

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
const headers = {
  'Accept':'application/json'
};

fetch('/orders/count',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json'
};

fetch('/orders/count',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /orders/count

Permissions
ViewOrder
7

Parameters

Name In Type Required Description
where query object false none

Example responses

200 Response

1
2
3
{
  "count": 0
}

Responses

Status Meaning Description Schema
200 OK Orders model count loopback.Count

OrdersController.replaceById

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
const inputBody = '{
  "id": "string",
  "totalAmount": 0,
  "currency": "string",
  "status": "string",
  "paymentGatewayId": "string",
  "paymentmethod": "string",
  "metaData": {}
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('/orders/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
const fetch = require('node-fetch');
const inputBody = {
  "id": "string",
  "totalAmount": 0,
  "currency": "string",
  "status": "string",
  "paymentGatewayId": "string",
  "paymentmethod": "string",
  "metaData": {}
};
const headers = {
  'Content-Type':'application/json'
};

fetch('/orders/{id}',
{
  method: 'PUT',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PUT /orders/{id}

Permissions
UpdateOrder
8

Body parameter

1
2
3
4
5
6
7
8
9
{
  "id": "string",
  "totalAmount": 0,
  "currency": "string",
  "status": "string",
  "paymentGatewayId": "string",
  "paymentmethod": "string",
  "metaData": {}
}

Parameters

Name In Type Required Description
id path string true none
body body Orders false none

Responses

Status Meaning Description Schema
204 No Content Orders PUT success None

OrdersController.updateById

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
const inputBody = '{
  "id": "string",
  "totalAmount": 0,
  "currency": "string",
  "status": "string",
  "paymentGatewayId": "string",
  "paymentmethod": "string",
  "metaData": {}
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('/orders/{id}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
const fetch = require('node-fetch');
const inputBody = {
  "id": "string",
  "totalAmount": 0,
  "currency": "string",
  "status": "string",
  "paymentGatewayId": "string",
  "paymentmethod": "string",
  "metaData": {}
};
const headers = {
  'Content-Type':'application/json'
};

fetch('/orders/{id}',
{
  method: 'PATCH',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PATCH /orders/{id}

Permissions
UpdateOrder
8

Body parameter

1
2
3
4
5
6
7
8
9
{
  "id": "string",
  "totalAmount": 0,
  "currency": "string",
  "status": "string",
  "paymentGatewayId": "string",
  "paymentmethod": "string",
  "metaData": {}
}

Parameters

Name In Type Required Description
id path string true none
body body OrdersPartial false none

Responses

Status Meaning Description Schema
204 No Content Orders PATCH success None

OrdersController.findById

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
const headers = {
  'Accept':'application/json'
};

fetch('/orders/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json'
};

fetch('/orders/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /orders/{id}

Permissions
ViewOrder
7

Parameters

Name In Type Required Description
id path string true none
filter query orders.Filter false none

Example responses

200 Response

1
2
3
4
5
6
7
8
9
{
  "id": "string",
  "totalAmount": 0,
  "currency": "string",
  "status": "string",
  "paymentGatewayId": "string",
  "paymentmethod": "string",
  "metaData": {}
}

Responses

Status Meaning Description Schema
200 OK Orders model instance OrdersWithRelations

OrdersController.deleteById

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
fetch('/orders/{id}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
const fetch = require('node-fetch');

fetch('/orders/{id}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /orders/{id}

Permissions
DeleteOrder
9

Parameters

Name In Type Required Description
id path string true none

Responses

Status Meaning Description Schema
204 No Content Orders DELETE success None

OrdersController.create

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
const inputBody = '{
  "id": "string",
  "totalAmount": 0,
  "currency": "string",
  "status": "string",
  "paymentGatewayId": "string",
  "paymentmethod": "string",
  "metaData": {}
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/orders',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
const fetch = require('node-fetch');
const inputBody = {
  "id": "string",
  "totalAmount": 0,
  "currency": "string",
  "status": "string",
  "paymentGatewayId": "string",
  "paymentmethod": "string",
  "metaData": {}
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/orders',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /orders

Permissions
CreateOrder
6

Body parameter

1
2
3
4
5
6
7
8
9
{
  "id": "string",
  "totalAmount": 0,
  "currency": "string",
  "status": "string",
  "paymentGatewayId": "string",
  "paymentmethod": "string",
  "metaData": {}
}

Parameters

Name In Type Required Description
body body NewOrders false none

Example responses

200 Response

1
2
3
4
5
6
7
8
9
{
  "id": "string",
  "totalAmount": 0,
  "currency": "string",
  "status": "string",
  "paymentGatewayId": "string",
  "paymentmethod": "string",
  "metaData": {}
}

Responses

Status Meaning Description Schema
200 OK Orders model instance Orders

OrdersController.updateAll

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
const inputBody = '{
  "id": "string",
  "totalAmount": 0,
  "currency": "string",
  "status": "string",
  "paymentGatewayId": "string",
  "paymentmethod": "string",
  "metaData": {}
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/orders',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
const fetch = require('node-fetch');
const inputBody = {
  "id": "string",
  "totalAmount": 0,
  "currency": "string",
  "status": "string",
  "paymentGatewayId": "string",
  "paymentmethod": "string",
  "metaData": {}
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/orders',
{
  method: 'PATCH',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PATCH /orders

Permissions
UpdateOrder
8

Body parameter

1
2
3
4
5
6
7
8
9
{
  "id": "string",
  "totalAmount": 0,
  "currency": "string",
  "status": "string",
  "paymentGatewayId": "string",
  "paymentmethod": "string",
  "metaData": {}
}

Parameters

Name In Type Required Description
where query object false none
body body OrdersPartial false none

Example responses

200 Response

1
2
3
{
  "count": 0
}

Responses

Status Meaning Description Schema
200 OK Orders PATCH success count loopback.Count

OrdersController.find

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
const headers = {
  'Accept':'application/json'
};

fetch('/orders',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json'
};

fetch('/orders',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /orders

Permissions
ViewOrder
7

Parameters

Name In Type Required Description
filter query orders.Filter1 false none

Example responses

200 Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
[
  {
    "id": "string",
    "totalAmount": 0,
    "currency": "string",
    "status": "string",
    "paymentGatewayId": "string",
    "paymentmethod": "string",
    "metaData": {}
  }
]

Responses

Status Meaning Description Schema
200 OK Array of Orders model instances Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [OrdersWithRelations] false none [(tsType: OrdersWithRelations, schemaOptions: { includeRelations: true })]
» OrdersWithRelations OrdersWithRelations false none (tsType: OrdersWithRelations, schemaOptions: { includeRelations: true })
»» id string false none none
»» totalAmount number true none none
»» currency string true none none
»» status string true none none
»» paymentGatewayId string true none none
»» paymentmethod string false none none
»» metaData object false none none

PaymentGatewaysController

PaymentGatewaysController.count

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
const headers = {
  'Accept':'application/json'
};

fetch('/payment-gateways/count',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json'
};

fetch('/payment-gateways/count',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /payment-gateways/count

Permissions
ViewGateway
12

Parameters

Name In Type Required Description
where query object false none

Example responses

200 Response

1
2
3
{
  "count": 0
}

Responses

Status Meaning Description Schema
200 OK PaymentGateways model count loopback.Count

PaymentGatewaysController.replaceById

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
const inputBody = '{
  "id": "string",
  "name": "string",
  "gatewayType": "string",
  "enabled": true
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('/payment-gateways/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
const fetch = require('node-fetch');
const inputBody = {
  "id": "string",
  "name": "string",
  "gatewayType": "string",
  "enabled": true
};
const headers = {
  'Content-Type':'application/json'
};

fetch('/payment-gateways/{id}',
{
  method: 'PUT',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PUT /payment-gateways/{id}

Permissions
UpdateGateway
11

Body parameter

1
2
3
4
5
6
{
  "id": "string",
  "name": "string",
  "gatewayType": "string",
  "enabled": true
}

Parameters

Name In Type Required Description
id path string true none
body body PaymentGateways false none

Responses

Status Meaning Description Schema
204 No Content PaymentGateways PUT success None

PaymentGatewaysController.updateById

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
const inputBody = '{
  "id": "string",
  "name": "string",
  "gatewayType": "string",
  "enabled": true
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('/payment-gateways/{id}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
const fetch = require('node-fetch');
const inputBody = {
  "id": "string",
  "name": "string",
  "gatewayType": "string",
  "enabled": true
};
const headers = {
  'Content-Type':'application/json'
};

fetch('/payment-gateways/{id}',
{
  method: 'PATCH',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PATCH /payment-gateways/{id}

Permissions
UpdateGateway
11

Body parameter

1
2
3
4
5
6
{
  "id": "string",
  "name": "string",
  "gatewayType": "string",
  "enabled": true
}

Parameters

Name In Type Required Description
id path string true none
body body PaymentGatewaysPartial false none

Responses

Status Meaning Description Schema
204 No Content PaymentGateways PATCH success None

PaymentGatewaysController.findById

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
const headers = {
  'Accept':'application/json'
};

fetch('/payment-gateways/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json'
};

fetch('/payment-gateways/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /payment-gateways/{id}

Permissions
ViewGateway
12

Parameters

Name In Type Required Description
id path string true none
filter query paymentgateways.Filter false none

Example responses

200 Response

1
2
3
4
5
6
{
  "id": "string",
  "name": "string",
  "gatewayType": "string",
  "enabled": true
}

Responses

Status Meaning Description Schema
200 OK PaymentGateways model instance PaymentGatewaysWithRelations

PaymentGatewaysController.deleteById

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
fetch('/payment-gateways/{id}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
const fetch = require('node-fetch');

fetch('/payment-gateways/{id}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /payment-gateways/{id}

Permissions
DeleteGateway
13

Parameters

Name In Type Required Description
id path string true none

Responses

Status Meaning Description Schema
204 No Content PaymentGateways DELETE success None

PaymentGatewaysController.create

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
const inputBody = '{
  "id": "string",
  "name": "string",
  "gatewayType": "string",
  "enabled": true
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/payment-gateways',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
const fetch = require('node-fetch');
const inputBody = {
  "id": "string",
  "name": "string",
  "gatewayType": "string",
  "enabled": true
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/payment-gateways',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /payment-gateways

Permissions
CreateGateway
10

Body parameter

1
2
3
4
5
6
{
  "id": "string",
  "name": "string",
  "gatewayType": "string",
  "enabled": true
}

Parameters

Name In Type Required Description
body body NewPaymentGateways false none

Example responses

200 Response

1
2
3
4
5
6
{
  "id": "string",
  "name": "string",
  "gatewayType": "string",
  "enabled": true
}

Responses

Status Meaning Description Schema
200 OK PaymentGateways model instance PaymentGateways

PaymentGatewaysController.updateAll

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
const inputBody = '{
  "id": "string",
  "name": "string",
  "gatewayType": "string",
  "enabled": true
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/payment-gateways',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
const fetch = require('node-fetch');
const inputBody = {
  "id": "string",
  "name": "string",
  "gatewayType": "string",
  "enabled": true
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/payment-gateways',
{
  method: 'PATCH',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PATCH /payment-gateways

Permissions
UpdateGateway
11

Body parameter

1
2
3
4
5
6
{
  "id": "string",
  "name": "string",
  "gatewayType": "string",
  "enabled": true
}

Parameters

Name In Type Required Description
where query object false none
body body PaymentGatewaysPartial false none

Example responses

200 Response

1
2
3
{
  "count": 0
}

Responses

Status Meaning Description Schema
200 OK PaymentGateways PATCH success count loopback.Count

PaymentGatewaysController.find

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
const headers = {
  'Accept':'application/json'
};

fetch('/payment-gateways',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json'
};

fetch('/payment-gateways',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /payment-gateways

Permissions
ViewGateway
12

Parameters

Name In Type Required Description
filter query paymentgateways.Filter1 false none

Example responses

200 Response

1
2
3
4
5
6
7
8
[
  {
    "id": "string",
    "name": "string",
    "gatewayType": "string",
    "enabled": true
  }
]

Responses

Status Meaning Description Schema
200 OK Array of PaymentGateways model instances Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [PaymentGatewaysWithRelations] false none [(tsType: PaymentGatewaysWithRelations, schemaOptions: { includeRelations: true })]
» PaymentGatewaysWithRelations PaymentGatewaysWithRelations false none (tsType: PaymentGatewaysWithRelations, schemaOptions: { includeRelations: true })
»» id string true none none
»» name string true none none
»» gatewayType string true none none
»» enabled boolean true none none

PingController

PingController.ping

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
const headers = {
  'Accept':'application/json'
};

fetch('/ping',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json'
};

fetch('/ping',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /ping

Example responses

200 Response

1
2
3
4
5
6
7
8
{
  "greeting": "string",
  "date": "string",
  "url": "string",
  "headers": {
    "Content-Type": "string"
  }
}

Responses

Status Meaning Description Schema
200 OK Ping Response PingResponse

TransactionsController

TransactionsController.orderandtransactionscreate

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
const inputBody = '{}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'text/html'
};

fetch('/place-order-and-pay',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
const fetch = require('node-fetch');
const inputBody = {};
const headers = {
  'Content-Type':'application/json',
  'Accept':'text/html'
};

fetch('/place-order-and-pay',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /place-order-and-pay

Body parameter

1
{}

Parameters

Name In Type Required Description
body body object false none

Example responses

Responses

Status Meaning Description Schema
302 Found Order model instance None

Response Schema

TransactionsController.transactionscharge

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
const inputBody = '{}';
const headers = {
  'Content-Type':'application/x-www-form-urlencoded',
  'Accept':'application/json'
};

fetch('/transactions/charge',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
const fetch = require('node-fetch');
const inputBody = {};
const headers = {
  'Content-Type':'application/x-www-form-urlencoded',
  'Accept':'application/json'
};

fetch('/transactions/charge',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /transactions/charge

Body parameter

1
{}

Parameters

Name In Type Required Description
body body object false none

Example responses

Responses

Status Meaning Description Schema
200 OK Transacttion Gateway Request None

Response Schema

TransactionsController.count

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
const headers = {
  'Accept':'application/json'
};

fetch('/transactions/count',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json'
};

fetch('/transactions/count',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /transactions/count

Permissions
ViewTransaction
19

Parameters

Name In Type Required Description
where query object false none

Example responses

200 Response

1
2
3
{
  "count": 0
}

Responses

Status Meaning Description Schema
200 OK Transactions model count loopback.Count

TransactionsController.transactionsPay

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
const headers = {
  'Accept':'text/html'
};

fetch('/transactions/orderid/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
const fetch = require('node-fetch');

const headers = {
  'Accept':'text/html'
};

fetch('/transactions/orderid/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /transactions/orderid/{id}

Parameters

Name In Type Required Description
id path string true none

Example responses

200 Response

1
{}

Responses

Status Meaning Description Schema
200 OK HTML response for payment gateway interface. Inline

Response Schema

TransactionsController.transactionsRefundParse

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
const headers = {
  'Accept':'application/json'
};

fetch('/transactions/refund/parse/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json'
};

fetch('/transactions/refund/parse/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /transactions/refund/parse/{id}

Parameters

Name In Type Required Description
id path string true none

Example responses

Responses

Status Meaning Description Schema
200 OK Refund Object from payment gateway None

Response Schema

TransactionsController.transactionsRefund

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
const headers = {
  'Accept':'application/json'
};

fetch('/transactions/refund/{id}',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json'
};

fetch('/transactions/refund/{id}',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /transactions/refund/{id}

Parameters

Name In Type Required Description
id path string true none

Example responses

Responses

Status Meaning Description Schema
200 OK Refund Object from payment gateway None

Response Schema

TransactionsController.subscriptionWebHook

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
const inputBody = '{}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/transactions/webhook',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
const fetch = require('node-fetch');
const inputBody = {};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/transactions/webhook',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /transactions/webhook

Body parameter

1
{}

Parameters

Name In Type Required Description
body body object false none

Example responses

Responses

Status Meaning Description Schema
200 OK Subscription Gateway Request None

Response Schema

TransactionsController.replaceById

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
const inputBody = '{
  "id": "string",
  "amountPaid": 0,
  "currency": "string",
  "status": "string",
  "paidDate": "2019-08-24T14:15:22Z",
  "paymentGatewayId": "string",
  "orderId": "string",
  "res": {}
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('/transactions/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
const fetch = require('node-fetch');
const inputBody = {
  "id": "string",
  "amountPaid": 0,
  "currency": "string",
  "status": "string",
  "paidDate": "2019-08-24T14:15:22Z",
  "paymentGatewayId": "string",
  "orderId": "string",
  "res": {}
};
const headers = {
  'Content-Type':'application/json'
};

fetch('/transactions/{id}',
{
  method: 'PUT',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PUT /transactions/{id}

Permissions
UpdateTransaction
20

Body parameter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
{
  "id": "string",
  "amountPaid": 0,
  "currency": "string",
  "status": "string",
  "paidDate": "2019-08-24T14:15:22Z",
  "paymentGatewayId": "string",
  "orderId": "string",
  "res": {}
}

Parameters

Name In Type Required Description
id path string true none
body body Transactions false none

Responses

Status Meaning Description Schema
204 No Content Transactions PUT success None

TransactionsController.updateById

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
const inputBody = '{
  "id": "string",
  "amountPaid": 0,
  "currency": "string",
  "status": "string",
  "paidDate": "2019-08-24T14:15:22Z",
  "paymentGatewayId": "string",
  "orderId": "string",
  "res": {}
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('/transactions/{id}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
const fetch = require('node-fetch');
const inputBody = {
  "id": "string",
  "amountPaid": 0,
  "currency": "string",
  "status": "string",
  "paidDate": "2019-08-24T14:15:22Z",
  "paymentGatewayId": "string",
  "orderId": "string",
  "res": {}
};
const headers = {
  'Content-Type':'application/json'
};

fetch('/transactions/{id}',
{
  method: 'PATCH',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PATCH /transactions/{id}

Permissions
UpdateTransaction
20

Body parameter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
{
  "id": "string",
  "amountPaid": 0,
  "currency": "string",
  "status": "string",
  "paidDate": "2019-08-24T14:15:22Z",
  "paymentGatewayId": "string",
  "orderId": "string",
  "res": {}
}

Parameters

Name In Type Required Description
id path string true none
body body TransactionsPartial false none

Responses

Status Meaning Description Schema
204 No Content Transactions PATCH success None

TransactionsController.findById

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
const headers = {
  'Accept':'application/json'
};

fetch('/transactions/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json'
};

fetch('/transactions/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /transactions/{id}

Permissions
ViewTransaction
19

Parameters

Name In Type Required Description
id path string true none
filter query transactions.Filter false none

Example responses

200 Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
{
  "id": "string",
  "amountPaid": 0,
  "currency": "string",
  "status": "string",
  "paidDate": "2019-08-24T14:15:22Z",
  "paymentGatewayId": "string",
  "orderId": "string",
  "res": {}
}

Responses

Status Meaning Description Schema
200 OK Transactions model instance TransactionsWithRelations

TransactionsController.deleteById

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
fetch('/transactions/{id}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
const fetch = require('node-fetch');

fetch('/transactions/{id}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /transactions/{id}

Permissions
DeleteTransaction
21

Parameters

Name In Type Required Description
id path string true none

Responses

Status Meaning Description Schema
204 No Content Transactions DELETE success None

TransactionsController.create

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
const inputBody = '{
  "id": "string",
  "amountPaid": 0,
  "currency": "string",
  "status": "string",
  "paidDate": "2019-08-24T14:15:22Z",
  "paymentGatewayId": "string",
  "orderId": "string",
  "res": {}
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/transactions',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
const fetch = require('node-fetch');
const inputBody = {
  "id": "string",
  "amountPaid": 0,
  "currency": "string",
  "status": "string",
  "paidDate": "2019-08-24T14:15:22Z",
  "paymentGatewayId": "string",
  "orderId": "string",
  "res": {}
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/transactions',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /transactions

Permissions
CreateTransaction
18

Body parameter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
{
  "id": "string",
  "amountPaid": 0,
  "currency": "string",
  "status": "string",
  "paidDate": "2019-08-24T14:15:22Z",
  "paymentGatewayId": "string",
  "orderId": "string",
  "res": {}
}

Parameters

Name In Type Required Description
body body NewTransactions false none

Example responses

200 Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
{
  "id": "string",
  "amountPaid": 0,
  "currency": "string",
  "status": "string",
  "paidDate": "2019-08-24T14:15:22Z",
  "paymentGatewayId": "string",
  "orderId": "string",
  "res": {}
}

Responses

Status Meaning Description Schema
200 OK Transactions model instance Transactions

TransactionsController.updateAll

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
const inputBody = '{
  "id": "string",
  "amountPaid": 0,
  "currency": "string",
  "status": "string",
  "paidDate": "2019-08-24T14:15:22Z",
  "paymentGatewayId": "string",
  "orderId": "string",
  "res": {}
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/transactions',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
const fetch = require('node-fetch');
const inputBody = {
  "id": "string",
  "amountPaid": 0,
  "currency": "string",
  "status": "string",
  "paidDate": "2019-08-24T14:15:22Z",
  "paymentGatewayId": "string",
  "orderId": "string",
  "res": {}
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/transactions',
{
  method: 'PATCH',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PATCH /transactions

Permissions
UpdateTransaction
20

Body parameter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
{
  "id": "string",
  "amountPaid": 0,
  "currency": "string",
  "status": "string",
  "paidDate": "2019-08-24T14:15:22Z",
  "paymentGatewayId": "string",
  "orderId": "string",
  "res": {}
}

Parameters

Name In Type Required Description
where query object false none
body body TransactionsPartial false none

Example responses

200 Response

1
2
3
{
  "count": 0
}

Responses

Status Meaning Description Schema
200 OK Transactions PATCH success count loopback.Count

TransactionsController.find

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
const headers = {
  'Accept':'application/json'
};

fetch('/transactions',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json'
};

fetch('/transactions',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /transactions

Permissions
ViewTransaction
19

Parameters

Name In Type Required Description
filter query transactions.Filter1 false none

Example responses

200 Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
[
  {
    "id": "string",
    "amountPaid": 0,
    "currency": "string",
    "status": "string",
    "paidDate": "2019-08-24T14:15:22Z",
    "paymentGatewayId": "string",
    "orderId": "string",
    "res": {}
  }
]

Responses

Status Meaning Description Schema
200 OK Array of Transactions model instances Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [TransactionsWithRelations] false none [(tsType: TransactionsWithRelations, schemaOptions: { includeRelations: true })]
» TransactionsWithRelations TransactionsWithRelations false none (tsType: TransactionsWithRelations, schemaOptions: { includeRelations: true })
»» id string true none none
»» amountPaid number true none none
»» currency string true none none
»» status string true none none
»» paidDate string(date-time) false none none
»» paymentGatewayId string false none none
»» orderId string false none none
»» res object false none none

SubscriptionsController

SubscriptionsController.count

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
const headers = {
  'Accept':'application/json'
};

fetch('/subscriptions/count',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json'
};

fetch('/subscriptions/count',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /subscriptions/count

Permissions
GetSubscriptionCount
1

Parameters

Name In Type Required Description
where query object false none

Example responses

200 Response

1
2
3
{
  "count": 0
}

Responses

Status Meaning Description Schema
200 OK Subscriptions model count loopback.Count

SubscriptionsController.replaceById

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
const inputBody = '{
  "id": "string",
  "totalAmount": 0,
  "currency": "string",
  "status": "string",
  "paymentGatewayId": "string",
  "paymentMethod": "string",
  "metaData": {},
  "startDate": "2019-08-24T14:15:22Z",
  "endDate": "2019-08-24T14:15:22Z",
  "gatewaySubscriptionId": "string",
  "planId": "string"
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('/subscriptions/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
const fetch = require('node-fetch');
const inputBody = {
  "id": "string",
  "totalAmount": 0,
  "currency": "string",
  "status": "string",
  "paymentGatewayId": "string",
  "paymentMethod": "string",
  "metaData": {},
  "startDate": "2019-08-24T14:15:22Z",
  "endDate": "2019-08-24T14:15:22Z",
  "gatewaySubscriptionId": "string",
  "planId": "string"
};
const headers = {
  'Content-Type':'application/json'
};

fetch('/subscriptions/{id}',
{
  method: 'PUT',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PUT /subscriptions/{id}

Permissions
UpdateSubscriptions
4

Body parameter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
{
  "id": "string",
  "totalAmount": 0,
  "currency": "string",
  "status": "string",
  "paymentGatewayId": "string",
  "paymentMethod": "string",
  "metaData": {},
  "startDate": "2019-08-24T14:15:22Z",
  "endDate": "2019-08-24T14:15:22Z",
  "gatewaySubscriptionId": "string",
  "planId": "string"
}

Parameters

Name In Type Required Description
id path string true none
body body Subscriptions false none

Responses

Status Meaning Description Schema
204 No Content Subscriptions PUT success None

SubscriptionsController.updateById

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
const inputBody = '{
  "id": "string",
  "totalAmount": 0,
  "currency": "string",
  "status": "string",
  "paymentGatewayId": "string",
  "paymentMethod": "string",
  "metaData": {},
  "startDate": "2019-08-24T14:15:22Z",
  "endDate": "2019-08-24T14:15:22Z",
  "gatewaySubscriptionId": "string",
  "planId": "string"
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('/subscriptions/{id}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
const fetch = require('node-fetch');
const inputBody = {
  "id": "string",
  "totalAmount": 0,
  "currency": "string",
  "status": "string",
  "paymentGatewayId": "string",
  "paymentMethod": "string",
  "metaData": {},
  "startDate": "2019-08-24T14:15:22Z",
  "endDate": "2019-08-24T14:15:22Z",
  "gatewaySubscriptionId": "string",
  "planId": "string"
};
const headers = {
  'Content-Type':'application/json'
};

fetch('/subscriptions/{id}',
{
  method: 'PATCH',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PATCH /subscriptions/{id}

Permissions
UpdateSubscriptions
4

Body parameter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
{
  "id": "string",
  "totalAmount": 0,
  "currency": "string",
  "status": "string",
  "paymentGatewayId": "string",
  "paymentMethod": "string",
  "metaData": {},
  "startDate": "2019-08-24T14:15:22Z",
  "endDate": "2019-08-24T14:15:22Z",
  "gatewaySubscriptionId": "string",
  "planId": "string"
}

Parameters

Name In Type Required Description
id path string true none
body body SubscriptionsPartial false none

Responses

Status Meaning Description Schema
204 No Content Subscriptions PATCH success None

SubscriptionsController.findById

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
const headers = {
  'Accept':'application/json'
};

fetch('/subscriptions/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json'
};

fetch('/subscriptions/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /subscriptions/{id}

Permissions
GetSubscriptions
3

Parameters

Name In Type Required Description
id path string true none
filter query subscriptions.Filter false none

Example responses

200 Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
{
  "id": "string",
  "totalAmount": 0,
  "currency": "string",
  "status": "string",
  "paymentGatewayId": "string",
  "paymentMethod": "string",
  "metaData": {},
  "startDate": "2019-08-24T14:15:22Z",
  "endDate": "2019-08-24T14:15:22Z",
  "gatewaySubscriptionId": "string",
  "planId": "string"
}

Responses

Status Meaning Description Schema
200 OK Subscriptions model instance SubscriptionsWithRelations

SubscriptionsController.deleteById

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
fetch('/subscriptions/{id}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
const fetch = require('node-fetch');

fetch('/subscriptions/{id}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /subscriptions/{id}

Permissions
DeleteSubscriptions
5

Parameters

Name In Type Required Description
id path string true none

Responses

Status Meaning Description Schema
204 No Content Subscriptions DELETE success None

SubscriptionsController.create

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
const inputBody = '{
  "id": "string",
  "totalAmount": 0,
  "currency": "string",
  "status": "string",
  "paymentGatewayId": "string",
  "paymentMethod": "string",
  "metaData": {},
  "startDate": "2019-08-24T14:15:22Z",
  "endDate": "2019-08-24T14:15:22Z",
  "gatewaySubscriptionId": "string",
  "planId": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/subscriptions',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
const fetch = require('node-fetch');
const inputBody = {
  "id": "string",
  "totalAmount": 0,
  "currency": "string",
  "status": "string",
  "paymentGatewayId": "string",
  "paymentMethod": "string",
  "metaData": {},
  "startDate": "2019-08-24T14:15:22Z",
  "endDate": "2019-08-24T14:15:22Z",
  "gatewaySubscriptionId": "string",
  "planId": "string"
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/subscriptions',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /subscriptions

Permissions
CreateSubscription
2

Body parameter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
{
  "id": "string",
  "totalAmount": 0,
  "currency": "string",
  "status": "string",
  "paymentGatewayId": "string",
  "paymentMethod": "string",
  "metaData": {},
  "startDate": "2019-08-24T14:15:22Z",
  "endDate": "2019-08-24T14:15:22Z",
  "gatewaySubscriptionId": "string",
  "planId": "string"
}

Parameters

Name In Type Required Description
body body NewSubscriptions false none

Example responses

200 Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
{
  "id": "string",
  "totalAmount": 0,
  "currency": "string",
  "status": "string",
  "paymentGatewayId": "string",
  "paymentMethod": "string",
  "metaData": {},
  "startDate": "2019-08-24T14:15:22Z",
  "endDate": "2019-08-24T14:15:22Z",
  "gatewaySubscriptionId": "string",
  "planId": "string"
}

Responses

Status Meaning Description Schema
200 OK Subscriptions model instance Subscriptions

SubscriptionsController.updateAll

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
const inputBody = '{
  "id": "string",
  "totalAmount": 0,
  "currency": "string",
  "status": "string",
  "paymentGatewayId": "string",
  "paymentMethod": "string",
  "metaData": {},
  "startDate": "2019-08-24T14:15:22Z",
  "endDate": "2019-08-24T14:15:22Z",
  "gatewaySubscriptionId": "string",
  "planId": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/subscriptions',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
const fetch = require('node-fetch');
const inputBody = {
  "id": "string",
  "totalAmount": 0,
  "currency": "string",
  "status": "string",
  "paymentGatewayId": "string",
  "paymentMethod": "string",
  "metaData": {},
  "startDate": "2019-08-24T14:15:22Z",
  "endDate": "2019-08-24T14:15:22Z",
  "gatewaySubscriptionId": "string",
  "planId": "string"
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/subscriptions',
{
  method: 'PATCH',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PATCH /subscriptions

Permissions
UpdateSubscriptions
4

Body parameter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
{
  "id": "string",
  "totalAmount": 0,
  "currency": "string",
  "status": "string",
  "paymentGatewayId": "string",
  "paymentMethod": "string",
  "metaData": {},
  "startDate": "2019-08-24T14:15:22Z",
  "endDate": "2019-08-24T14:15:22Z",
  "gatewaySubscriptionId": "string",
  "planId": "string"
}

Parameters

Name In Type Required Description
where query object false none
body body SubscriptionsPartial false none

Example responses

200 Response

1
2
3
{
  "count": 0
}

Responses

Status Meaning Description Schema
200 OK Subscriptions PATCH success count loopback.Count

SubscriptionsController.find

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
const headers = {
  'Accept':'application/json'
};

fetch('/subscriptions',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json'
};

fetch('/subscriptions',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /subscriptions

Permissions
GetSubscriptions
3

Parameters

Name In Type Required Description
filter query subscriptions.Filter1 false none

Example responses

200 Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
[
  {
    "id": "string",
    "totalAmount": 0,
    "currency": "string",
    "status": "string",
    "paymentGatewayId": "string",
    "paymentMethod": "string",
    "metaData": {},
    "startDate": "2019-08-24T14:15:22Z",
    "endDate": "2019-08-24T14:15:22Z",
    "gatewaySubscriptionId": "string",
    "planId": "string"
  }
]

Responses

Status Meaning Description Schema
200 OK Array of Subscriptions model instances Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [SubscriptionsWithRelations] false none [(tsType: SubscriptionsWithRelations, schemaOptions: { includeRelations: true })]
» SubscriptionsWithRelations SubscriptionsWithRelations false none (tsType: SubscriptionsWithRelations, schemaOptions: { includeRelations: true })
»» id string true none none
»» totalAmount number true none none
»» currency string false none none
»» status string true none none
»» paymentGatewayId string false none none
»» paymentMethod string false none none
»» metaData object false none none
»» startDate string(date-time) false none none
»» endDate string(date-time) false none none
»» gatewaySubscriptionId string false none none
»» planId string false none none

TemplatesController

TemplatesController.count

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
const headers = {
  'Accept':'application/json'
};

fetch('/templates/count',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json'
};

fetch('/templates/count',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /templates/count

Permissions
ViewTemplate
16

Parameters

Name In Type Required Description
where query object false none

Example responses

200 Response

1
2
3
{
  "count": 0
}

Responses

Status Meaning Description Schema
200 OK Templates model count loopback.Count

TemplatesController.replaceById

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
const inputBody = '{
  "id": "string",
  "paymentGatewayId": "string",
  "name": "string",
  "template": "string",
  "type": "string"
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('/templates/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
const fetch = require('node-fetch');
const inputBody = {
  "id": "string",
  "paymentGatewayId": "string",
  "name": "string",
  "template": "string",
  "type": "string"
};
const headers = {
  'Content-Type':'application/json'
};

fetch('/templates/{id}',
{
  method: 'PUT',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PUT /templates/{id}

Permissions
UpdateTemplate
15

Body parameter

1
2
3
4
5
6
7
{
  "id": "string",
  "paymentGatewayId": "string",
  "name": "string",
  "template": "string",
  "type": "string"
}

Parameters

Name In Type Required Description
id path string true none
body body Templates false none

Responses

Status Meaning Description Schema
204 No Content Templates PUT success None

TemplatesController.updateById

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
const inputBody = '{
  "id": "string",
  "paymentGatewayId": "string",
  "name": "string",
  "template": "string",
  "type": "string"
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('/templates/{id}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
const fetch = require('node-fetch');
const inputBody = {
  "id": "string",
  "paymentGatewayId": "string",
  "name": "string",
  "template": "string",
  "type": "string"
};
const headers = {
  'Content-Type':'application/json'
};

fetch('/templates/{id}',
{
  method: 'PATCH',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PATCH /templates/{id}

Permissions
UpdateTemplate
15

Body parameter

1
2
3
4
5
6
7
{
  "id": "string",
  "paymentGatewayId": "string",
  "name": "string",
  "template": "string",
  "type": "string"
}

Parameters

Name In Type Required Description
id path string true none
body body TemplatesPartial false none

Responses

Status Meaning Description Schema
204 No Content Templates PATCH success None

TemplatesController.findById

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
const headers = {
  'Accept':'application/json'
};

fetch('/templates/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json'
};

fetch('/templates/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /templates/{id}

Permissions
ViewTemplate
16

Parameters

Name In Type Required Description
id path string true none
filter query templates.Filter false none

Example responses

200 Response

1
2
3
4
5
6
7
{
  "id": "string",
  "paymentGatewayId": "string",
  "name": "string",
  "template": "string",
  "type": "string"
}

Responses

Status Meaning Description Schema
200 OK Templates model instance TemplatesWithRelations

TemplatesController.deleteById

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
fetch('/templates/{id}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
const fetch = require('node-fetch');

fetch('/templates/{id}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /templates/{id}

Permissions
DeleteTemplate
17

Parameters

Name In Type Required Description
id path string true none

Responses

Status Meaning Description Schema
204 No Content Templates DELETE success None

TemplatesController.create

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
const inputBody = '{
  "id": "string",
  "paymentGatewayId": "string",
  "name": "string",
  "template": "string",
  "type": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/templates',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
const fetch = require('node-fetch');
const inputBody = {
  "id": "string",
  "paymentGatewayId": "string",
  "name": "string",
  "template": "string",
  "type": "string"
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/templates',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /templates

Permissions
CreateTemplate
14

Body parameter

1
2
3
4
5
6
7
{
  "id": "string",
  "paymentGatewayId": "string",
  "name": "string",
  "template": "string",
  "type": "string"
}

Parameters

Name In Type Required Description
body body NewTemplates false none

Example responses

200 Response

1
2
3
4
5
6
7
{
  "id": "string",
  "paymentGatewayId": "string",
  "name": "string",
  "template": "string",
  "type": "string"
}

Responses

Status Meaning Description Schema
200 OK Templates model instance Templates

TemplatesController.updateAll

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
const inputBody = '{
  "id": "string",
  "paymentGatewayId": "string",
  "name": "string",
  "template": "string",
  "type": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/templates',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
const fetch = require('node-fetch');
const inputBody = {
  "id": "string",
  "paymentGatewayId": "string",
  "name": "string",
  "template": "string",
  "type": "string"
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/templates',
{
  method: 'PATCH',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PATCH /templates

Permissions
UpdateTemplate
15

Body parameter

1
2
3
4
5
6
7
{
  "id": "string",
  "paymentGatewayId": "string",
  "name": "string",
  "template": "string",
  "type": "string"
}

Parameters

Name In Type Required Description
where query object false none
body body TemplatesPartial false none

Example responses

200 Response

1
2
3
{
  "count": 0
}

Responses

Status Meaning Description Schema
200 OK Templates PATCH success count loopback.Count

TemplatesController.find

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
const headers = {
  'Accept':'application/json'
};

fetch('/templates',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json'
};

fetch('/templates',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /templates

Permissions
ViewTemplate
16

Parameters

Name In Type Required Description
filter query templates.Filter1 false none

Example responses

200 Response

1
2
3
4
5
6
7
8
9
[
  {
    "id": "string",
    "paymentGatewayId": "string",
    "name": "string",
    "template": "string",
    "type": "string"
  }
]

Responses

Status Meaning Description Schema
200 OK Array of Templates model instances Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [TemplatesWithRelations] false none [(tsType: TemplatesWithRelations, schemaOptions: { includeRelations: true })]
» TemplatesWithRelations TemplatesWithRelations false none (tsType: TemplatesWithRelations, schemaOptions: { includeRelations: true })
»» id string true none none
»» paymentGatewayId string true none none
»» name string true none none
»» template string true none none
»» type string true none none

TransactionSubscriptionsController

TransactionSubscriptionsController.subscriptionTransactionsPay

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
const headers = {
  'Accept':'text/html'
};

fetch('/transactions/subscription/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
const fetch = require('node-fetch');

const headers = {
  'Accept':'text/html'
};

fetch('/transactions/subscription/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /transactions/subscription/{id}

Parameters

Name In Type Required Description
id path string true none

Example responses

302 Response

1
{}

Responses

Status Meaning Description Schema
302 Found Array of Transactions model instances Inline

Response Schema

Schemas

Orders

1
2
3
4
5
6
7
8
9
{
  "id": "string",
  "totalAmount": 0,
  "currency": "string",
  "status": "string",
  "paymentGatewayId": "string",
  "paymentmethod": "string",
  "metaData": {}
}

Orders

Properties

Name Type Required Restrictions Description
id string false none none
totalAmount number true none none
currency string true none none
status string true none none
paymentGatewayId string true none none
paymentmethod string false none none
metaData object false none none

NewOrders

1
2
3
4
5
6
7
8
9
{
  "id": "string",
  "totalAmount": 0,
  "currency": "string",
  "status": "string",
  "paymentGatewayId": "string",
  "paymentmethod": "string",
  "metaData": {}
}

NewOrders

Properties

Name Type Required Restrictions Description
id string false none none
totalAmount number true none none
currency string true none none
status string true none none
paymentGatewayId string true none none
paymentmethod string false none none
metaData object false none none

OrdersWithRelations

1
2
3
4
5
6
7
8
9
{
  "id": "string",
  "totalAmount": 0,
  "currency": "string",
  "status": "string",
  "paymentGatewayId": "string",
  "paymentmethod": "string",
  "metaData": {}
}

OrdersWithRelations

Properties

Name Type Required Restrictions Description
id string false none none
totalAmount number true none none
currency string true none none
status string true none none
paymentGatewayId string true none none
paymentmethod string false none none
metaData object false none none

OrdersPartial

1
2
3
4
5
6
7
8
9
{
  "id": "string",
  "totalAmount": 0,
  "currency": "string",
  "status": "string",
  "paymentGatewayId": "string",
  "paymentmethod": "string",
  "metaData": {}
}

OrdersPartial

Properties

Name Type Required Restrictions Description
id string false none none
totalAmount number false none none
currency string false none none
status string false none none
paymentGatewayId string false none none
paymentmethod string false none none
metaData object false none none

Transactions

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
{
  "id": "string",
  "amountPaid": 0,
  "currency": "string",
  "status": "string",
  "paidDate": "2019-08-24T14:15:22Z",
  "paymentGatewayId": "string",
  "orderId": "string",
  "res": {}
}

Transactions

Properties

Name Type Required Restrictions Description
id string true none none
amountPaid number true none none
currency string true none none
status string true none none
paidDate string(date-time) false none none
paymentGatewayId string false none none
orderId string false none none
res object false none none

NewTransactions

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
{
  "id": "string",
  "amountPaid": 0,
  "currency": "string",
  "status": "string",
  "paidDate": "2019-08-24T14:15:22Z",
  "paymentGatewayId": "string",
  "orderId": "string",
  "res": {}
}

NewTransactions

Properties

Name Type Required Restrictions Description
id string true none none
amountPaid number true none none
currency string true none none
status string true none none
paidDate string(date-time) false none none
paymentGatewayId string false none none
orderId string false none none
res object false none none

TransactionsWithRelations

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
{
  "id": "string",
  "amountPaid": 0,
  "currency": "string",
  "status": "string",
  "paidDate": "2019-08-24T14:15:22Z",
  "paymentGatewayId": "string",
  "orderId": "string",
  "res": {}
}

TransactionsWithRelations

Properties

Name Type Required Restrictions Description
id string true none none
amountPaid number true none none
currency string true none none
status string true none none
paidDate string(date-time) false none none
paymentGatewayId string false none none
orderId string false none none
res object false none none

TransactionsPartial

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
{
  "id": "string",
  "amountPaid": 0,
  "currency": "string",
  "status": "string",
  "paidDate": "2019-08-24T14:15:22Z",
  "paymentGatewayId": "string",
  "orderId": "string",
  "res": {}
}

TransactionsPartial

Properties

Name Type Required Restrictions Description
id string false none none
amountPaid number false none none
currency string false none none
status string false none none
paidDate string(date-time) false none none
paymentGatewayId string false none none
orderId string false none none
res object false none none

PaymentGateways

1
2
3
4
5
6
{
  "id": "string",
  "name": "string",
  "gatewayType": "string",
  "enabled": true
}

PaymentGateways

Properties

Name Type Required Restrictions Description
id string true none none
name string true none none
gatewayType string true none none
enabled boolean true none none

NewPaymentGateways

1
2
3
4
5
6
{
  "id": "string",
  "name": "string",
  "gatewayType": "string",
  "enabled": true
}

NewPaymentGateways

Properties

Name Type Required Restrictions Description
id string true none none
name string true none none
gatewayType string true none none
enabled boolean true none none

PaymentGatewaysWithRelations

1
2
3
4
5
6
{
  "id": "string",
  "name": "string",
  "gatewayType": "string",
  "enabled": true
}

PaymentGatewaysWithRelations

Properties

Name Type Required Restrictions Description
id string true none none
name string true none none
gatewayType string true none none
enabled boolean true none none

PaymentGatewaysPartial

1
2
3
4
5
6
{
  "id": "string",
  "name": "string",
  "gatewayType": "string",
  "enabled": true
}

PaymentGatewaysPartial

Properties

Name Type Required Restrictions Description
id string false none none
name string false none none
gatewayType string false none none
enabled boolean false none none

Templates

1
2
3
4
5
6
7
{
  "id": "string",
  "paymentGatewayId": "string",
  "name": "string",
  "template": "string",
  "type": "string"
}

Templates

Properties

Name Type Required Restrictions Description
id string true none none
paymentGatewayId string true none none
name string true none none
template string true none none
type string true none none

NewTemplates

1
2
3
4
5
6
7
{
  "id": "string",
  "paymentGatewayId": "string",
  "name": "string",
  "template": "string",
  "type": "string"
}

NewTemplates

Properties

Name Type Required Restrictions Description
id string true none none
paymentGatewayId string true none none
name string true none none
template string true none none
type string true none none

TemplatesWithRelations

1
2
3
4
5
6
7
{
  "id": "string",
  "paymentGatewayId": "string",
  "name": "string",
  "template": "string",
  "type": "string"
}

TemplatesWithRelations

Properties

Name Type Required Restrictions Description
id string true none none
paymentGatewayId string true none none
name string true none none
template string true none none
type string true none none

TemplatesPartial

1
2
3
4
5
6
7
{
  "id": "string",
  "paymentGatewayId": "string",
  "name": "string",
  "template": "string",
  "type": "string"
}

TemplatesPartial

Properties

Name Type Required Restrictions Description
id string false none none
paymentGatewayId string false none none
name string false none none
template string false none none
type string false none none

Subscriptions

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
{
  "id": "string",
  "totalAmount": 0,
  "currency": "string",
  "status": "string",
  "paymentGatewayId": "string",
  "paymentMethod": "string",
  "metaData": {},
  "startDate": "2019-08-24T14:15:22Z",
  "endDate": "2019-08-24T14:15:22Z",
  "gatewaySubscriptionId": "string",
  "planId": "string"
}

Subscriptions

Properties

Name Type Required Restrictions Description
id string true none none
totalAmount number true none none
currency string false none none
status string true none none
paymentGatewayId string false none none
paymentMethod string false none none
metaData object false none none
startDate string(date-time) false none none
endDate string(date-time) false none none
gatewaySubscriptionId string false none none
planId string false none none

NewSubscriptions

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
{
  "id": "string",
  "totalAmount": 0,
  "currency": "string",
  "status": "string",
  "paymentGatewayId": "string",
  "paymentMethod": "string",
  "metaData": {},
  "startDate": "2019-08-24T14:15:22Z",
  "endDate": "2019-08-24T14:15:22Z",
  "gatewaySubscriptionId": "string",
  "planId": "string"
}

NewSubscriptions

Properties

Name Type Required Restrictions Description
id string true none none
totalAmount number true none none
currency string false none none
status string true none none
paymentGatewayId string false none none
paymentMethod string false none none
metaData object false none none
startDate string(date-time) false none none
endDate string(date-time) false none none
gatewaySubscriptionId string false none none
planId string false none none

SubscriptionsWithRelations

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
{
  "id": "string",
  "totalAmount": 0,
  "currency": "string",
  "status": "string",
  "paymentGatewayId": "string",
  "paymentMethod": "string",
  "metaData": {},
  "startDate": "2019-08-24T14:15:22Z",
  "endDate": "2019-08-24T14:15:22Z",
  "gatewaySubscriptionId": "string",
  "planId": "string"
}

SubscriptionsWithRelations

Properties

Name Type Required Restrictions Description
id string true none none
totalAmount number true none none
currency string false none none
status string true none none
paymentGatewayId string false none none
paymentMethod string false none none
metaData object false none none
startDate string(date-time) false none none
endDate string(date-time) false none none
gatewaySubscriptionId string false none none
planId string false none none

SubscriptionsPartial

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
{
  "id": "string",
  "totalAmount": 0,
  "currency": "string",
  "status": "string",
  "paymentGatewayId": "string",
  "paymentMethod": "string",
  "metaData": {},
  "startDate": "2019-08-24T14:15:22Z",
  "endDate": "2019-08-24T14:15:22Z",
  "gatewaySubscriptionId": "string",
  "planId": "string"
}

SubscriptionsPartial

Properties

Name Type Required Restrictions Description
id string false none none
totalAmount number false none none
currency string false none none
status string false none none
paymentGatewayId string false none none
paymentMethod string false none none
metaData object false none none
startDate string(date-time) false none none
endDate string(date-time) false none none
gatewaySubscriptionId string false none none
planId string false none none

loopback.Count

1
2
3
{
  "count": 0
}

loopback.Count

Properties

Name Type Required Restrictions Description
count number false none none

orders.Filter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
{
  "offset": 0,
  "limit": 100,
  "skip": 0,
  "order": "string",
  "fields": {
    "id": true,
    "totalAmount": true,
    "currency": true,
    "status": true,
    "paymentGatewayId": true,
    "paymentmethod": true,
    "metaData": true
  }
}

orders.Filter

Properties

Name Type Required Restrictions Description
offset integer false none none
limit integer false none none
skip integer false none none
order any false none none

oneOf

Name Type Required Restrictions Description
» anonymous string false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

continued

Name Type Required Restrictions Description
fields any false none none

oneOf

Name Type Required Restrictions Description
» anonymous object false none none
»» id boolean false none none
»» totalAmount boolean false none none
»» currency boolean false none none
»» status boolean false none none
»» paymentGatewayId boolean false none none
»» paymentmethod boolean false none none
»» metaData boolean false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

orders.Filter1

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
{
  "offset": 0,
  "limit": 100,
  "skip": 0,
  "order": "string",
  "where": {},
  "fields": {
    "id": true,
    "totalAmount": true,
    "currency": true,
    "status": true,
    "paymentGatewayId": true,
    "paymentmethod": true,
    "metaData": true
  }
}

orders.Filter

Properties

Name Type Required Restrictions Description
offset integer false none none
limit integer false none none
skip integer false none none
order any false none none

oneOf

Name Type Required Restrictions Description
» anonymous string false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

continued

Name Type Required Restrictions Description
where object false none none
fields any false none none

oneOf

Name Type Required Restrictions Description
» anonymous object false none none
»» id boolean false none none
»» totalAmount boolean false none none
»» currency boolean false none none
»» status boolean false none none
»» paymentGatewayId boolean false none none
»» paymentmethod boolean false none none
»» metaData boolean false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

paymentgateways.Filter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
  "offset": 0,
  "limit": 100,
  "skip": 0,
  "order": "string",
  "fields": {
    "id": true,
    "name": true,
    "gatewayType": true,
    "enabled": true
  }
}

paymentgateways.Filter

Properties

Name Type Required Restrictions Description
offset integer false none none
limit integer false none none
skip integer false none none
order any false none none

oneOf

Name Type Required Restrictions Description
» anonymous string false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

continued

Name Type Required Restrictions Description
fields any false none none

oneOf

Name Type Required Restrictions Description
» anonymous object false none none
»» id boolean false none none
»» name boolean false none none
»» gatewayType boolean false none none
»» enabled boolean false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

paymentgateways.Filter1

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
{
  "offset": 0,
  "limit": 100,
  "skip": 0,
  "order": "string",
  "where": {},
  "fields": {
    "id": true,
    "name": true,
    "gatewayType": true,
    "enabled": true
  }
}

paymentgateways.Filter

Properties

Name Type Required Restrictions Description
offset integer false none none
limit integer false none none
skip integer false none none
order any false none none

oneOf

Name Type Required Restrictions Description
» anonymous string false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

continued

Name Type Required Restrictions Description
where object false none none
fields any false none none

oneOf

Name Type Required Restrictions Description
» anonymous object false none none
»» id boolean false none none
»» name boolean false none none
»» gatewayType boolean false none none
»» enabled boolean false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

PingResponse

1
2
3
4
5
6
7
8
{
  "greeting": "string",
  "date": "string",
  "url": "string",
  "headers": {
    "Content-Type": "string"
  }
}

PingResponse

Properties

Name Type Required Restrictions Description
greeting string false none none
date string false none none
url string false none none
headers object false none none
» Content-Type string false none none

subscriptions.Filter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
  "offset": 0,
  "limit": 100,
  "skip": 0,
  "order": "string",
  "fields": {
    "id": true,
    "totalAmount": true,
    "currency": true,
    "status": true,
    "paymentGatewayId": true,
    "paymentMethod": true,
    "metaData": true,
    "startDate": true,
    "endDate": true,
    "gatewaySubscriptionId": true,
    "planId": true
  }
}

subscriptions.Filter

Properties

Name Type Required Restrictions Description
offset integer false none none
limit integer false none none
skip integer false none none
order any false none none

oneOf

Name Type Required Restrictions Description
» anonymous string false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

continued

Name Type Required Restrictions Description
fields any false none none

oneOf

Name Type Required Restrictions Description
» anonymous object false none none
»» id boolean false none none
»» totalAmount boolean false none none
»» currency boolean false none none
»» status boolean false none none
»» paymentGatewayId boolean false none none
»» paymentMethod boolean false none none
»» metaData boolean false none none
»» startDate boolean false none none
»» endDate boolean false none none
»» gatewaySubscriptionId boolean false none none
»» planId boolean false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

subscriptions.Filter1

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
{
  "offset": 0,
  "limit": 100,
  "skip": 0,
  "order": "string",
  "where": {},
  "fields": {
    "id": true,
    "totalAmount": true,
    "currency": true,
    "status": true,
    "paymentGatewayId": true,
    "paymentMethod": true,
    "metaData": true,
    "startDate": true,
    "endDate": true,
    "gatewaySubscriptionId": true,
    "planId": true
  }
}

subscriptions.Filter

Properties

Name Type Required Restrictions Description
offset integer false none none
limit integer false none none
skip integer false none none
order any false none none

oneOf

Name Type Required Restrictions Description
» anonymous string false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

continued

Name Type Required Restrictions Description
where object false none none
fields any false none none

oneOf

Name Type Required Restrictions Description
» anonymous object false none none
»» id boolean false none none
»» totalAmount boolean false none none
»» currency boolean false none none
»» status boolean false none none
»» paymentGatewayId boolean false none none
»» paymentMethod boolean false none none
»» metaData boolean false none none
»» startDate boolean false none none
»» endDate boolean false none none
»» gatewaySubscriptionId boolean false none none
»» planId boolean false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

templates.Filter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
{
  "offset": 0,
  "limit": 100,
  "skip": 0,
  "order": "string",
  "fields": {
    "id": true,
    "paymentGatewayId": true,
    "name": true,
    "template": true,
    "type": true
  }
}

templates.Filter

Properties

Name Type Required Restrictions Description
offset integer false none none
limit integer false none none
skip integer false none none
order any false none none

oneOf

Name Type Required Restrictions Description
» anonymous string false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

continued

Name Type Required Restrictions Description
fields any false none none

oneOf

Name Type Required Restrictions Description
» anonymous object false none none
»» id boolean false none none
»» paymentGatewayId boolean false none none
»» name boolean false none none
»» template boolean false none none
»» type boolean false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

templates.Filter1

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
  "offset": 0,
  "limit": 100,
  "skip": 0,
  "order": "string",
  "where": {},
  "fields": {
    "id": true,
    "paymentGatewayId": true,
    "name": true,
    "template": true,
    "type": true
  }
}

templates.Filter

Properties

Name Type Required Restrictions Description
offset integer false none none
limit integer false none none
skip integer false none none
order any false none none

oneOf

Name Type Required Restrictions Description
» anonymous string false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

continued

Name Type Required Restrictions Description
where object false none none
fields any false none none

oneOf

Name Type Required Restrictions Description
» anonymous object false none none
»» id boolean false none none
»» paymentGatewayId boolean false none none
»» name boolean false none none
»» template boolean false none none
»» type boolean false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

transactions.Filter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
{
  "offset": 0,
  "limit": 100,
  "skip": 0,
  "order": "string",
  "fields": {
    "id": true,
    "amountPaid": true,
    "currency": true,
    "status": true,
    "paidDate": true,
    "paymentGatewayId": true,
    "orderId": true,
    "res": true
  }
}

transactions.Filter

Properties

Name Type Required Restrictions Description
offset integer false none none
limit integer false none none
skip integer false none none
order any false none none

oneOf

Name Type Required Restrictions Description
» anonymous string false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

continued

Name Type Required Restrictions Description
fields any false none none

oneOf

Name Type Required Restrictions Description
» anonymous object false none none
»» id boolean false none none
»» amountPaid boolean false none none
»» currency boolean false none none
»» status boolean false none none
»» paidDate boolean false none none
»» paymentGatewayId boolean false none none
»» orderId boolean false none none
»» res boolean false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

transactions.Filter1

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
{
  "offset": 0,
  "limit": 100,
  "skip": 0,
  "order": "string",
  "where": {},
  "fields": {
    "id": true,
    "amountPaid": true,
    "currency": true,
    "status": true,
    "paidDate": true,
    "paymentGatewayId": true,
    "orderId": true,
    "res": true
  }
}

transactions.Filter

Properties

Name Type Required Restrictions Description
offset integer false none none
limit integer false none none
skip integer false none none
order any false none none

oneOf

Name Type Required Restrictions Description
» anonymous string false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

continued

Name Type Required Restrictions Description
where object false none none
fields any false none none

oneOf

Name Type Required Restrictions Description
» anonymous object false none none
»» id boolean false none none
»» amountPaid boolean false none none
»» currency boolean false none none
»» status boolean false none none
»» paidDate boolean false none none
»» paymentGatewayId boolean false none none
»» orderId boolean false none none
»» res boolean false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none