Skip to main content

PagedDepositResponse

meta objectrequired

meta data

skipnumber

number of skip records

Default value: 0
Example: 0
limitnumber

number of maximum return records

Default value: 10
Example: 10
totalCountnumberrequired

total number of records

Example: 100
timestampstring<date-time>required

the time of the query result

data object[]required

records

  • Array [
    • idstringrequired

    id of the deposit

    Example: fa664a60-e4f6-4aa2-8ffc-55fb229110ba
    clientIdstringrequired

    id of the client

    Example: fa664a60-e4f6-4aa2-8ffc-55fb229110ba
    accountIdstringrequired

    id of the virtual account

    Example: 65091ba9-649a-4625-8348-939334e7eca7
    currencyCodestringrequired

    Three letters deposit currency code

    Example: AUD
    amountnumberrequired

    The amount of the deposit

    Example: 1055.99
    typeDepositSettlementTypesrequired

    The type of the deposit

    Possible values: [WIRE TRANSFER, PAYID]

    Example: WIRE TRANSFER
    referenceNostringrequired

    Human readable deposit reference No

    Example: 20240726-FA8JZ4
    depositDatestringrequired

    Deposit date (in formart YYYY-MM-DD)

    Example: 2024-07-26
    notestring

    Deposit Reference

    Example: Invoice-123
    payer object

    The payer info of the deposit

    namestring

    payer name, it may be different from the account name

    Example: Abc
    amountnumber

    for non local payment, the origin payment amount may be differ from the received amount

    Example: 1055.99
    currencyCodestringrequired

    Three letters deposit currency code

    Example: AUD
    accountNamestring

    Bank account name

    Example: ABC
    accountNumberstring

    Bank account number

    Example: 123456
    routingNumberstring

    Bank account routing number

    Example: 123456
    valueDatestring

    The value date of the deposit

    Example: 2024-07-26T04:00:44.000Z
    createDatestring

    The create date of the deposit

    Example: 2024-07-26T04:00:44.000Z
    paymentReferencestring

    Payment reference

    Example: 512312
    additionalInfostring

    Payment description

    Example: 512312
    createdTimestringrequired

    Deposit creation time

    Example: 2024-07-26T03:58:13.000Z
    clientNamestring

    The name of client

    Example: abc
    statusDepositStatusesrequired

    The status of the deposit

    Possible values: [SCHEDULED, PENDING DIRECT DEBIT, DIRECT DEBIT PROCESSING, COMPLETED, CANCELLED, REJECTED, PENDING REFUND, REFUNDING, REFUNDED, REFUND REJECTED, REFUND CANCELLED]

    Example: COMPLETED
    updatedTimestringrequired

    Deposit last updated time

    Example: 2024-07-26T03:58:13.000Z
  • ]
    • PagedDepositResponse
    {
      "meta": {
        "skip": 0,
        "limit": 10,
        "totalCount": 100,
        "timestamp": "2024-07-29T15:51:28.071Z"
      },
      "data": [
        {
          "id": "fa664a60-e4f6-4aa2-8ffc-55fb229110ba",
          "clientId": "fa664a60-e4f6-4aa2-8ffc-55fb229110ba",
          "accountId": "65091ba9-649a-4625-8348-939334e7eca7",
          "currencyCode": "AUD",
          "amount": 1055.99,
          "type": "WIRE TRANSFER",
          "referenceNo": "20240726-FA8JZ4",
          "depositDate": "2024-07-26",
          "note": "Invoice-123",
          "payer": {
            "name": "Abc",
            "amount": 1055.99,
            "currencyCode": "AUD",
            "accountName": "ABC",
            "accountNumber": "123456",
            "routingNumber": "123456",
            "valueDate": "2024-07-26T04:00:44.000Z",
            "createDate": "2024-07-26T04:00:44.000Z",
            "paymentReference": "512312",
            "additionalInfo": "512312"
          },
          "createdTime": "2024-07-26T03:58:13.000Z",
          "clientName": "abc",
          "status": "COMPLETED",
          "updatedTime": "2024-07-26T03:58:13.000Z"
        }
      ]
    }