Баримт бичиг / API лавлах
Төлбөр шилжүүлэлт
Төлбөрийн багц ба арга.
GET/v1/workspaces/{workspaceId}/payout-batches
List payout batches, newest first.
Параметр (3)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|---|---|---|---|
workspaceId | path | string | тийм | |
page | query | integer (int32) | ||
pageSize | query | integer (int32) |
GET/v1/workspaces/{workspaceId}/payout-batches/{batchId}
One batch with its rows.
Параметр (2)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|---|---|---|---|
workspaceId | path | string | тийм | |
batchId | path | string | тийм |
GET/v1/workspaces/{workspaceId}/payout-reconciliation
Reconciliation totals and the mismatch report for a date range (R69).
Параметр (3)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|---|---|---|---|
workspaceId | path | string | тийм | |
from | query | string (date) | ||
to | query | string (date) |
GET/v1/workspaces/{workspaceId}/payout-statements
All statements of the program, filterable by partner and period (R83).
Параметр (6)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|---|---|---|---|
workspaceId | path | string | тийм | |
partnerId | query | string | ||
from | query | string (date) | ||
to | query | string (date) | ||
page | query | integer (int32) | ||
pageSize | query | integer (int32) |
GET/v1/workspaces/{workspaceId}/payouts
List payouts (R34).
Параметр (16)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|---|---|---|---|
workspaceId | path | string | тийм | |
status | query | string | Comma separated statuses. | |
partnerId | query | string | ||
batchId | query | string | ||
rowState | query | string | ||
tenantId | query | string | Partner's tenant id on the enrollment. | |
statementId | query | string | `pst_` statement (invoice) id. | |
invoiceId | query | string | ||
groupId | query | string | Group of the partner's enrollment. | |
partnerTagId | query | string | Partner tag (`ptg_`) of the enrollment. | |
periodStart | query | string (date-time) | Payouts whose period ends on or after this instant. | |
periodEnd | query | string (date-time) | Payouts whose period starts on or before this instant. | |
sortBy | query | string | amount (default), initiatedAt, paidAt. | |
sortOrder | query | string | asc or desc (default). | |
page | query | integer (int32) | ||
pageSize | query | integer (int32) |
GET/v1/workspaces/{workspaceId}/payouts/summary
Payable balances and totals paid (R15).
Параметр (1)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|---|---|---|---|
workspaceId | path | string | тийм |
GET/v1/workspaces/{workspaceId}/payouts/{payoutId}
One payout with its commission lines; payout managers also see the full account.
Параметр (2)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|---|---|---|---|
workspaceId | path | string | тийм | |
payoutId | path | string | тийм |
GET/v1/workspaces/{workspaceId}/payouts/{payoutId}/proofs/{proofId}
Download a proof file.
Параметр (3)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|---|---|---|---|
workspaceId | path | string | тийм | |
payoutId | path | string | тийм | |
proofId | path | string | тийм |
GET/v1/workspaces/{workspaceId}/payouts/{payoutId}/statement
The statement of a completed payout (R78): JSON or a printable HTML page.
Параметр (3)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|---|---|---|---|
workspaceId | path | string | тийм | |
payoutId | path | string | тийм | |
format | query | string | json (default) or html. |
GET/v1/workspaces/{workspaceId}/program/payout-settings
Payout settings of the program (R39-R41).
Параметр (1)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|---|---|---|---|
workspaceId | path | string | тийм |