Skip to main content
GET
List customer USD virtual-account deposits

Authorizations

X-Yara-API-Key
string
header
required

Public merchant API key. You can also send Authorization: ApiKey .

Query Parameters

customer_id
string

Filter by merchant customer ID

virtual_account_id
string

Filter by virtual account ID

status
enum<string>

Deposit state

Available options:
RECEIVED,
PROCESSING,
COMPLETED,
FAILED,
REQUIRES_REVIEW,
REVERSED
provider_reference
string

Exact provider deposit reference

from
string

Created at or after this RFC3339 timestamp

to
string

Created before this RFC3339 timestamp

limit
integer

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

Required range: 1 <= x <= 200
page
integer

Page number (default: 1)

Required range: x >= 1

Response

OK

data
object[]
meta
object