Get payout activity
curl --request GET \
--url https://api.interchange.io/api/v2/billing/payout-activity \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.interchange.io/api/v2/billing/payout-activity"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.interchange.io/api/v2/billing/payout-activity', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"rows": [
{
"kind": "setup",
"reason": "updated",
"description": "<string>",
"actorEmail": "<string>",
"occurredAt": "2023-11-07T05:31:56Z"
}
]
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}Storefront Billing
Get payout activity
Payout activity for the caller’s org (status, period, legal entity, currency, amount, expected/paid date). Currently always { rows: [] } — no payout run has produced an artifact yet.
GET
/
billing
/
payout-activity
Get payout activity
curl --request GET \
--url https://api.interchange.io/api/v2/billing/payout-activity \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.interchange.io/api/v2/billing/payout-activity"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.interchange.io/api/v2/billing/payout-activity', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"rows": [
{
"kind": "setup",
"reason": "updated",
"description": "<string>",
"actorEmail": "<string>",
"occurredAt": "2023-11-07T05:31:56Z"
}
]
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}Authorizations
API key or access token
Query Parameters
Direct child customer to read or update from an authorized parent billing organization
Pattern:
^[1-9][0-9]*$Response
Get payout activity
Payout activity for the caller’s org, newest first. setup rows (payout-details changes) appear as soon as they happen; ledger rows appear once a payout run has produced at least one artifact.
One setup/audit row in payout activity: payout bank details were added, updated, or cleared. Projected from the payout-details audit trail — never carries payout values.
- Option 1
- Option 2
Show child attributes
Show child attributes