Transaction Search API for Partners
Last updated: Sept 24th, 3:51pm
Use the Transaction Search API to get the history of transactions for a PayPal account.
Partner transactions
You can use the partner-transactions endpoint to get the details of all transactions executed on your platform. Reviewing transaction details can help you with the following tasks:
- Reconciling transactions
- Creating transaction dashboards for you and your sellers
- Performing payment transaction analytics
1curl -v -X GET https://api-m.sandbox.paypal.com/v1/reporting/partner-transactions?integration_id=bncode_mp&start_time=2016-10-05T06:07:00-0700&end_time=2016-10-12T06:07:00-0700&page_size=9&page=2 \2-H "Content-Type: application/json" \3-H "Authorization: Bearer <Access-Token>"
A successful request returns the HTTP 200 OK
status code and a JSON response body that lists transactions.
1{2 "transaction_details": [3 {4 "transaction_info": {5 "account_id": "ZXCVBNMJKL3TR",6 "id": "9VM35858CX3957803",7 "reference_id": "55X9366116547493P",8 "type": "PAYMENT",9 "initiation_time": "2018-08-27T01:20:19Z",10 "partner_timezone": "America/Los_Angeles",11 "merchant_timezone": "America/Los_Angeles",12 "payment_instrument_type": "PAYPAL",13 "delayed_disbursement": "Y",14 "amount": {15 "currency_code": "USD",16 "value": "100.00"17 },18 "seller_amount": {19 "currency_code": "USD",20 "value": "0.00"21 },22 "pending_disbursement_amount": {23 "currency_code": "USD",24 "value": "90.00"25 },26 "fees": [27 {28 "type": "MARKETPLACE",29 "account_id": "QWERTYUIOP",30 "amount": {31 "currency_code": "USD",32 "value": "6.00"33 }34 },35 {36 "type": "PAYPAL",37 "amount": {38 "currency_code": "USD",39 "value": "4.00"40 }41 }42 ],43 "invoice_id": "1097631:30794019-0c54-4300-a9af-aea08125940e",44 "custom_field": "47db4583-d93f-48b2-97de-86624d8e41d2"45 }46 },47 {48 "transaction_info": {49 "account_id": "ZXCVBNMJKL3TR",50 "id": "9VM35858CX3957803",51 "reference_id": "55X9366116547493P",52 "type": "DISBURSEMENT",53 "initiation_time": "2018-08-27T01:20:19Z",54 "partner_timezone": "America/Los_Angeles",55 "merchant_timezone": "America/Los_Angeles",56 "payout_instrument_type": "PAYPAL",57 "delayed_disbursement": "Y",58 "amount": {59 "currency_code": "USD",60 "value": "90.00"61 },62 "seller_amount": {63 "currency_code": "USD",64 "value": "90.00"65 },66 "pending_disbursement_amount": {67 "currency_code": "USD",68 "value": "-90.00"69 },70 "invoice_id": "1097631:30794019-0c54-4300-a9af-aea08125940e",71 "custom_field": "47db4583-d93f-48b2-97de-86624d8e41d2"72 }73 },74 {75 "transaction_info": {76 "account_id": "ZXCVBNMJKL3TR",77 "id": "9VM35858CX3957803",78 "reference_id": "55X9366116547493P",79 "type": "AUTODEBIT",80 "sub_type": "LOSS_ACCOUNT",81 "initiation_time": "2018-08-27T01:20:19Z",82 "partner_timezone": "America/Los_Angeles",83 "merchant_timezone": "America/Los_Angeles",84 "amount": {85 "currency_code": "USD",86 "value": "100.00"87 },88 "seller_amount": {89 "currency_code": "USD",90 "value": "100.00"91 },92 "pending_disbursement_amount": {93 "currency_code": "USD",94 "value": "0.00"95 },96 "invoice_id": "1097631:30794019-0c54-4300-a9af-aea08125940e",97 "custom_field": "47db4583-d93f-48b2-97de-86624d8e41d2"98 }99 },100 {101 "transaction_info": {102 "account_id": "ZXCVBNMJKL3TR",103 "id": "9VM35858CX3957803",104 "reference_id": "55X9366116547493P",105 "type": "AUTODEBIT",106 "sub_type": "BANK",107 "initiation_time": "2018-08-27T01:20:19Z",108 "partner_timezone": "America/Los_Angeles",109 "merchant_timezone": "America/Los_Angeles",110 "amount": {111 "currency_code": "USD",112 "value": "100.00"113 },114 "seller_amount": {115 "currency_code": "USD",116 "value": "100.00"117 },118 "pending_disbursement_amount": {119 "currency_code": "USD",120 "value": "0.00"121 },122 "invoice_id": "1097631:30794019-0c54-4300-a9af-aea08125940e",123 "custom_field": "47db4583-d93f-48b2-97de-86624d8e41d2"124 }125 },126 {127 "transaction_info": {128 "account_id": "ASDFGHJKLZXC",129 "id": "2SP851406A2553618",130 "reference_id": "4EP0966261749335W",131 "type": "REFUND",132 "initiation_time": "2018/11/01 00:33:26Z",133 "partner_timezone": "America/Los_Angeles",134 "merchant_timezone": "America/Los_Angeles",135 "payment_instrument_type": "PAYPAL",136 "payout_instrument_type": "PAYPAL",137 "amount": {138 "currency_code": "USD",139 "value": "56.00"140 },141 "seller_amount": {142 "currency_code": "USD",143 "value": "-56.00"144 },145 "fees": [146 {147 "type": "MARKETPLACE",148 "account_id": "QWERTYUIOP",149 "amount": {150 "currency_code": "USD",151 "value": "-3.36"152 }153 },154 {155 "type": "PAYPAL",156 "amount": {157 "currency_code": "USD",158 "value": "-2.46"159 }160 }161 ],162 "invoice_id": "1097631:30794019-0c54-4300-a9af-aea08125940e",163 "custom_field": "7947b18c-5975-4cbc-aea5-9ee2d67ddc31"164 }165 },166 {167 "transaction_info": {168 "account_id": "BOZXCVYTMJER",169 "id": "9VM35858CX3957803",170 "reference_id": "55X9366116547493P",171 "type": "WITHDRAWAL",172 "sub_type": "BANK",173 "initiation_time": "2018-08-27T01:20:19Z",174 "partner_timezone": "America/Los_Angeles",175 "amount": {176 "currency_code": "USD",177 "value": "100.00"178 },179 "seller_amount": {180 "currency_code": "USD",181 "value": "0.00"182 },183 "pending_disbursement_amount": {184 "currency_code": "USD",185 "value": "0.00"186 }187 }188 },189 {190 "transaction_info": {191 "account_id": "ZXCVBNMJKL3TR",192 "id": "3AY04590JE9854127",193 "reference_id": "4MY82989YJ086351R",194 "type": "CHARGEBACK",195 "initiation_time": "2018-08-27T01:20:19Z",196 "partner_timezone": "America/Los_Angeles",197 "merchant_timezone": "America/Los_Angeles",198 "amount": {199 "currency_code": "USD",200 "value": "100.00"201 },202 "seller_amount": {203 "currency_code": "USD",204 "value": "-94.00"205 },206 "pending_disbursement_amount": {207 "currency_code": "USD",208 "value": "0.00"209 },210 "fees": [211 {212 "type": "MARKETPLACE",213 "account_id": "QWERTYUIOP",214 "amount": {215 "currency_code": "USD",216 "value": "-6.00"217 }218 }219 ],220 "invoice_id": "1097631:30794019-0c54-4300-a9af-aea08125940e",221 "custom_field": "47db4583-d93f-48b2-97de-86624d8e41d2"222 }223 },224 {225 "transaction_info": {226 "account_id": "ZXCVBNMJKL3TR",227 "id": "80641554LT435811F",228 "reference_id": "4MY82989YJ086351R",229 "type": "CHARGEBACK",230 "initiation_time": "2018-08-29T06:30:17Z",231 "partner_timezone": "America/Los_Angeles",232 "merchant_timezone": "America/Los_Angeles",233 "amount": {234 "currency_code": "USD",235 "value": "100.00"236 },237 "seller_amount": {238 "currency_code": "USD",239 "value": "94.00"240 },241 "pending_disbursement_amount": {242 "currency_code": "USD",243 "value": "0.00"244 },245 "fees": [246 {247 "type": "MARKETPLACE",248 "account_id": "QWERTYUIOP",249 "amount": {250 "currency_code": "USD",251 "value": "6.00"252 }253 }254 ],255 "invoice_id": "1097631:30794019-0c54-4300-a9af-aea08125940e",256 "custom_field": "47db4583-d93f-48b2-97de-86624d8e41d2"257 }258 },259 {260 "transaction_info": {261 "account_id": "ZXCVBNMJKL3TR",262 "id": "5DK56518V89296722",263 "reference_id": "4MY82989YJ086351R",264 "type": "CHARGEBACK",265 "initiation_time": "2018-08-30T08:25:20Z",266 "partner_timezone": "America/Los_Angeles",267 "merchant_timezone": "America/Los_Angeles",268 "instrument_type": "PAYPAL",269 "amount": {270 "currency_code": "USD",271 "value": "100.00"272 },273 "seller_amount": {274 "currency_code": "USD",275 "value": "-104.00"276 },277 "pending_disbursement_amount": {278 "currency_code": "USD",279 "value": "0.00"280 },281 "fees": [282 {283 "type": "MARKETPLACE",284 "account_id": "QWERTYUIOP",285 "amount": {286 "currency_code": "USD",287 "value": "-6.00"288 }289 },290 {291 "type": "CHARGEBACK",292 "amount": {293 "currency_code": "USD",294 "value": "10.00"295 }296 }297 ],298 "invoice_id": "1097631:30794019-0c54-4300-a9af-aea08125940e",299 "custom_field": "47db4583-d93f-48b2-97de-86624d8e41d2"300 }301 },302 {303 "transaction_info": {304 "account_id": "M3XXBDPCEA2CY",305 "id": "5SN722411P245120P",306 "reference_id": "69V200872F7277920",307 "type": "DISPUTE",308 "initiation_time": "2018-08-29T06:30:17Z",309 "partner_timezone": "America/Los_Angeles",310 "merchant_timezone": "America/Los_Angeles",311 "seller_amount": {312 "currency_code": "USD",313 "value": "-9.43"314 },315 "hold_amount": {316 "currency_code": "USD",317 "value": "10.38"318 },319 "fees": [320 {321 "type": "PARTNER",322 "amount": {323 "currency_code": "USD",324 "value": "-0.95"325 }326 }327 ],328 "invoice_id": "1097631:30794019-0c54-4300-a9af-aea0812",329 "custom_field": "47db4583-d93f-48b2-97de-86624d8e65w3"330 }331 }332 ],333 "account_id": "WHH7K6UE7RMCC",334 "start_time": "2018-10-31T16:00:00+0000",335 "end_time": "2018-11-01T15:59:59+0000",336 "last_refreshed_time": "2018-11-26T05:29:59+0000",337 "total_items": 20,338 "total_pages": 5,339 "links": [340 {341 "href": "https://api-m.paypal.com/v1/reporting/partner-transactions?attribution_id=bncode_mp&start_time=2016-10-05T06:07:00-0700&end_time=2016-10-12T06:07:00-0700&page_size=9&page=1",342 "rel": "first",343 "method": "GET"344 },345 {346 "href": "https://api-m.paypal.com/v1/reporting/partner-transactions?attribution_id=bncode_mp&start_time=2016-10-05T06:07:00-0700&end_time=2016-10-12T06:07:00-0700&page_size=9&page=5",347 "rel": "last",348 "method": "GET"349 },350 {351 "href": "https://api-m.paypal.com/v1/reporting/partner-transactions?attribution_id=bncode_mp&start_time=2016-10-05T06:07:00-0700&end_time=2016-10-12T06:07:00-0700&page_size=9&page=3",352 "rel": "next",353 "method": "GET"354 },355 {356 "href": "https://api-m.paypal.com/v1/reporting/partner-transactions?attribution_id=bncode_mp&start_time=2016-10-05T06:07:00-0700&end_time=2016-10-12T06:07:00-0700&page_size=9&page=2",357 "rel": "self",358 "method": "GET"359 },360 {361 "href": "https://api-m.paypal.com/v1/reporting/partner-transactions?attribution_id=bncode_mp&start_time=2016-10-05T06:07:00-0700&end_time=2016-10-12T06:07:00-0700&page_size=9&page=1",362 "rel": "prev",363 "method": "GET"364 }365 ]366}