πGet business payments
Fetch payments for a business.
Authorizations
Path parameters
businessIdstring Β· uuidRequired
ID of the business.
Query parameters
paymentIdstring Β· uuidOptional
Payment id.
transactionHashstringOptional
Transaction Hash.
clientPaymentIdstringOptional
Payment id provided by the client.
fromTxAddressstringOptionalExample:
Sending address.
bc1qz0m3ynhmmqkzx8tna7g8p6zkhzp9ssakqgayu6
walletTxAddressstringOptionalExample:
Receiving address.
bc1qz0m3ynhmmqkzx8tna7g8p6zkhzp9ssakqgayu6
afterstring Β· date-timeOptionalExample:
Payment creation date range start, in UNIX seconds, inclusive.
1702894529
beforestring Β· date-timeOptionalExample:
Payment creation date range end, in UNIX seconds, exclusive.
1702894529
limitinteger Β· max: 2000OptionalDefault:
Limit of the results per request.
25
Example: 25
Responses
200
Returns payments.
application/json
get
GET /api/v1/businesses/{businessId}/payments HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
200
Returns payments.
{
"payments": [
{
"paymentId": "e7eaa5c2-66bf-4944-b903-9e11efa59300",
"clientPaymentId": "label",
"businessId": "231cd908-65de-4f88-983e-83ba17102a6c",
"locale": "en-US",
"status": "EXPIRED",
"rateType": "FLOATING",
"type": "ONE_TIME",
"url": "https://casino.com/deposit/e7eaa5c2-66bf-4944-b903-9e11efa59300?locale=en-US&sessionToken=token",
"overpaymentPolicy": "EXCESS_REFUND",
"refundFollowUpDepositsForOneTimePayments": true,
"processorType": "BLOCKCHAIN",
"walletAddress": "0x464f0184fdA9566FB28Fee2AD3E05aa1F29f90f9",
"displayCurrency": "BGN",
"expectedDisplayAmount": "90",
"expectedDisplayDistributedUserServiceFee": "1.12",
"actualDisplayAmount": "0",
"actualDisplayDistributedUserServiceFee": "0",
"depositCurrency": "USDC",
"expectedNetwork": "BSC",
"expectedDepositAmount": "50",
"expectedDepositDistributedUserServiceFee": "0.00000005",
"actualDepositAmount": "0",
"actualDepositDistributedUserServiceFee": "0",
"expectedUniformAmount": "45",
"actualUniformAmount": "0",
"userServiceFeeDistributionPercentage": "1",
"expirationMinutes": 30,
"initiatedBy": "[email protected]",
"paymentInitiatedAt": 1696232400,
"paymentRequestedAt": 1696232700,
"redirectUrl": "https://my-business.com/account?id=3423",
"deposits": []
},
{
"paymentId": "e49220db-961b-4f32-a70c-459353c1c2cf",
"clientPaymentId": "example-label",
"businessId": "231cd908-65de-4f88-983e-83ba17102a6c",
"locale": "en-US",
"status": "OVERPAID",
"rateType": "FIXED",
"type": "ONE_TIME",
"url": "https://casino.com/deposit/e49220db-961b-4f32-a70c-459353c1c2cf?locale=en-US&sessionToken=token",
"overpaymentPolicy": "EXCESS_REFUND",
"refundFollowUpDepositsForOneTimePayments": true,
"processorType": "BLOCKCHAIN",
"walletAddress": "0xF9a1b3B79EAa9b48A4feb290dF9182DD7fEB6e2C",
"displayCurrency": "BGN",
"expectedDisplayAmount": "90",
"expectedDisplayDistributedUserServiceFee": "1.12",
"actualDisplayAmount": "17.24",
"actualDisplayDistributedUserServiceFee": "1.12",
"depositCurrency": "USDC",
"expectedNetwork": "BSC",
"expectedDepositAmount": "50",
"expectedDepositDistributedUserServiceFee": "0.00000005",
"actualDepositAmount": "50",
"actualDepositDistributedUserServiceFee": "0.00000005",
"expectedUniformAmount": "45",
"actualUniformAmount": "19.24",
"userServiceFeeDistributionPercentage": "1",
"redirectUrl": "https://my-business.com/account?id=3423",
"expirationMinutes": 30,
"initiatedBy": "[email protected]",
"paymentInitiatedAt": 1696232400,
"paymentRequestedAt": 1696232700,
"deposits": [
{
"id": "4e3ee4d6-0402-42e4-8e1d-a250211da571",
"transactionId": "0x499a0e359bb0326347bf05c890081352f0ee975e090ae453c6ff722b4c190b56",
"status": "CONFIRMED",
"fromAddress": "0x6BECc5be7594C007073Dba5feC8ebA421621d450",
"toAddress": "0x464f0184fdA9566FB28Fee2AD3E05aa1F29f90f9",
"addressRiskAssessment": {
"addressOwner": {
"category": "Unknown",
"name": "Unknown"
},
"destinationRiskEntities": [],
"sourceRiskEntities": []
},
"depositCurrency": "USDC",
"network": "BSC",
"depositAmount": "50",
"depositDistributedUserServiceFee": "0.00000005",
"onChainFee": "1.12341341",
"displayCurrency": "BGN",
"displayAmount": "17.24",
"displayPayableAmount": "14.12",
"displayServiceFee": "3.12",
"displayDistributedUserServiceFee": "1.12",
"settlementCurrency": "GBP",
"settlementPayableAmount": "1",
"settlementServiceFee": "1",
"settlementDistributedUserServiceFee": "1",
"uniformCurrency": "EUR",
"uniformPayableAmount": "15.12",
"uniformServiceFee": "4.12",
"uniformDistributedUserServiceFee": "0.62",
"userServiceFeeDistributionPercentage": "1",
"depositReceivedAt": 1696232460,
"refund": {
"transactionId": "0x0534194a4c630c5f4ade179d5451802c22be28cce126a8f0612fe65c338a540d",
"type": "PARTIAL",
"status": "CONFIRMED",
"reason": "OVERPAYMENT",
"depositCurrency": "USDC",
"network": "BSC",
"amount": "5.5593776",
"fee": "0.00000141",
"displayCurrency": "BGN",
"displayAmount": "34.58",
"displayFee": "12.13",
"confirmedAt": 1696232640
}
}
]
}
]
}
Last updated
Was this helpful?