🔒Get business deposits

Fetch payments

Fetch payments for a business.

GET/api/v1/businesses/{businessId}/payments

Authorization

ApiKeyAuth

Path parameters

businessId*string (uuid)

ID of the business.

Query parameters

Response

200

Returns payments.

Body

application/json

paymentsarray of DetailedPaymentResponse (object)

Request

JavaScriptCurl

const response = await fetch('/api/v1/businesses/{businessId}/payments', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "payments": [
    {
      "paymentId": "123e4567-e89b-12d3-a456-426614174000",
      "clientPaymentId": "text",
      "businessId": "123e4567-e89b-12d3-a456-426614174000",
      "locale": "text",
      "status": "NEW",
      "rateType": "FIXED",
      "type": "ONE_TIME",
      "url": "text",
      "overpaymentPolicy": "PROCESS",
      "refundFollowUpDepositsForOneTimePayments": false,
      "processorType": "BLOCKCHAIN",
      "walletAddress": "text",
      "destinationTag": "text",
      "displayCurrency": "AED",
      "expectedDisplayAmount": "text",
      "expectedDisplayDistributedUserServiceFee": "text",
      "actualDisplayAmount": "text",
      "actualDisplayDistributedUserServiceFee": "text",
      "depositCurrency": "BCH",
      "expectedNetwork": "BCH",
      "expectedDepositAmount": "text",
      "expectedDepositDistributedUserServiceFee": "text",
      "actualDepositAmount": "text",
      "actualDepositDistributedUserServiceFee": "text",
      "expectedUniformAmount": "text",
      "actualUniformAmount": "text",
      "userServiceFeeDistributionPercentage": "text",
      "redirectUrl": "text",
      "deposits": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "transactionId": "text",
          "status": "PENDING_AML",
          "fromAddress": "text",
          "toAddress": "text",
          "riskScore": "text",
          "addressRiskAssessment": {
            "addressOwner": {
              "name": "text",
              "category": "text"
            },
            "sourceRiskEntities": [
              {
                "name": "text",
                "category": "text"
              }
            ],
            "destinationRiskEntities": [
              {
                "name": "text",
                "category": "text"
              }
            ]
          },
          "depositCurrency": "BCH",
          "network": "BCH",
          "depositAmount": "text",
          "depositDistributedUserServiceFee": "text",
          "onChainFee": "text",
          "displayCurrency": "AED",
          "displayAmount": "text",
          "displayPayableAmount": "text",
          "displayServiceFee": "text",
          "displayDistributedUserServiceFee": "text",
          "settlementCurrency": "BTC",
          "settlementPayableAmount": "text",
          "settlementServiceFee": "text",
          "settlementDistributedUserServiceFee": "text",
          "uniformCurrency": "text",
          "uniformPayableAmount": "text",
          "uniformServiceFee": "text",
          "uniformDistributedUserServiceFee": "text",
          "userServiceFeeDistributionPercentage": "text",
          "refund": {
            "type": "PARTIAL",
            "status": "PENDING",
            "reason": "OVERPAYMENT",
            "depositCurrency": "BCH",
            "network": "BCH",
            "amount": "text",
            "fee": "text",
            "displayCurrency": "AED",
            "displayAmount": "text",
            "displayFee": "text",
            "transactionId": "text"
          }
        }
      ]
    }
  ]
}