Payment

payment_summary

Endpoint: https://app.partnerboost.com/api.php?mod=medium&op=payment_summary

Provide either payment_id or both paid_date_begin and paid_date_end.

Key	Description
`token`	Channel API token
`payment_id`	Payment id (payment_id or paid_date_begin and paid_date_end are mandatory)
`paid_date_begin`	Paid date period. Format: YYYY-MM-DD (payment_id or paid_date_begin and paid_date_end are mandatory)
`paid_date_end`	Paid date period. Format: YYYY-MM-DD (payment_id or paid_date_begin and paid_date_end are mandatory)

Key	Description
`type`	Return format: `json` (default) or `xml`
`page`	Current page index
`limit`	Number of transactions shown per page - max 2000 transactions per page
`payment_currency`	The currency used when paying the commission for the brand to you. Available filter: USD, EUR, GBP. Multiple currencies separated by commas.

Key	Description
`payment_id`	The payment ID found under payment history
`request_date`	Date when the payment has been created. Format: YYYY-MM-DD
`paid_date`	Date when the payment is marked paid. Format: YYYY-MM-DD
`payment_type`	Payment type
`payment_details`	Account information
`invoice`	Invoice information
`Amount`	Payment amount
`payment_currency`	The currency used when paying the commission for the brand to you. Available Filter: USD, EUR, GBP. Multiple currencies separated by commas.

Request:

{
  "token": "YOUR_CHANNEL_TOKEN",
  "paid_date_begin": "2024-01-01",
  "paid_date_end": "2024-01-31"
}

Endpoint: https://app.partnerboost.com/api.php?mod=medium&op=payment_detail

Same as payment_summary: provide either payment_id or both paid_date_begin and paid_date_end.

Key	Description
`token`	Channel API token
`payment_id`	Payment id (payment_id or paid_date_begin and paid_date_end are mandatory)
`paid_date_begin`	Paid date period. Format: YYYY-MM-DD (payment_id or paid_date_begin and paid_date_end are mandatory)
`paid_date_end`	Paid date period. Format: YYYY-MM-DD (payment_id or paid_date_begin and paid_date_end are mandatory)

Key	Description
`type`	Return format: `json` (default) or `xml`
`validation_date_begin`	Validation date period. Format: YYYY-MM-DD
`validation_date_end`	Validation date period. Format: YYYY-MM-DD
`page`	Current page index
`limit`	Number of transactions shown per page - max 2000 transactions per page
`payment_currency`	The currency used when paying the commission for the brand to you. Available filter: USD, EUR, GBP. Multiple currencies separated by commas.

Key	Description
`brand_id`	Brand ID, a series of numbers, like 66303
`mcid`	Unique identifier for the brand, a series of characters, like ulike0
`m_id`	Deprecated, for removal. This parameter is subject to removal in a future version.
`amount`	Commission amount or bonus amount
`validation_date`	Date when commission is approved and ready for you to withdraw
`type`	Type could be commission or bonus
`note`	This indicates the time period the amount is generated
`settlement_id`	A unique id indicates approved commission by merchant
`merchant_name`	Merchant Name
`payment_id`	The payment ID found under payment history
`paid_date`	Date when the payment is marked paid. Format: YYYY-MM-DD
`sign_id`	Record unique identifier
`payment_currency`	The currency used when paying the commission for the brand to you. Available Filter: USD, EUR, GBP. Multiple currencies separated by commas.

Request:

{
  "token": "YOUR_CHANNEL_TOKEN",
  "payment_id": "3949"
}