public.virtual-accounts

List USD Account Deposits

Lists USD account deposits for the authenticated merchant

get/v1/virtual-account-deposits

Query parameters

limitinteger

Number of results per page (default: 50, max: 200)

pageinteger

Page number (default: 1)

customer_idstring

Filter by customer ID (UUID format)

virtual_account_idstring

Filter by virtual account ID (UUID format)

status'PENDING' | 'COMPLETED' | 'FLAGGED' | 'FAILED'

Filter by public status

fromstring

Filter deposits created from this time (RFC3339 format, inclusive)

tostring

Filter deposits created before this time (RFC3339 format, exclusive)

Response

OK

limitinteger
pageinteger
totalinteger
total_pagesinteger

Example response

{
  "data": [
    {
      "customer_amount": {
        "amount": "98.5000",
        "currency": "USD"
      },
      "developer_fee": {
        "amount": "1.5000",
        "currency": "USD",
        "percentage": "1.5"
      },
      "sender": {
        "account_number": "****1234",
        "bank_name": "Chase",
        "name": "Jane Doe"
      }
    }
  ]
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.