ALalfredpay
Deposits

List what a virtual account has received

Changed on

A virtual account never holds a balance, so this list is the closest thing it has to one. It's the flow through the instrument rather than a position on it.

get/v1/virtual_accounts/{virtualAccountId}/deposits

Request

  • Base URL
    https://api.sandbox.alfredpay.io
  • URL
    https://api.sandbox.alfredpay.io/v1/virtual_accounts/{virtualAccountId}/deposits
  • Auth
    • HTTP bearer
    • or API key in header api-key and API key in header api-secret

Query parameters

transaction_status'CREATED' | 'PENDING_VALIDATION' | 'PENDING_FUNDS' | 'PENDING_COMPLIANCE' | 'PENDING_RFI' | 'APPROVED_FOR_EXECUTION' | 'PROCESSING' | 'COMPLETE' | 'FAILED' | 'CANCELLED' | 'BLOCKED'

Business lifecycle, customer-facing. Terminal values are COMPLETE, FAILED, CANCELLED, BLOCKED.

fromstring date-time
tostring date-time
limitinteger
cursorstring

Opaque. Pass next_cursor from the previous page.

Response

OK

has_moreboolean
next_cursorstring nullable

Example response

{
  "data": [
    {
      "amount": {
        "value": "10000.00"
      },
      "amounts": {
        "gross": {
          "value": "10000.00"
        },
        "net_credited": {
          "value": "10000.00"
        }
      },
      "converted": {
        "developerFee": {
          "value": "10000.00"
        }
      }
    }
  ]
}

Changes