HomeGuidesAPI ReferenceChangelog
Terms of Use
API Reference

Partner Settlement Report / Partner Settlement Record / Create

Create Partner Settlement Record.

For an operator that pays partners on collected revenue only (as recorded when the report was generated), direction is required and a request without it returns 422. For other operators direction is optional.

For an operator that pays partners on collected revenue only, a 409 with errorCode direction_total_below_zero is returned when the record would take the total of the payments logged in its direction below zero, and payment_tracking_managed_via_partner_invoice only while the report has an invoice issued by the operator that has not been credited in full. Invoices issued by the partner and invoices credited in full do not block creating a record.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required
Body Params
date
required

Date the payment was made.

number
required

Amount recorded as paid, in the settlement report's currency. Negative values record a reversing entry.

string
required

Free-text note on the settlement record.

string
enum

Direction of the payment between the operator and the partner. Required when creating a record for an operator that pays partners on collected revenue only (as recorded when the report was generated); a create without it returns 422. Optional for other operators; when omitted on update the stored direction is kept. Omitted in responses when the record has no direction.

Allowed values:

  • received - Received from the partner.
  • paid - Paid to the partner.

For an operator that pays partners on collected revenue only, a directed record counts toward that direction's total and the payment status of the settlement report, and a record that would take the direction's total below zero is refused with a 409.

Allowed:
Responses

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json