Resource Center

Payment Details Resource

publisher/report/payment-details
 

The payment details resource allows an affiliate to pull publisher payout payment information with more detailed information such as; Transaction ID, Order ID, Item ID, and SID.

 

GET

Request Parameters

Parameter

Description

Possible Values

Default

Required?

paymentId

A valid integer representing any payment ID. Payment IDs may be obtained from the payment web service. 
(if not present, start and end dates must be provided)

valid integer

N/A

No

startDate

A valid date string in the ISO 8601 date format; 
any timestamp information that is present will be ignored. 
(if not present, payment ID must be provided)

yyyy-mm-dd

N/A

No

endDate

A valid date string in the ISO 8601 date format; 
any timestamp information that is present will be ignored. 
(if not present, payment ID must be provided)

yyyy-mm-dd

N/A

No

itemized

Commission and Order Amounts will be listed per item for itemized transactions.

1,true

0,false

No

removeCsvHeaders

Removes the CSV column headers from the report.

1,true

0,false

No

Response Fields

Field

Description

Notes

payment_id

Payment ID

 

transaction_id

Transaction ID

 

order_id

Order ID

 

item_id

Item ID

If itemized parameter is true or 1, Commission and Order Amounts will be listed per item for itemized transactions.

sid

SID

 

program_id

Program ID

 

program_name

Program Name

 

creative_type

Creative Type

one of: product, text, advanced, banner, contextual, newsletter, manual, generic, call, aggregate, skimlinks

commission

Commission Amount

 

sale_amount

Order Amount

 

transaction_type

Transaction Type

one of: bonus, lead, sale, click

transaction_date

Transaction Date

 

payment_date

Payment Date