1 |
Column Type |
Literal |
The column type (CH ). |
2 |
TRANSACTION_TYPE |
Varchar |
One of the following types of transaction:
ACH_REVERSAL
ADD_MONEY This type applies to negative payout transactions where funds are debited from the merchant’s bank account.
AUTH This type applies to auth and auth void transactions.
BONUS Bonus type transactions.
CHARGEBACK This type applies to chargeback fee and chargeback fee reversal transactions.
CORRECTION
CURRENCY_CONVERSION
DEPOSIT
DISBURSEMENT
DISPUTE
FEE This type applies to fees related to refund, partner fee transactions etc.
FAILED_DISBURSEMENT Failure of an automated transaction that was initiated by PayPal to disburse the money from your balance to your linked bank account.
HOLD
HOLD_RELEASE
INCENTIVES
OTHERS
PAYABLE Funds payable are funds provided by PayPal that need to be paid back.
PAYMENT This type applies to money movement between a buyer and a seller for an order.
PAYOUT_REFUND Refund against a past payout transaction.
PAYOUT_REVERSAL Reversal of a Payout transaction
RECEIVABLE Funds receivable are funds provided by PayPal that are being paid back.
REFUND Refund related to a payment you received via PayPal. This refund will be referenced to the original payment in your PayPal account.
RECOUP: This type applies to recoups from bank or loss accounts.
REVERSAL
TRANSFER Transfers are funds transferred either from or to a PayPal account and another payable account
WITHDRAWAL
WITHDRAW_MONEY Withdrawal of money from your balance to a bank or non-banking institution account by you or auto-generated business events.
|
3 |
TRANSACTION_SUBTYPE |
Varchar |
One of the following subtypes of transaction:
ACCOUNT_RESERVE This subtype is applicable for any funds that are reserved from the Merchant account. These reserves are not tied to any individual transactions.
ACCOUNT_RESERVE_RELEASE This subtype is applicable for any funds that are released from reserve to the Merchant account. These reserves are not tied to any individual transactions.
BANK This subtype applies to withdrawal transactions.
BANK_DEPOSIT This subtype applies to negative payout. transactions where the transaction type is ADD_MONEY.
BANK_REVERSAL Failure of an automated transaction that was initiated by PayPal to disburse the money from your balance to your linked bank account.
BONUS This subtype applies to bonus transactions.
CREATED Payout is created and reserved for settlement withdrawal.
DEPOSIT When the transaction type is CORRECTION , the value DEPOSIT or WITHDRAWAL will be populated for the transaction subtype depending on whether the amount is deposited or withdrawn from the partner's financial account.
DISBURSED Settlement withdrawal is disbursed to the user's payout instrument, such as a bank account.
DISPUTE_HOLD Hold placed on the funds from a sale that got disputed by the buyer.
DISPUTE_HOLD_RELEASE Reversal of a temporary hold in connection with a dispute or chargeback raised by your buyer.
DISPUTE_REFUND This subtype helps merchants identify refunds which were a result of a dispute/chargeback case.
FAILED Reversal of a bank or settlement withdrawal failed for compliance reasons.
FEE This subtype applies to chargeback transactions.
FOREIGN_WITHDRAWAL Indicates foreign withdrawal fees, applicable for transaction type FEES .
FROM This subtype refers to the currency funds were converted from.
LOSS_ACCOUNT This subtype applies to recoup transactions.
MASSPAY This subtype applies to payment transactions.
PARTNER_FEE This subtype applies to fee transactions.
PAYMENT_FEE This subtype applies to fee transactions.
PENDING Settlement withdrawal is put on hold for risk or compliance reasons.
REFUND This subtype applies to fees refund transactions.
REVERSED Payout is suspended, and the amount reserved for payout is reversed back to the user's account.
REVERSAL This subtype applies to chargeback, fees, and withdrawal transactions.
TO This subtype refers to the currency funds were converted to.
TRANSACTIONAL_RESERVE This subtype is applicable for any funds that are placed on Reserve hold for a specific transaction.
TRANSACTIONAL_RESERVE_RELEASE This subtype is applicable for any funds that are released from Reserve hold for a specific transaction.
VOID This subtype applies to auth void transactions.
WITHDRAWAL When the transaction type is CORRECTION , the value DEPOSIT or WITHDRAWAL will be populated for the transaction subtype depending on whether the amount is deposited or withdrawn from the partner's financial account.
|
4 |
SELLER_ACCOUNT_ID |
Varchar |
The seller's encrypted PayPal account number. |
5 |
PAYPAL_REFERENCE_ID |
String |
The original PayPal transaction ID this event is related to. |
6 |
PAYPAL_TRANSACTION_ID |
Varchar |
The PayPal transaction ID. |
7 |
INVOICE_ID |
Varchar |
The invoice ID of the transaction. |
8 |
CUSTOM_FIELD |
Varchar |
A field for custom data. |
9 |
TRANSACTION_DATE |
Date-time |
The date and time the transaction was initiated, in the following format: YYYY/MM/DD HH:MM:SS offset . YYYY is the four-digit year.MM is two-digit month of the year.DD is the two-digit day of the month. HH is the hour in 24-hour notation. MM is minutes. SS is seconds. offset is the five-character signed offset from GMT, such as +0800 . |
10 |
INTEGRATION_IDENTIFIER |
Varchar |
The partner's button source code. |
11 |
PAYMENT_INSTRUMENT_TYPE |
Varchar |
A high-level classification of the type of financial instrument that was used to fund a payment, such as the following:
PAYPAL
CREDIT_CARD
DEBIT_CARD
Direct Debit
VENMO
Apple Pay
Google Pay
Network Token
Pay Upon Invoice
- Supported APMs
|
12 |
PAYMENT_INSTRUMENT_SUBTYPE |
Varchar |
One of the following detailed classifications of the financial instrument used to fund a payment:
AMEX: AMEX card transaction
CARTE_BANCAIRE: CARTE_BANCAIRE card transaction
CETELEM: CETELEM card transaction
COFIDIS: COFIDIS card transaction
COFINOGA: COFINOGA card transaction
CHINA_UNION_PAY: CHINA_UNION_PAY card transaction
DELTA: DELTA card transaction
DISCOVER: DISCOVER card transaction
ELECTRON: ELECTRON card transaction
ELO: ELO card transaction
HIPER: HIPER card transaction
HIPERCARD: HIPERCARD card transaction
JCB: JCB card transaction
MAESTRO: MAESTRO card transaction
MASTER_CARD: MASTER_CARD card transaction
SOLO: SOLO card transaction
STAR: STAR card transaction
SWITCH: SWITCH card transaction
VISA: VISA card transaction
For Wallets and Network token, Payment Source Subtype would show details of card type and card brand used to fund the transaction. For example:
CREDIT_CARD-VISA
DEBIT_CARD-MASTER_CARD
|
13 |
CHECKOUT_CHANNEL |
Varchar |
Used to distinguish online and offline payments.
POS_PPH A payment made using a PayPal Here device.
ONLINE_PAYMENT A payment made on an online platform.
|
14 |
DELAYED_DISBURSEMENT |
One-character flag |
The following codes indicate the disbursement type:
Y Delayed disbursement
N Instant disbursement
|
15 |
TRANSACTION_AMOUNT |
Money |
The amount of the transaction. |
16 |
TRANSACTION_CURRENCY |
Three-character currency code |
The currency of the transaction. |
17 |
TRANSACTION_DEBIT_CREDIT_CODE |
Varchar |
The following codes indicate whether the money was credited or debited:
|
18 |
PENDING_DISBURSEMENT_AMOUNT |
Money |
The amount yet to be disbursed. |
19 |
PENDING_DISBURSEMENT_AMOUNT_CURRENCY |
Three-character currency code |
The currency of the amount yet to be disbursed. |
20 |
SELLER_AMOUNT |
Money |
The amount of funds transferred to or from a customer. Funds moving out of the seller account have a dash (-) prefix. |
21 |
SELLER_AMOUNT_CURRENCY |
Three-character currency code |
The currency of the seller amount. |
22 |
PARTNER_FEE |
Money |
Partner fees associated with the transaction. Funds moving out of the partner fee account have a dash (- ) prefix. |
23 |
PARTNER_FEE_CURRENCY |
Three-character currency code |
The currency of the partner fee. |
24 |
PARTNER_FEE_ACCOUNT_ID |
Varchar |
The partner fee encrypted account number in PayPal. |
25 |
PP_FEES |
Money |
Any PayPal fees associated with the transaction. Funds moving out of the PayPal fee account have a dash (- ) prefix. |
26 |
PP_FEES_CURRENCY |
Three-character currency code |
The currency of the PayPal fee. |
27 |
PP_FEES_PERCENTAGE |
varchar |
The percentage of the transaction amount charged as fee. Total PayPal fees include PP_FEES_PERCENTAGE and PP_FEES_FIXED_AMOUNT . |
28 |
PP_FEES_FIXED_AMOUNT |
Money |
The fixed PayPal fee amount component of PP_FEES . |
29 |
PP_FEES_XB_PERCENTAGE |
varchar |
The percentage of the transaction amount charged as cross-border fees. Total cross-border fees include PP_FEES_XB_PERCENTAGE and PP_FEES_XB_FIXED_AMOUNT . |
30 |
PP_FEES_XB_FIXED_AMOUNT |
Money |
The fixed cross-border fee amount component of PP_FEES_XB_TOTAL_AMOUNT . |
31 |
PP_FEES_XB_TOTAL_AMOUNT |
Money |
Total cross-border fee amount associated with the transaction. Total cross-border fees include PP_FEES_XB_PERCENTAGE and PP_FEES_XB_FIXED_AMOUNT . |
32 |
CHARGEBACK_FEE |
Money |
The chargeback fee associated with the transaction. A dash (- ) prefix indicates the chargeback fee is reversed. |
33 |
CHARGEBACK_FEE_CURRENCY |
Three-character currency code |
The currency of the CHARGEBACK_FEE . |
34 |
HOLD_AMOUNT |
Money |
The amount put on hold or released from hold. A dash (- ) prefix indicates the funds that were put on hold are being released. |
35 |
HOLD_AMOUNT_CURRENCY |
Three-character currency code |
The currency of the HOLD_AMOUNT . |
36 |
RECOUP_AMOUNT |
Money |
The amount recouped from the recoup account. Funds moving out of the recoup account have a dash (- ) prefix. |
37 |
RECOUP_AMOUNT_CURRENCY |
Three-character currency code |
The currency of the RECOUP_AMOUNT . |
38 |
RECOUP_ACCOUNT_ID |
Varchar |
The encrypted PayPal account number of the recoup account. |
39 |
PAYABLE_AMOUNT |
Money |
The amount moving in and out of the partner's payable general ledger account. Funds moving out of the payable account have a dash (- ) prefix. |
40 |
PAYABLE_AMOUNT_CURRENCY |
Three-character currency code |
The currency of the PAYABLE_AMOUNT . |
41 |
PAYABLE_ACCOUNT_ID |
Varchar |
The encrypted PayPal account number of the partner's payable general ledger. |
42 |
EXTERNAL_TRANSFER_AMOUNT |
Money |
The amount credited to or debited from an external entity, such as a bank. Funds debited from an external entity have a dash (- ) prefix. |
43 |
EXTERNAL_TRANSFER_AMOUNT_CURRENCY |
Three-character currency code |
The currency of the EXTERNAL_TRANSFER_AMOUNT . |
44 |
COUNTERPARTY_ACCOUNT_ID |
Varchar |
The encrypted PayPal account number of the counter party involved in a transaction. |
45 |
SETTLEMENT_REFERENCE_ID |
Varchar |
The bank reference ID for the bank transfer transaction. |
46 |
STORE_ID |
Varchar |
ID of the store where point of sale happened. |
47 |
TRANSACTION_STATUS |
Varchar |
The current status of the PAYMENT transaction. This status can be one of the following:
|
48 |
DECLINE_CODE |
Varchar |
This code indicates the reason of decline, when available. For credit card transactions, the code is a processor decline code. For bank transactions, the code is a bank decline code. For more information, see processor decline codes. |
49 |
PAYOUT_REFERENCE_ID |
Varchar |
Indicates transaction ID of the counterparty for a payout transaction. |
50 |
BASE_FX_RATE |
Number |
This is the base rate for FX Optimizer enabled currency conversion at the time of transaction. |
51 |
TOTAL_FX_MARKUP |
Number |
This total markup includes the markup charged by the partner and PayPal as part of FX Optimizer enabled currency conversion. |
52 |
NET_FX_RATE |
Number |
This is the net rate for FX Optimizer enabled currency conversion at the time of transaction includes Base & total markup. |
53 |
REQUESTED_FX_ID |
Varchar |
This is rate requested by the user at the time of the transaction for FX Optimizer enabled currency conversion. |
54 |
APPLIED_FX_ID |
Varchar |
This is the rate that is applied at the time of currency conversion. This rate can be the same as REQUESTED_FX_ID if REQUESTED_FX_ID has not expired at the time of transaction. If REQUESTED_FX_ID has expired, a new rate is applied at the time of transaction. |
55 |
PAYOUT_ITEM_ID |
Varchar |
The ID of the payout item. |
56 |
MEMO |
Varchar |
Custom information sent by user while calling Api to place transaction. |
57 |
PAYOUT_AMOUNT |
Money |
Total payout amount expected to be disbursed to the Users Payout instrument. |
58 |
PAYOUT_SETTLEMENT_CURRENCY |
Three-character currency code |
Payout amount currency that is expected to be disbursed to the Users Payout instrument. |
59 |
PAYOUT_ID |
Varchar |
Unique identifier used to tie all transactions that contributed to a particular Payout. This can also be used to link all Payout life cycle events. |
60 |
SETTLEMENT_SOFT_DESCRIPTOR |
Varchar |
Unique identifier sent as part of Settlement to Bank transaction that can be used along with SETTLEMENT_REFERENCE_ID to trace the deposit in their Bank statement. |
61 |
SETTLEMENT_INSTRUMENT_TYPE |
Varchar |
The type of external entity where the external transfer amount was credited to or debited from, such as BANK , for bank transactions. |
62 |
SETTLEMENT_INSTRUMENT_SUB_TYPE |
Varchar |
The sub-type of external entity where external transfer amount was credited to or debited from. |
63 |
WITHDRAWAL_TYPE |
Varchar |
Withdrawal type to differentiate on-demand vs automated withdrawals. ‘Merchant Initiated’ will be shown for on-demand payouts/withdrawals. |