Skip to content

Commit

Permalink
Merge branch 'develop' into fix/7761-align-deposit-colors
Browse files Browse the repository at this point in the history
  • Loading branch information
jessy-p authored Mar 15, 2024
2 parents ed43d85 + 9e98720 commit 9d8c275
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 1 deletion.
4 changes: 4 additions & 0 deletions changelog/add-8346-deposits-overview-docs
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
Significance: minor
Type: update

Updated deposits API documentation to add default_external_accounts element
15 changes: 14 additions & 1 deletion docs/rest-api/source/includes/wp-api-v3/deposits.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,9 @@ Fetch an overview of account deposits for all deposit currencies. This includes
- `weekly_anchor` _string_ | _undefined_ - The day of the week that payments are paid out, e.g. `monday`.
- `monthly_anchor` _int_ | _undefined_ - The day of the month that payments are paid out. Specified as a number between 1–31. 29-31 will instead use the last day of a shorter month.
- `default_currency` _string_ - The default currency for the account.
- `default_external_accounts` _array_ - The default external payout accounts (deposit destinations) for the account.
- `currency` _string_ - The currency of the external account. e.g. `eur`, `chf`.
- `status` _string_ - The status of the external account. e.g. `new`, `errored`.

```shell
curl -X GET https://example.com/wp-json/wc/v3/payments/deposits/overview-all \
Expand Down Expand Up @@ -168,7 +171,17 @@ curl -X GET https://example.com/wp-json/wc/v3/payments/deposits/overview-all \
"interval": "weekly",
"weekly_anchor": "friday"
},
"default_currency": "eur"
"default_currency": "eur",
"default_external_accounts": [
{
"currency": "eur",
"status": "new"
},
{
"currency": "usd",
"status": "new"
}
]
}
}
```
Expand Down

0 comments on commit 9d8c275

Please sign in to comment.