🔒Get payment data

Get deposit data

GET https://payments.finrax.com/api/v1/payments/:paymentId

Get payment details for a specific payment ID. Finrax payment ID is provided in the response of POST /payments

Path Parameters

Name	Type	Description
paymentId*	uuid	Unique Finrax payment ID

200 Successfully retrieved payment data

{
    "expectedUniformAmount": "13.00",
    "expectedDepositAmount": "0.08754164",
    "locale": "en-US",
    "expectedDisplayAmount": "15.00",
    "paymentInitiatedAt": 1634056128,
    "paymentRequestedAt": 1634056139,
    "actualDepositAmount": "0.08754164",
    "depositCurrency": "LTC",
    "expectedNetwork": "LTC",
    "actualDisplayAmount": "15.00",
    "expirationMinutes": 30,
    "paymentId": "4cd66dc4-1e81-4c4a-b74c-ab3d59a3febc",
    "walletAddress": "MEEnUHjjS1GjXiA8UiNMfnb9dQ4ZbyPJhY",
    "processorType": "BLOCKCHAIN",
    "displayCurrency": "USD",
    "businessId": "dab81a7a-2502-4784-ad34-87e04e5129f0",
    "deposits": [
        {
            "depositAmount": "0.08754164",
            "depositCurrency": "LTC",
            "depositReceivedAt": 1634056507,
            "displayAmount": "15.00000000",
            "displayCurrency": "USD",
            "status": "CONFIRMED",
            "fromAddress": "LZBRa7MJ4WZKqrigX1kW93xH4aGpNTd71U",
            "id": "ff4106d6-d6c7-31e9-8303-bbfda83c2f54",
            "onChainFee": "0.00000362",
            "refund": {
                "amount": "0.08245836",
                "confirmedAt": 1634056641,
                "displayAmount": "14.13",
                "displayCurrency": "USD",
                "displayFee": "0.17",
                "fee": "0.00100000",
                "reason": "OVERPAYMENT",
                "status": "CONFIRMED",
                "transactionId": "1f858f5c5268c9135459e21a9d711666140e31ac31304e73b591846f30fee217",
                "type": "PARTIAL"
            },
            "network": "LTC",
            "toAddress": "MEEnUHjjS1GjXiA8UiNMfnb9dQ4ZbyPJhY",
            "transactionId": "80d375925f268e3750b4198baf67d9ef78c649f610d286c84143bc807e628d5c"
        }
    ],
    "rateType": "FIXED",
    "status": "OVERPAID",
    "refundFollowUpDepositsForOneTimePayments": true,
    "ltc3Address": "382eAQKmUtRJjCtENqP1r9LkJhU7gksjGn",
    "type": "ONE_TIME",
    "overpaymentPolicy": "EXCESS_REFUND",
    "clientPaymentId": "testPayment"
}

Response schema

Parameter	Type	Description
actualDepositAmount	string [required]	Actual amount deposited in cryptocurrency by the end user
actualDisplayAmount	string [required]	Actual amount deposited in display currency EUR,USD,GBP
expectedNetwork	string [optional]	The expected network on which this deposit should occur
businessId	string [required]	Unique business identifier UUID
clientPaymentId	string [required]	Unique payment identifier provided by the merchant in the request body of POST /payments
depositCurrency	string [optional]	The selected cryptocurrency for this payment
deposits	array [required]	Array with all deposits for this payment (could be multiple)
depositAmount	string [required]	Amount deposited in cryptocurrency
depositCurrency	string [required]	Cryptocurrency that has been deposited
displayCurrency	string [required]	The fiat currency chosen for denomination purposes
depositReceivedAt	number [required]	Timestamp when the deposit was received UNIX
displayAmount	string [required]	Amount in display currency calculated at receive time
id	string [required]	Unique Finrax deposit identifier UUID
onChainFee	string [required]	Blockchain cost for this deposit paid by the end user
fromAddress	string [required]	The sending address of the transaction.
toAddress	string [required]	Your unique blockchain address supplied by Finrax where the deposit was received
transactionId	string [required]	Unique blockchain transaction ID of the deposit
status	string [required]	The status for this deposit only(not to be confused with the status for the entire payment). It might be CONFIRMED, PENDING_AML or BLOCKED
refund	object [optional]	In case of overpayments or follow-up transactions
type	string [required]	Could be one of: PARTIAL or FULL
status	string [required]	Could be one of: PENDING or CONFIRMED or NON_REFUNDABLE
reason	string [required]	Could be one of: OVERPAYMENT or FOLLOW_UP_DEPOSIT
amount	string [required]	Amount in cryptocurrency that needs to be refunded
fee	string [required]	On-chain fee in cryptocurrency
displayCurrency	string [required]	The fiat currency chosen for denomination purposes
displayAmount	string [required]	Amount in fiat currency that needs to be refunded
displayFee	string [required]	On-chain fee in displayCurrency
transactionId	string [optional]	Unique blockchain transaction hash of the refund
confirmedAt	number [optional]	Timestamp when the refund has been confirmed in UNIX
displayCurrency	string [optional]	The fiat currency chosen for denomination purposes
expectedDepositAmount	string [optional]	Amount in cryptocurrency to be deposited to fulfill the required amount in displayCurrency
expectedDisplayAmount	string [optional]	Amount in displayCurrency requested for this payment
expirationMinutes	number [required]	Timeframe in which the deposit should succeed
locale	string [required]	Language localisation abbreviation
paymentId	string [required]	Unique Finrax payment identifier UUID
paymentInitiatedAt	number [required]	Timestamp when the payment was initiated UNIX
paymentRequestedAt	number [optional]	Timestamp when the payment was requested UNIX
status	string [required]	Defines the status of the payment. Can be one of [NEW, PENDING, AWAITING, OVERPAID, EXPIRED, DEPOSITED]
redirectUrl	string [optional]	Custom URL where the user should get redirected after payment completion.
actualUniformAmount	string [optional]	Actual amount deposited in EUR
expectedUniformAmount	string [optional]	Expected deposit amount in EUR
destinationTag	string [optional]	Applicable for XRP and XLM
ltc3address	string [optional]	Legacy 3-prefix address for LTC
refundFollowUpDepositsForOneTimePayments	boolean [optional]	Payment configuration if follow-up deposits should be refunded.
overpaymentPolicy	string [optional]	Payment configuration for overpayments. Can be one of: EXCESS_REFUND or PROCESS
type	string [required]	Can be one of: REUSABLE or ONE_TIME
rateType	string [required]	Can be one of: FIXED or FLOATING
walletAddress	string [optional]	Unique wallet address generated by Finrax for this payment where the cryptocurrency amount should be deposited