Get Payments

GET

/api/creative/marketing/sales/payments

• DivinityEngine - Local development
• DivinityEngine - Localhost alternative

List payment disbursement records with optional date range and retailer filter.

Parameters

Query Parameters

start

Start

string

""

end

End

string

""

retailer

Any of:

string

string

null

null

Responses

200

Successful Response

PaymentsResponse

object

success

required

Success

boolean

payments

required

Payments

Array<object>

PaymentRecord

object

id

required

Id

string

periodStart

required

Periodstart

string

periodEnd

required

Periodend

string

marketplace

required

Marketplace

string

paymentNumber

required

Paymentnumber

string

paymentDate

required

Paymentdate

string

paymentMethod

required

Paymentmethod

string

currency

required

Currency

string

accruedRoyalty

required

Accruedroyalty

number

taxWithholding

required

Taxwithholding

number

netEarnings

required

Netearnings

number

payoutCurrency

required

Payoutcurrency

string

fxRate

required

Fxrate

number

payoutAmount

required

Payoutamount

number

paymentStatus

required

Paymentstatus

string

sourceBreakdown

required

Sourcebreakdown

Array<object>

PaymentSourceBreakdown

object

source

required

Source

string

amount

required

Amount

number

summary

required

PaymentsSummary

object

paymentCount

required

Paymentcount

integer

totalPaid

required

Totalpaid

number

totalTaxWithheld

required

Totaltaxwithheld

number

totalNetEarnings

required

Totalnetearnings

number

error

Any of:

string

string

null

null

422

Validation Error

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

input

Input

ctx

Context

object