Payout and Transaction API response: Signs and meanings

Addlab
New Member
1 0 0

Hello All,

We're trying to investigate the payout and transaction API responses.

Does somebody know how to answer the following questions?

 

1) Payouts

1.1) Meaning of the fields

adjustments: Generated when a user chargebacks any other source? 

charges: Generated only from orders?

refunds: Generated only from refunds?

reserved_funds: I have no idea about what they are.

retried_payouts: I have no idea about what they are, maybe if a previous payout transaction got refused from the receiving bank? 

 

1.2) Signs of the values

adjustments: Both fee and gross are positive in case of chargebacks.

charges: Gross should be added to total, but fee should be subtracted, since its value is positive: total = the_rest + gross - fee

refunds: Both gross and fee are added to the total since they are negative values: total = the_rest + (refunds_gross_amount) +  (refund_fee_amount)

reserved_funds: I have no idea about what they are.

retried_payouts: I have no idea about what they are, maybe if a previous payout transaction got refused from the receiving bank? 

 

Here's the examples from the documentation

Payouts ( https://shopify.dev/api/admin/rest/reference/shopify_payments/payout )

 

{
  "payout": {
    "id": 623721858,
    "status": "paid",
    "date": "2012-11-12",
    "currency": "USD",
    "amount": "41.90",
    "summary": {
      "adjustments_fee_amount": "0.12",
      "adjustments_gross_amount": "2.13",
      "charges_fee_amount": "1.32",
      "charges_gross_amount": "44.52",
      "refunds_fee_amount": "-0.23",
      "refunds_gross_amount": "-3.54",
      "reserved_funds_fee_amount": "0.00",
      "reserved_funds_gross_amount": "0.00",
      "retried_payouts_fee_amount": "0.00",
      "retried_payouts_gross_amount": "0.00"
    }
  }
}

 

 

2) Transactions

2.1) Signs of the values

For each Type of transaction, when amount, fee and net are positive?

I suppose they are coherent with the payout signs, but it's not documented, does someone have empiric evidences?

 

Here's the examples from the documentation

Transaction ( https://shopify.dev/api/admin/rest/reference/shopify_payments/transaction )

 

 

 

{
      "id": 746296004,
      "type": "charge",
      "test": false,
      "payout_id": 623721858,
      "payout_status": "paid",
      "currency": "USD",
      "amount": "10.00",
      "fee": "2.00",
      "net": "8.00",
      "source_id": 746296004,
      "source_type": "charge",
      "source_order_id": 625362839,
      "source_order_transaction_id": 890672011,
      "processed_at": "2021-07-01T15:35:53-04:00"
    }

 

and

 

 

 

{
      "id": 758509248,
      "type": "adjustment",
      "test": false,
      "payout_id": 623721858,
      "payout_status": "paid",
      "currency": "USD",
      "amount": "-1.50",
      "fee": "-0.25",
      "net": "-1.75",
      "source_id": 764194150,
      "source_type": "charge",
      "source_order_id": null,
      "source_order_transaction_id": null,
      "processed_at": "2021-07-01T15:35:53-04:00"
    }

 

 and

 

{
      "id": 515523000,
      "type": "charge",
      "test": false,
      "payout_id": 623721858,
      "payout_status": "paid",
      "currency": "USD",
      "amount": "11.50",
      "fee": "0.65",
      "net": "10.85",
      "source_id": 1006917261,
      "source_type": "Payments::Refund",
      "source_order_id": 217130470,
      "source_order_transaction_id": 1006917261,
      "processed_at": "2021-07-01T15:35:53-04:00"
    }

 

 

If you reached this point: thank you, any information would be helpful.

Replies 0 (0)