Checking payment status

Request

You can check payment status using the REST API.

GET https://streampayments.app/api/v1/payment/<payment-id>
Content-Type: application/json

Response

In response, you will get PaymentObject which contains the following data

Parameter	Type	Description
payment_id	string	Unique payment ID in our system
addressdeprecated	string	Deprecated. Use addresses instead. STRM address on which customer should transfer money. This is temporary address which is created for each payment.
amountdeprecated	numeric string	Deprecated. Use addresses instead. Amount of payment in yoctoSTRM (1 STRM = 1024 yoctoSTRM)
addresses	​Array<CoinObject>​	List of supported coins with amount and addresses.
display_amountdeprecated	numeric string	Deprecated. Use addresses instead. Amount of payment in STRM
display_amount_usd	numeric string	Amount of payment in USD
display_amount_eur	numeric string	Amount of payment in EUR
local_currency	string	usd or eur. Default fiat currency for this payment.
network	string	Network in which payment is created. Could be testnet, mainnet, etc.
status	string	Status of payment: pending, completed, not_found.​If payment is expired, not_found will be returned.
name	string	Payment name
description	string	Payment description
return_url	string	URL where user will be redirected after successful payment
created_at	timestamp (RFC3339)	When payment was created
expiry_at	timestamp (RFC3339)	After this date, the link to the payment will be considered expired.Important: If the user has transferred money, the callback will still be sent to your server
processed_at	timestamp (RFC3339)	If payment.status == completed, this field would contain date of processing payment in our system
transaction_hash	string	only if payment.status == completed.​Hash of transaction sent by customer. If there was more than one transaction, the last successful one is returned. May appear with a delay of up to 10 minutes after successful payment processing
signer_id	string	only if payment.status == completed.​The wallet from which the payment was made. If there was more than one transaction, the last successful one is returned. May appear with a delay of up to 10 minutes after successful payment processing

Coin Object

Parameter	Type	Description
token	string	Name of token. For example, STRM. Supported tokens: STRM, USDC, SOL.
blockchain	string	Name of blockchain. Supported blockchains: strm.
contract	string	Please note, that STRM will have contract address wrap.near that should be ignored. Address of contract.
address	string	Address on which customer should transfer money. This is temporary address which is created for each payment.
icon	string	Link to coin icon.
amount	numeric string	Amount of payment in the smallest unit (for example, 1 STRM = 1024 yoctoSTRM). This value could be used in smart-contract calls.
displayAmount	numeric string	Human-readable amount of payment.

ÄResponse Example

{
    "payment_id": "LqaUrQimtgTe9iF3Knv8Ld",
    "network": "mainnet",
    "status": "completed",
    "address": "3659c6cf5c8138163330b9059148b62f405c7676b92e79562360b5853d5c55e5",
    "addresses": [
        {
            "blockchain": "Solana",
            "address": "3659c6cf5c8138163330b9059148b62f405c7676b92e79562360b5853d5c55e5",
            "contract": "wrap.strm",
            "token": "NEAR",
            "amount": "166389351081530800779973",
            "displayAmount": "0.16638",
            "icon": "https:\/\/pay.streampayments.app\/img\/currencies\/near.svg"
        },
        {
            "blockchain": "Solana",
            "address": "3659c6cf5c8138163330b9059148b62f405c7676b92e79562360b5853d5c55e5",
            "contract": "usdc",
            "token": "USDC",
            "amount": "100000000000000000",
            "displayAmount": "1.00",
            "icon": "https:\/\/pay.streampayments.app\/img\/currencies\/usn.svg"
        }
    ],
    "amount": "166389351081530800779973",
    "name": "Demo payment",
    "description": "",
    "display_amount_usd": "1.00",
    "display_amount_eur": "1.00",
    "display_amount": "0.16638",
    "return_url": "\/",
    "expiry_at": "2022-08-10T22:01:19+00:00",
    "created_at": "2022-08-10T21:51:19+00:00",
    "processed_at": "2022-08-10T21:52:40+00:00",
    "transaction_hash": "9HKiSMrjFvmT1Pb7bTCZ8XPUQukRfSyQ58WJCmfXyWgX",
    "signer_id": "mazanax.STRM"
}

Expired Response Example

{
    "payment_id":"K04kjeEi06Zq48NlH2Sl0H",
    "expiry_at":"2022-09-08T12:35:03+00:00",
    "return_url":"https:\/\/stream.finance",
    "created_at":"2022-09-08T12:25:03+00:00",
    "status":"not_found",
    "reason":"expired”
}