Methods
(async, inner) createChargeForBill(billId, data) → {Promise.<response>}
Create a new charge for a specific bill.
Parameters:
| Name | Type | Description |
|---|---|---|
billId |
string | ID of the bill. |
data |
object | The data to create the new charge. |
- Source:
Returns:
response to the request.
- Type
- Promise.<response>
(async, inner) createPaymentForBill(billId, data) → {Promise.<response>}
Create a new payment for a specific bill.
Parameters:
| Name | Type | Description |
|---|---|---|
billId |
string | ID of the bill. |
data |
object | The data to create the new payment. |
- Source:
Returns:
response to the request.
- Type
- Promise.<response>
(async, inner) getBillById(billId) → {Promise.<response>}
Get a specific bill given its ID.
Parameters:
| Name | Type | Description |
|---|---|---|
billId |
string | ID of the bill to retrieve. |
- Source:
Returns:
response to the request.
- Type
- Promise.<response>
(async, inner) getChargeByIdForBill(billId, chargeId) → {Promise.<response>}
Get a specific charge for a specific bill given its IDs.
Parameters:
| Name | Type | Description |
|---|---|---|
billId |
string | ID of the bill. |
chargeId |
string | ID of the charge. |
- Source:
Returns:
response to the request.
- Type
- Promise.<response>
(async, inner) getChargesForBill(billId) → {Promise.<response>}
Get all charges for a specific bill.
Parameters:
| Name | Type | Description |
|---|---|---|
billId |
string | ID of the bill. |
- Source:
Returns:
response to the request.
- Type
- Promise.<response>
(async, inner) getPaymentByIdForBill(billId, paymentId) → {Promise.<response>}
Get a specific payment for a specific bill given both IDs.
Parameters:
| Name | Type | Description |
|---|---|---|
billId |
string | ID of the bill. |
paymentId |
string | ID of the payment. |
- Source:
Returns:
response to the request.
- Type
- Promise.<response>
(async, inner) getPaymentsForBill(billId) → {Promise.<response>}
Get all payments for a specific bill.
Parameters:
| Name | Type | Description |
|---|---|---|
billId |
string | ID of the bill. |
- Source:
Returns:
response to the request.
- Type
- Promise.<response>
(async, inner) refundChargeByIdForBill(billId, chargeId) → {Promise.<response>}
Refund a specific charge for a specific bill.
Parameters:
| Name | Type | Description |
|---|---|---|
billId |
string | ID of the bill. |
chargeId |
string | ID of the charge to refund. |
- Source:
Returns:
response to the request.
- Type
- Promise.<response>
(async, inner) refundPaymentByIdForBill(billId, paymentId) → {Promise.<response>}
Refund a specific payment for a specific bill.
Parameters:
| Name | Type | Description |
|---|---|---|
billId |
string | ID of the bill. |
paymentId |
string | ID of the payment to refund. |
- Source:
Returns:
response to the request.
- Type
- Promise.<response>