Commerce Platform

Payouts

After a customer places an order from your Facebook Shop or Instagram Shopping account and you mark the order as shipped, you'll be paid for the order within 2 to 30 days.

This endpoint provides the payout history for your account, which you can filter by time range. It will also include a payout_reference_id which you can combine with the Transactions endpoint to query more details for that particular payout.

Below is an example request to get all payouts for the month of June.

For payouts before May 15, 2019 the payout_reference_id field is not defined.

Graph API Explorer
curl -X GET -G \
  -d 'start_time=1559347200' \
  -d 'end_time=1561939200' \
  -d 'access_token=<ACCESS_TOKEN>' \
  https://graph.facebook.com/{page-id}/commerce_payouts
GET /{page-id}/commerce_payouts?start_time=1559347200&end_time=1561939200 HTTP/1.1
Host: graph.facebook.com
/* PHP SDK v5.0.0 */
/* make the API call */
try {
  // Returns a `Facebook\FacebookResponse` object
  $response = $fb->get(
    '/{page-id}/commerce_payouts?start_time=1559347200&end_time=1561939200',
    '{access-token}'
  );
} catch(Facebook\Exceptions\FacebookResponseException $e) {
  echo 'Graph returned an error: ' . $e->getMessage();
  exit;
} catch(Facebook\Exceptions\FacebookSDKException $e) {
  echo 'Facebook SDK returned an error: ' . $e->getMessage();
  exit;
}
$graphNode = $response->getGraphNode();
/* handle the result */
/* make the API call */
FB.api(
    "/{page-id}/commerce_payouts",
    {
        "start_time": 1559347200,
        "end_time": 1561939200
    },
    function (response) {
      if (response && !response.error) {
        /* handle the result */
      }
    }
);

Request

AttributeTypeDescription

start_time

Unix timestamp

Starting time period for payout report

end_time

Unix timestamp

Ending time period for payout report

Response

ValueTypeDescription

amount

currency_amount

payout_date

ISO 8601 Datetime

Indicates the date at which the transaction was initiated. If a row has this date, then it means that the transaction was included in the payout initiated on that day.

If this field is empty, it means that the transaction is still in the seller's balance with the payment processor and is not paid out yet.

It may take from 3 to 5 business days for payout to be reflected in you bank account after it is initiated.

payout_reference_id

String

The bank reference ID associated with this payout. Note: only available for payouts processed after 5/15/19.

status

String

Payout status, either COMPLETED or FAILED

currency_amount object

AttributeTypeDescription

amount

string

Amount in decimal format, eg. 4.99.

currency

string

Three digit ISO-4217-3 code for the purchase, e.g. USD.

Sample response

{
  "data": [
    {
      "amount": {
        "amount": "0.70",
        "currency": "USD"
      },
      "payout_date": "2019-06-28T11:47:11+00:00",
      "payout_reference_id": "FBMPUSS5191u01g",
      "status": "COMPLETED"
    },
    {
      "amount": {
        "amount": "0.10",
        "currency": "USD"
      },
      "payout_date": "2019-06-27T14:11:32+00:00",
      "payout_reference_id": "FBMPUSR5191ox2x",
      "status": "COMPLETED"
    }
  ]
}