Operation
Allows to pay a deposit.
Rw ui textbox macro | ||
---|---|---|
| ||
Only accessible with permission of pms.integration.billing |
Style |
---|
table { width: 100%; } body.page-gadget { padding-top: 20px; } .separator{ margin: 5px 0; } |
Div | ||
---|---|---|
| ||
PUT |
Div | ||
---|---|---|
| ||
https://{environment}.ulysescloud.com/public/api/{version}/con/chain/{chainId}/property/{propertyId}/deposit/{depositId}/payment |
Request
Property | Type | Required | Type parameter | Default value | Description |
---|---|---|---|---|---|
chainId | Integer | true | path parameter | ||
propertyId | Integer | true | path parameter | ||
depositId | Integer | true | path parameter |
Example request
Code Block | ||||
---|---|---|---|---|
| ||||
PUT https://publicapi-providers.ulysescloud.com:9797/public/api/v1/con/chain/1/property/1/deposit/1/payment |
Example body
Code Block | ||
---|---|---|
| ||
{ "amount": 100, "productPayment": { "id": 51, "chainProductId": 5, "code": "CASH", "name": "Cash", "nameI18n": "Cash", "productType": { "id": 3, "code": "PAY", "name": "Payment", "nameI18n": "Payment" } }, "currency": null } |
Response
A success or error message.
There are some errors that could arise when using this endpoint:
- ProductPayment is null: we do not allow this element to be null,
- Amount is null: amount always has to be sent in the body.
- Amount is not equal to Deposit amount: with this method the payment is unique for the Deposit so the amount has to be the exact amount of the Deposit.
- Other errors: check the ProductPaymentId and PropertyId that you're sending and be sure they are correct.
Example response
Code Block | ||
---|---|---|
| ||
{ "httpStatus": "201", "userMessage": "Success", "technicalMessage": "Success deposit paid out", "errorCode": "0", "moreInfo": "0", "id": 8, "entity": { ... }, "responseApiErrorList": null } |