get https://api.zondacryptopay.com/rest/pay/payments//details
Returns all available information about the initiated payment.
Response details:
Key | Type | Description |
---|---|---|
paymentId | UUID | Unique payment identifier. |
orderId | string | ID provided during payment creation; usually ID of the transaction in merchant’s system. |
serverTime | timestamp (ms) | Server time at the request execution moment. |
creationTimestamp | timestamp (ms) | Time when payment has been created. |
completedTimestamp | timestamp (ms) | Time when payment has been completed. |
expirationTimestamp | timestamp (ms) | Time when payment is expired. |
expired | boolean | Is payment gate already expired. If true payment can be reopened and the amount to be paid will be recalculated. |
cryptoAddress | string | Cryptocurrency address where funds should be sent. |
sandbox | boolean | Boolean flag informing whether payment was created in sandbox/test mode; sandbox payments should not be accepted in production environment |
status | string | Current payment status. List of all possible statuses is listed below. |
amountInSourceCurrency | decimal | Payment value expressed in source currency. |
sourceCurrency | string | Currency in which the funds were received. |
amountInDestinationCurrency | decimal | Full payment value expressed in destinationCurrency. |
destinationCurrency | string | Currency in which payment value is specified. |
channelName | string | Channel used to transfer the source currency. |
alreadyPaidAmount | decimal | Amount of cryptocurrency funds that were already sent to the payment address. Shows full value regardless of transaction confirmations in network. |
remainingAmountToPay | decimal | The amount left for the payment to be fully paid, expressed in sourceCurrency. |
transactions | array | List of cryptocurrency transactions seen in network. |
* confirmations | integer | The number of confirmations in network. |
* created | timestamp (ms) | Transaction payment time. |
* id | string | Identifier of the transaction. |
* updated | timestamp (ms) | Last update time for the transaction. |
* value | decimal | Value of the transaction. |
* status | string | Status of the transaction in zonda |
* txId | string | Transaction hash from crypto network |
* transactionLink | string | URL to crypto network specific explorer with information about this transaction |
requestValues | object | Object with parameters used to initiate payment. |
resetable | boolean | Is payment eligible for reset |
List of possible payment statuses:
status | opis |
---|---|
PENDING | Initial payment status, waiting for funds transfer. |
IN_PROGRESS | Cryptocurrency transactions for required amount were seen in network, but do not have enough confirmations. Payment in this status can not be accepted yet. |
PAID | Cryptocurrency transactions for required amount reached confirmations number configured in store settings. There is still a tiny chance that funds may not be added to merchant’s account. Payment can be accepted on your own risk. |
COMPLETED | Cryptocurrency transactions for required amount reached maximum number of confirmations, required by zondacrypto pay. Funds were added to merchants account and payment with this status can be accepted with no risk. |
REFUNDED | Funds from the payment were returned to the customer. This happens when payment is underpaid. |
RESET | Customer reset payment currency on payment gate and did not select a new one yet. |
EXPIRED | Payment that has not been paid and it's lifetime expired (default: 7 days since the creation). Payment can no longer be re-opened nor completed. |