Skip to content

Latest commit

 

History

History
25 lines (20 loc) · 2.73 KB

PaymentRequest.md

File metadata and controls

25 lines (20 loc) · 2.73 KB

PaymentRequest

Properties

Name Type Description Notes
currency CryptoCurrency [optional]
paymentId kotlin.String Unique identifier of the payment in selected currency [optional]
address kotlin.String One-use address for receive your client payment [optional]
pin kotlin.String PIN, it will be required if you need support with this payment.\ Note: It's provided only the first time you create the payment request [optional]
type kotlin.Int * `0: Receive and forward` payment is forwarded to a desired coin address once it's confirmed * `1: Receive and store` payment is stored in a payrobot.io wallet [optional]
amount kotlin.String The payment amount your client has to send to the coin address [optional]
callback kotlin.String URL where payrobot.io will send the status of the payment (Webhook) [optional]
feePct java.math.BigDecimal Fee percentage that will be discounted [optional]
feeAmount kotlin.String Fee amount that will be discounted [optional]
finalAmount kotlin.String Final amount of the transaction (Fee discount is already applied) * For `Receive and forward` payment is the total amount to `forward` as soon as the payment is confirmed * For `Receive and forward` payment is the total amount to `store` in the wallet as soon as the payment is confirmed [optional]
destination kotlin.String * For `Receive and forward` payment is the coin `ADDRESS` where the payment is going to be forwarded as soon as it's confirmed * For `Receive and store` payment is the `WALLET ID` where the payment is going to be stored as soon as it's confirmed [optional]
reference kotlin.String Custom reference for payment identifying [optional]
timestamp kotlin.Int Request creation date expressed in UNIX timestamp [optional]
lastupdate kotlin.Int Last update expressed in UNIX timestamp [optional]
status kotlin.Int Status of the payment: * `0: Idle` payment has not been paid * `1: Incomplete` payment is being paid partially * `2: Confirming` payment has been received completely but it's not confirmed by network yet * `3: Confirmed` payment has been paid completely and it has at least `1` confirmation by network [optional]
error kotlin.Boolean `true` is there was a problem. `false` if not [optional]