Sign in
Deposits

List deposits

Lists deposits for the merchant with cursor-based pagination.

get/v1/deposits

Query parameters

limitinteger

Number of results per page (1-100). Defaults to 10.

cursorstring

Opaque cursor from a previous next_cursor.

status'received' | 'in_return' | 'returned' | 'return_failed' | 'return_returned'

Filter by deposit status.

created_at.gtestring date-time

Include deposits whose created_at is greater than or equal to this ISO 8601 timestamp.

created_at.ltestring date-time

Include deposits whose created_at is less than or equal to this ISO 8601 timestamp.

Response

Paginated list of deposits

has_moreboolean required
next_cursorstring nullable required

Changes

Changed in 7 of the 30 revisions of this API.41314

  • 37109d1ed976217See the full diff
    • ▲

      added the pattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ to the query request parameter created_at.gte

      request-parameter-pattern-added

    • ▲

      added the pattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ to the query request parameter created_at.lte

      request-parameter-pattern-added

    • ●

      added the new undefined enum value to the data/items/rail response property for the response status 200

      response-property-enum-value-added

    • ○

      added subschema #1: IBAN subschema #2: UK Sort Code subschema #3: ABA subschema #4: Wallet to the data/items/source response property anyOf list for the response status 200

      response-property-any-of-added

    • ○

      removed subschema #1 subschema #2 subschema #3 subschema #4 from the data/items/source response property oneOf list for the response status 200

      response-property-one-of-removed

    • ○

      the data/items/created_at response's property pattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ was added for the status 200

      response-property-pattern-added

    • ○

      the data/items/destination_account_id response's property pattern ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$ was added for the status 200

      response-property-pattern-added

    • ○

      the data/items/id response's property pattern ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$ was added for the status 200

      response-property-pattern-added

    • ○

      the data/items/returns/items/ response's property pattern ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$ was added for the status 200

      response-property-pattern-added

    • ○

      the data/items/updated_at response's property pattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ was added for the status 200

      response-property-pattern-added

  • 3ed0a0aba68b4See the full diff
    • ○

      removed the BTC enum value from the data/items/currency response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the ETH enum value from the data/items/currency response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the POL enum value from the data/items/currency response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the SOL enum value from the data/items/currency response property for the response status 200

      response-property-enum-value-removed

  • d92a4abea6c43See the full diff
    • ●

      added the new ETH enum value to the data/items/currency response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new POL enum value to the data/items/currency response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new SOL enum value to the data/items/currency response property for the response status 200

      response-property-enum-value-added

  • 74deb4d45f9f151See the full diff
    • ▲

      added subschema #3 subschema #4 to the data/items/source response property oneOf list for the response status 200

      response-property-one-of-added

    • ●

      added the new BTC enum value to the data/items/currency response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new ach enum value to the data/items/rail response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new btc enum value to the data/items/rail response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new btc_testnet4 enum value to the data/items/rail response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new fedwire enum value to the data/items/rail response property for the response status 200

      response-property-enum-value-added

    • ○

      removed subschema #3 from the data/items/source response property oneOf list for the response status 200

      response-property-one-of-removed

  • 27d4428ba2db11See the full diff
    • ▲

      removed the enum value rejected from the query request parameter status

      request-parameter-enum-value-removed

    • ○

      removed the rejected enum value from the data/items/status response property for the response status 200

      response-property-enum-value-removed

  • 75f9878ced374See the full diff
    • ●

      added the new EUR enum value to the data/items/currency response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new GBP enum value to the data/items/currency response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new USD enum value to the data/items/currency response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new USDC enum value to the data/items/currency response property for the response status 200

      response-property-enum-value-added

  • 67983e71dc411See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog