Get Payment Details
On this page, you can find information on how to instantly retrieve the details and information of a created payment.
Fetching the created payment
The following information must be sent correctly and mandatorily. If any information is incorrect or all fields are sent empty, the system will return an error. You can see the possible errors at the bottom of the page.
Value | Type | Description |
---|---|---|
merchant_id | string | Your Merchant ID |
merchant_key | string | Your Merchant Key |
merchant_salt | string | Your Merchant Salt |
merhcant_oid | string | Your payment Order ID |
https://app.coinpays.io/api/get-payment?merchant_id=&merchant_key=&merchant_salt=&merchant_oid=
The response to the request is in JSON format:
Value | Type | Description |
---|---|---|
payment_status | string | Payment status. Expected values: completed - not_started - pending |
callback_status | string | Callback status: Expected values: comleted - null |
created_at | string | Indicates when the payment was created |
expired_at | string | Indicates when the payment will expire. Payments that are not completed after this period will be marked as expired. Payments must be made within this timeframe. |
transaction[token] | string | Unique transaction token. |
transaction[test_mode] | integer | Payment test mode status. 1 or 0 |
transaction[merchant_oid] | string | Unique merchant order ID |
transaction[wallet][wallet_currency] | string | Crypto token for transaction |
transaction[wallet][network] | string | Crypto token network for transaction |
transaction[wallet][wallet_amount] | float | Transaction amount in cryptocurrency token amount |
transaction[wallet][wallet_remaining_amount] | float | Total amount to be paid |
transaction[wallet][wallet_address] | string | Cryptocurrency wallet to which the payment will be made |
transaction[transfer][hash] | string | Unique id in coinpays |
transaction[transfer][value] | float | Formatted transfer amount |
transaction[transfer][remaining_amount] | float | Remaining amount to be paid after the transfer |
transaction[transfer][created_at] | string | Created At |
transaction[transfer][data][hash] | string | Transaction number on the cryptocurrency network. TXID |
transaction[transfer][data][value] | string | Unformatted payment amount |
transaction[transfer][data][formatted_value] | float | Formatted payment amount |
transaction[transfer][data][timeStamp] | integer | Unix timestamp of when the payment was confirmed |
transaction[transfer][data][from] | string | Wallet from which the payment was sent |
transaction[transfer][data][to] | string | Wallet to which the payment was made |
transaction[transfer][data][tokenSymbol] | string | Coin symbol of the payment. This symbol may be empty in some special cases, such as fee coins in certain crypto networks like ETH on ERC20 or TRX on TRC20. |
transaction[transfer][data][] | string | Information on how many decimal places the cryptocurrency token has |
transaction[transfer][data][confirmations] | integer | Information on how many validators have confirmed the payment. This may come as 0 in some networks, which does not mean the payment has not been made. Do not take this as proof of payment. |
transaction[currency][symbol] | string | Indicates the currency in which the payment was created. |
transaction[currency][payment_amount] | string | Indicates the unit amount in which the payment was created. |
transaction[user_info][user_name] | string | Contains the customer name provided by the store. |
transaction[user_info][user_address] | string | Contains the customer address provided by the store. |
transaction[user_info][user_phone] | string | Contains the customer phone provided by the store. |
transaction[user_info][user_ip] | string | Contains the customer ip provided by the store. |
Example response for completed transaction:
Example response for pending transaction [new created]:
Example response for pending transaction [partial payment]:
Errors
Error that will occur in case of missing data submission
Error that will occur when store information is incorrect
Error that occurs when the store order number is incorrect or does not exist
The error that will occur if the transaction status is "not_started". To access the details of the transaction, the transaction status must be "pending" or "completed".
Last updated