🔒Fetch payments

Fetch payments for a business.

Request

Authorization

Add parameter in header

FRX-API

Example:

FRX-API: ********************

Path Params

string <uuid>

required

ID of the business.

Query Params

coins

array[string]

optional

Comma-separated list of cryptocurrencies.

Allowed values:

BCHBNBBTCETHLINKLTCSOLTRXUSDCUSDTXLMXRP

statuses

enum<string>

optional

Payment status.

Allowed values:

NEWPENDINGAWAITINGDEPOSITEDEXPIREDBLOCKEDOVERPAID

Example:

DEPOSITED

paymentId

string <uuid>

optional

Payment id.

clientPaymentId

string

optional

Payment id provided by the client.

fromTxAddress

string

optional

Sending address.

Example:

bc1qz0m3ynhmmqkzx8tna7g8p6zkhzp9ssakqgayu6

walletTxAddress

string

optional

Receiving address.

Example:

bc1qz0m3ynhmmqkzx8tna7g8p6zkhzp9ssakqgayu6

before

integer <int64>

optional

Payment creation date range start, in UNIX seconds, inclusive.

Example:

1702894529

after

integer <int64>

optional

Payment creation date range end, in UNIX seconds, exclusive.

Example:

1702894529

sortBy

string

optional

Sort parameter.

Default:

CREATED

Example:

CREATED

descending

string

optional

Sort the results in descending order.

Default:

true

Example:

true

limit

integer

optional

Limit of the results per request.

<= 2000

Default:

Example:

Responses

🟢200Returns payments.

application/json

Body

payments

array[object (DetailedPaymentResponse) {32}]

optional

paymentId

string <uuid>

required

clientPaymentId

string

required

Payment identifier provided by the merchant on payment creation.

businessId

string <uuid>

required

locale

string

required

Locale code.

status

enum<string>

required

Allowed values:

NEWPENDINGAWAITINGDEPOSITEDEXPIREDBLOCKEDOVERPAID

rateType

enum<string>

required

Allowed values:

FIXEDFLOATING

type

enum<string>

required

Allowed values:

ONE_TIMEREUSABLE

url

string <url>

required

Checkout link.

overpaymentPolicy

enum<string>

optional

Allowed values:

PROCESSEXCESS_REFUND

refundFollowUpDepositsForOneTimePayments

boolean

optional

processorType

enum<string>

required

Allowed value:

BLOCKCHAIN

walletAddress

string

optional

Wallet address where the cryptocurrency amount should be deposited.

destinationTag

string

optional

XLM/XRP destination tag.

displayCurrency

enum<string>

optional

Fiat currency.

Allowed values:

AEDARSAUDBDTBGNBRLCADCHFCLPCNYCZKDKKEURGBPHKDHRKHUFIDRILSINRISKJPYKESKRWMXNMYRNGNNOKNZDPENPHPPLNQARRONRUBSEKSGDTHBTRYUSDVNDZAR

expectedDisplayAmount

string

optional

Amount in displayCurrency requested for this payment.

expectedDisplayDistributedUserServiceFee

string

optional

Distributed service fee amount in displayCurrency requested for this payment.

actualDisplayAmount

string

required

Actual amount deposited in displayCurrency.

actualDisplayDistributedUserServiceFee

string

required

Actual distributed service fee amount in displayCurrency.

depositCurrency

enum<string>

optional

The selected cryptocurrency.

Allowed values:

BCHBNBBTCETHLINKLTCSOLTRXUSDCUSDTXLMXRP

expectedNetwork

enum<string>

optional

The selected network.

Allowed values:

BCHBTCLTCXLMXRPETHBSCSOLTRX

expectedDepositAmount

string

optional

Amount in depositCurrency to be deposited to fulfill the required amount in displayCurrency.

expectedDepositDistributedUserServiceFee

string

optional

Distributed service fee amount in depositCurrency requested for this payment.

actualDepositAmount

string

required

Actual amount deposited in depositCurrency by the end user.

actualDepositDistributedUserServiceFee

string

required

Actual distributed service fee amount in depositCurrency.

expectedUniformAmount

string

optional

Expected deposit amount in EUR.

actualUniformAmount

string

required

Actual amount deposited in EUR.

userServiceFeeDistributionPercentage

string

required

Percentage of the service fee covered by the user.

redirectUrl

string <url>

optional

Custom URL where the user will be redirected after payment completion.

expirationMinutes

integer <int64>

required

Timeframe in which the deposit should succeed.

>= 0

paymentInitiatedAt

integer <int64>

required

UNIX seconds at which the payment was initiated.

paymentRequestedAt

integer <int64>

optional

UNIX seconds at which the payment was requested.

deposits

array[object (DetailedDepositResponse) {28}]

required

Example

{
    "payments": [
        {
            "paymentId": "b66dc539-d323-4e56-9cf6-b8c3c761f403",
            "clientPaymentId": "Not updating amounts",
            "businessId": "407710f4-de33-454b-a47f-dda792e272c8",
            "locale": "en-US",
            "status": "EXPIRED",
            "rateType": "FLOATING",
            "type": "ONE_TIME",
            "url": "https://example.com/deposit/b66dc539-d323-4e56-9cf6-b8c3c761f403?theme=skilling&locale=en-US&sessionToken=eyJhbGciOiJIUzUxMiJ9.eyJidXNpbmVzc0lkIjoiNDA3NzEwZjQtZGUzMy00NTRiLWE0N2YtZGRhNzkyZTI3MmM4Iiwib3JnYW5pc2F0aW9uSWQiOiJjZjFlNjdkMC00NmY2LTRhMDAtODM3MC0wOTBhNTA4N2M4MGYiLCJpYXQiOjE2OTYyNDc2OTUsInBheW1lbnRJZCI6ImI2NmRjNTM5LWQzMjMtNGU1Ni05Y2Y2LWI4YzNjNzYxZjQwMyJ9.4EotVp2ooWK9PsT1GOYjisgCGmJVcXVOQXbxqFAz3MSzntoq22fjp7nnc7qjjMb0cd5bjGNcC6Vn64GPTxNsbQ",
            "overpaymentPolicy": "EXCESS_REFUND",
            "refundFollowUpDepositsForOneTimePayments": true,
            "processorType": "BLOCKCHAIN",
            "walletAddress": "bc1ql8tnegglq95c6x3khu6xm53tddr0n2nsukmq82",
            "displayCurrency": "EUR",
            "expectedDisplayAmount": "10000.00",
            "expectedDisplayDistributedUserServiceFee": "0.00",
            "actualDisplayAmount": "0.00",
            "actualDisplayDistributedUserServiceFee": "0.00",
            "depositCurrency": "BTC",
            "expectedNetwork": "BTC",
            "expectedDepositAmount": "0.37401328",
            "expectedDepositDistributedUserServiceFee": "0.00000000",
            "actualDepositAmount": "0",
            "actualDepositDistributedUserServiceFee": "0",
            "expectedUniformAmount": "10000.00",
            "actualUniformAmount": "0.00",
            "userServiceFeeDistributionPercentage": "0.00",
            "expirationMinutes": 10080,
            "paymentRequestedAt": 1696247708,
            "paymentInitiatedAt": 1696247695,
            "deposits": []
        },
        {
            "clientPaymentId": "payment-id-29-9",
            "paymentId": "e49220db-961b-4f32-a70c-459353c1c2cf",
            "businessId": "407710f4-de33-454b-a47f-dda792e272c8",
            "locale": "en-US",
            "status": "OVERPAID",
            "rateType": "FIXED",
            "type": "ONE_TIME",
            "url": "https://example.com/deposit/e49220db-961b-4f32-a70c-459353c1c2cf?theme=skilling&locale=en-US&sessionToken=eyJhbGciOiJIUzUxMiJ9.eyJidXNpbmVzc0lkIjoiNDA3NzEwZjQtZGUzMy00NTRiLWE0N2YtZGRhNzkyZTI3MmM4Iiwib3JnYW5pc2F0aW9uSWQiOiJjZjFlNjdkMC00NmY2LTRhMDAtODM3MC0wOTBhNTA4N2M4MGYiLCJpYXQiOjE2OTU5Nzg2MTksInBheW1lbnRJZCI6ImU0OTIyMGRiLTk2MWItNGYzMi1hNzBjLTQ1OTM1M2MxYzJjZiJ9.YghiO1S0X-2FXHszlZIrMfqi79TlTczVMA_ClBq0ZtbQKPXtkQMhilW3p8qEU0v_8TfdFADmi6MHUT5e4WpR8w",
            "overpaymentPolicy": "EXCESS_REFUND",
            "refundFollowUpDepositsForOneTimePayments": true,
            "processorType": "BLOCKCHAIN",
            "walletAddress": "ltc1qf403sgjyhs4v4d8tumlr9ffn0dzsudvam6ly4l",
            "displayCurrency": "EUR",
            "expectedDisplayAmount": "45.00",
            "expectedDisplayDistributedUserServiceFee": "0.00",
            "actualDisplayAmount": "45.00",
            "actualDisplayDistributedUserServiceFee": "0.00",
            "depositCurrency": "LTC",
            "expectedNetwork": "LTC",
            "expectedDepositAmount": "0.72714600",
            "expectedDepositDistributedUserServiceFee": "0.00000000",
            "actualDepositAmount": "0.72566918",
            "actualDepositDistributedUserServiceFee": "0.00000000",
            "expectedUniformAmount": "45.00",
            "actualUniformAmount": "45.00",
            "userServiceFeeDistributionPercentage": "0.00",
            "expirationMinutes": 30,
            "paymentRequestedAt": 1695978628,
            "paymentInitiatedAt": 1695978619,
            "deposits": [
                {
                    "id": "4e3ee4d6-0402-42e4-8e1d-a250211da571",
                    "transactionId": "f7bc2bfb2a0c6d982930c7936610d62985659e578738a44b250437bac471d15f",
                    "status": "CONFIRMED",
                    "fromAddress": "ltc1qtwcue0py8jzjyecky45303xqlyy4sltw28kpg3",
                    "toAddress": "ltc1qf403sgjyhs4v4d8tumlr9ffn0dzsudvam6ly4l",
                    "addressRiskAssessment": {
                        "addressOwner": {
                            "category": "Unknown",
                            "name": "Unknown"
                        },
                        "destinationRiskEntities": [],
                        "sourceRiskEntities": []
                    },
                    "depositCurrency": "LTC",
                    "network": "LTC",
                    "depositAmount": "0.72566918",
                    "depositDistributedUserServiceFee": "0.00000000",
                    "onChainFee": "0.00000277",
                    "displayCurrency": "EUR",
                    "displayAmount": "45.00",
                    "displayPayableAmount": "44.55",
                    "displayServiceFee": "0.45",
                    "displayDistributedUserServiceFee": "0.00",
                    "settlementCurrency": "EUR",
                    "settlementPayableAmount": "44.55",
                    "settlementServiceFee": "0.45",
                    "settlementDistributedUserServiceFee": "0.00",
                    "uniformCurrency": "EUR",
                    "uniformPayableAmount": "44.55",
                    "uniformServiceFee": "0.45",
                    "uniformDistributedUserServiceFee": "0.00",
                    "userServiceFeeDistributionPercentage": "0.00",
                    "depositReceivedAt": 1695978685,
                    "refund": {
                        "transactionId": "7fd6b12fbe43acd7cfbb0988278e03cd33d1f8a58adbae7673087a92549d105c",
                        "type": "PARTIAL",
                        "status": "CONFIRMED",
                        "reason": "OVERPAYMENT",
                        "depositCurrency": "LTC",
                        "network": "LTC",
                        "amount": "0.55937760",
                        "fee": "0.00000141",
                        "displayCurrency": "EUR",
                        "displayAmount": "34.58",
                        "displayFee": "0.00",
                        "confirmedAt": 1695979331
                    }
                }
            ]
        }
    ]
}

Request

Request samples

Responses