Getting status via postback

Getting lead statuses via API is the best way to work. If API work is not possible, you can use postbacks from the target network to get statuses.

The status function of the comp application is responsible for the operation with postbacks. You can view its full documentation within your network. We will consider its reduced version, which is optimal for sending status updates.

You can get the postback link and its sample by clicking the "Integration" button in the company management section. Use the link from the "Start postback with" field and add the parameters you need to it. The required parameters are the order identifier and its status.

Order ID

You can use one of two parameters to identify the order:

  • oid - your internal order ID. You first need to send it to one of the SubIDs on the network.
  • eid - order identifier on the side of the target network. You must first receive it when sending a lead to the network.

Order status

The order status must be passed to the status parameter in an arbitrary form. The system automatically recognizes the status by tricky algorithms.

Automatic status recognition is suitable for most cases. But you can use additional parameters to tell the system which status to consider as a approved order, and which as a cancellation.

  • sta - status or list of order approve statuses.
  • stc - status or list of order cancellation statuses.
  • stt - status or list of invalid or trash order statuses.
  • stw - status or list of order pending and call center statuses.
  • sth - status or list of order holding statuses.

Important! The "hold" status in AlterCPA is not a waiting or pending status! This status is used for delayed confirmation of orders. For example, for orders for which the buyer's consent has already been received, but the payment has not yet been made. Do not use this status for pending orders!

Example of specifying special statuses:

status={status}&sta=lead_approved&stc=lead_cancelled&stt=lead_trash

Extra options

This parameters are optional:

  • comment - text comment to the order.
  • wm - the amount of commission for the order, sets the commission both for the affiliate and advertiser, uses the "Manual commissions" mechanism.
  • pay - the amount of commission for the advertiser, does not affect the affiliate commission.
  • cc - commission currency ISO code.
  • base - order invoice (not commission!) amount.
  • currency - order invoice (not commission!) currency ISO code.

Postback examples

Simple postback with internal ID and status:

https://domain.ru/api/comp/status.json?id=123-abc&oid={subid}&status={status}

Postback using external order ID:

https://domain.ru/api/comp/status.json?id=123-abc&eid={order_id}&status={status}

Postback using special statuses for approve:

https://domain.ru/api/comp/status.json?id=123-abc&oid={subid}&status={status}&sta=completed,finished,done

Postback indicating the amount and currency of advertiser commission:

https://domain.ru/api/comp/status.json?id=123-abc&oid={subid}&status={status}&pay={payout}&cc={currency}