Payments and Promotions

These endpoints can be used to obtain additional financial details for a specific order:

• Payments
• Promotions

Get Order Payments

An order can have multiple shipments. Currently each shipment will correspond to one payment. In future we may have one payment for multiple shipments.

Fetch all payment details for a given order.

curl -X GET -G \
  -d 'access_token=<ACCESS_TOKEN>' \
  https://graph.facebook.com/{order-id}/payments

GET /{order-id}/payments 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(
    '/{order-id}/payments',
    '{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(
    "/{order-id}/payments",
    function (response) {
      if (response && !response.error) {
        /* handle the result */
      }
    }
);

Request

Response

payment_details object

payment_info object

subtotal object

shipments object

shipment_info object

transaction_details object

transaction_detail object

tax_details object

tax_detail object

currency_amount object

Sample Response

{
  "data": [
    {
      "id": "2381232183",
      "subtotal": {
        "items": {
          "amount": "40.00",
          "currency": "USD"
        },
        "shipping": {
          "amount": "0.00",
          "currency": "USD"
        }
      },
      "tax": {
        "amount": "0.06",
        "currency": "USD"
      },
      "tax_remitted": true,
      "total_amount": {
        "amount": "44.06",
        "currency": "USD"
      },
      "shipments": {
        "data": [
          {
            "id": "2121312213",
            "external_shipment_id": "shopify-shipment-1"
          },
          {
            "id": "2121312213",
            "external_shipment_id": "shopify-shipment-2"
          }
        ]
      },
      "transaction_details": {
        "data": [
          {
            "transaction_type": "SALE",
            "transaction_date": "2019-01-03T09:16:21+00:00",
            "transfer_id": "po_1DqSkwFN7vzsfPbcs4aFsknN",
            "processing_fee": {
              "amount": "-0.33",
              "currency": "USD"
            },
            "net_payment_amount": {
              "amount": "0.67",
              "currency": "USD"
            }
          },
          {
            "transaction_type": "REFUND",
            "transaction_date": "2019-01-09T06:18:50+00:00",
            "processing_fee": {
              "amount": "0.33",
              "currency": "USD"
            },
            "net_payment_amount": {
              "amount": "-0.67",
              "currency": "USD"
            },
            "tax_rate": "8.25%",
            "tax_details": {
              "data": [
                {
                  "tax_category": "FBMP_OTHER_TAXABLE",
                  "jurisdiction": "CALIFORNIA",
                  "imposition": "Sales and Use Tax",
                  "item_tax_rate": "6%",
                  "item_tax_amount": {
                    "amount": "0.06",
                    "currency": "USD"
                  }
                },
                {
                  "tax_category": "FBMP_OTHER_TAXABLE",
                  "jurisdiction": "ALAMEDA",
                  "imposition": "Local Sales and Use Tax",
                  "item_tax_rate": "1.25%",
                  "item_tax_amount": {
                    "amount": "0.01",
                    "currency": "USD"
                  }
                }, // and more
              ]
            }
          }
        ]
      }
    }
  ],
  "paging": {
    "cursors": {
      "before": "--sanitized_key--",
      "after": "--sanitized_key--"
    }
  }
}

Get Order Promotions

Get details of all promotions applied on an order. Example: reimbursements.

curl -X GET -G \
  -d 'access_token=<ACCESS_TOKEN>' \
  https://graph.facebook.com/{order-id}/promotions

GET /{order-id}/promotions 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(
    '/{order-id}/promotions',
    '{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(
    "/{order-id}/promotions",
    function (response) {
      if (response && !response.error) {
        /* handle the result */
      }
    }
);

Request

Response

promotion_details object

reimbursement_details object

Sample Response

{
  "data": [
    {
      "id": "2131312312",
      "name": "FIRST_TIME_BUYER",
      "reimbursement": {
        "net_payout": {
          "amount": "10.00",
          "currency": "USD"
        }
      }
    }
  ],
  "paging": {
    "cursors": {
      "before": "--sanitized_key--",
      "after": "--sanitized_key--"
    }
  }
}