Activities API
Activities (resource group)
/activities
resource to list activities.
List activities
Query parameters
-
start_time
string
Filters the list by a time range. Thestart_time
is the lower bound of the time range in Internet date and time format. Thestart_time
cannot be greater than one year before theend_time
. -
end_time
string
Filters the list by a time range. Theend_time
is the upper bound of the time range in Internet date and time format. -
next_page_token
number
The zero-relative start index of the list of items in the response. So, the combination ofnext_page_token=1
andpage_size=20
returns the first 20 items. -
page_size
integer
The number of items to return in the list. The maximum value is150
.
Sample Request
curl -v -X GET https://api.sandbox.paypal.com/v1/activities/activities?start_time=2012-01-01T00:00:01.000Z&end_time=2014-10-01T23:59:59.999Z&page_size=10 \
-H "Content-Type: application/json" \
-H "Authorization: Bearer Access-Token"
Response
200 OK
status code and a JSON response body that lists activities.-
items
array (contains the activity object)
An array of activities. -
links
array (contains the link_description object)
An array of request-related HATEOAS links.
Sample Response
{
"items": [
{
"extensions": {
"payment_properties": {
"debit_credit_code": "CREDIT"
}
},
"status": "COMPLETED",
"subtype": "REFUND",
"gross": {
"currency_code": "JPY",
"value": "5000"
},
"counterparty": {
"email": "buyer@example.com",
"name": "Jennifer McVittie"
},
"id": "74M09958P9936162T",
"fee": {
"currency_code": "JPY",
"value": "0"
},
"net": {
"currency_code": "JPY",
"value": "5000"
},
"activity_type": "PAYMENT",
"time_created": "2013-10-29T22:41:08.000Z"
},
{
"extensions": {
"payment_properties": {
"debit_credit_code": "DEBIT"
}
},
"status": "DENIED",
"subtype": "PAYMENT",
"gross": {
"currency_code": "JPY",
"value": "5000"
},
"counterparty": {
"email": "buyer@example.com",
"name": "Jennifer McVittie"
},
"id": "8B290053Y34018504",
"fee": {
"currency_code": "JPY",
"value": "0"
},
"net": {
"currency_code": "JPY",
"value": "5000"
},
"activity_type": "PAYMENT",
"time_created": "2013-10-29T22:40:53.000Z"
},
{
"extensions": {
"payment_properties": {
"debit_credit_code": "CREDIT"
}
},
"gross": {
"currency_code": "USD",
"value": "85.00"
},
"counterparty": {
"name": "PayPal"
},
"subtype": "BONUS",
"status": "COMPLETED",
"fee": {
"currency_code": "USD",
"value": "0.00"
},
"net": {
"currency_code": "USD",
"value": "85.00"
},
"id": "6YH431316S832112L",
"time_created": "2017-04-18T03:31:54.000Z"
}
]
}
Common object definitions
activity
-
id
string
required
The PayPal-generated ID for the activity. -
time_created
string
required
The date and time when the activity was created, in Internet date and time format. -
activity_type
enum
required
Filters the list by one or more activity types. To separate values, use a comma (,
). Value is:Value Description BILLING_AGREEMENT
An agreement for a recurring payment for merchant-provided goods or services. INVOICE
A bill for merchant-provided goods or services. MONEY_REQUEST
A request for money from one party to another. ORDER
An approved purchase without any hold on the funds. PAYMENT
A movement of money from one account to another. PAYOUT
A merchant-initiated simultaneous payment to multiple accounts. Typically a commission, rebate, reward, or general disbursement. RECURRING_PROFILE
A recurring profile. SUBSCRIPTION
A subscription. -
subtype
enum
Filters the list by one or more activity subtypes. Valid only when the activity type isPAYMENT
orBILLING_AGREEMENT
. To separate values, use a comma (,
).- For the
PAYMENT
type, value is:Value Description ADJUSTMENT
Movement of funds between accounts by PayPal to resolve a chargeback or dispute. AUTHORIZATION
Authorized hold of funds by PayPal on a customer’s account. BONUS
PayPal-funded reward or award to a customer's account. CORRECTION
Addition or removal of funds by PayPal. CURRENCY_TRANSFER
Conversion of funds from one currency to another. HOLD
Payment is under review by PayPal. HOLDING_BALANCE_TRANSFER
Transfer of funds from a main PayPal balance account to another PayPal balance account. LOAN
PayPal credit offered to the seller. MONEY_TRANSFER
Transfer of funds from a customer's PayPal account to another funding instrument. PAYMENT
Payment of funds from one entity to another. PAYPAL_CREDIT_PAYMENT
Customer repayment of PayPal-provided credit. REFUND
Receiver-returned payment to the sender, sender-canceled payment, or unclaimed payment within 30 days. REVERSAL
PayPal-initiated return of funds to sender. VOID
Customer-placed authorization or order that no longer applies. - For the
BILLING_AGREEMENT
type, value is:Value Description SUBSCRIPTION_CANCELLATION
Billing agreement is cancelled. SUBSCRIPTION_COMPLETION
Billing agreement is complete. SUBSCRIPTION_CREATION
Billing agreement is created. SUBSCRIPTION_MODIFICATION
Billing agreement is modified.
- For the
-
status
enum
Filters the list by one or more activity statuses. To separate values, use a comma (,
). Value is:Value Description BLOCKED
A non-allowed activity. The payment violates regulations or compliance rules. CANCELED
An initiator-canceled transaction. COMPLETED
A successful transaction. CREATED
A successfully created transaction. DENIED
A sender-initiated payment that a recipient denies. Note: PayPal credits the funds to the sender’s account.
FAILED
A failed transaction. HELD
A temporarily-held transaction. Note: Because a sender disputes or PayPal reviews the transaction, it is temporarily held.
PAID
A paid invoice or money request. PARTIALLY_PAID
A partially-paid transaction. PARTIALLY_REFUNDED
A partially-refunded transaction. PENDING
An in-process payment. REFUNDED
A merchant-initiated refund to a customer. REVERSED
A PayPal-canceled transaction. UNCLAIMED
An unclaimed payment. A recipient did not accept or receive a sender’s payment. Note: PayPal automatically cancels unclaimed transactions after 30 days and credits the funds to the sender’s account.
-
counterparty
The transaction's counter-party. A single-party transaction does not have counter-party information. For example, a single-party transaction might be a currency transfer or a PayPal credit payment. -
fee
The PayPal fees that are associated with this activity, in money format. -
gross
The amount for this activity before fees are applied. -
net
The amount for this activity after fees are applied. -
partner_fee
The partner fees, in money format. -
extensions
The extension properties.
activity_results
-
items
array (contains the activity object)
An array of activities. -
links
array (contains the link_description object)
An array of request-related HATEOAS links.
activity_status
-
activity_status
enum
Filters the list by one or more activity statuses. To separate values, use a comma (,
). Value is:Value Description BLOCKED
A non-allowed activity. The payment violates regulations or compliance rules. CANCELED
An initiator-canceled transaction. COMPLETED
A successful transaction. CREATED
A successfully created transaction. DENIED
A sender-initiated payment that a recipient denies. Note: PayPal credits the funds to the sender’s account.
FAILED
A failed transaction. HELD
A temporarily-held transaction. Note: Because a sender disputes or PayPal reviews the transaction, it is temporarily held.
PAID
A paid invoice or money request. PARTIALLY_PAID
A partially-paid transaction. PARTIALLY_REFUNDED
A partially-refunded transaction. PENDING
An in-process payment. REFUNDED
A merchant-initiated refund to a customer. REVERSED
A PayPal-canceled transaction. UNCLAIMED
An unclaimed payment. A recipient did not accept or receive a sender’s payment. Note: PayPal automatically cancels unclaimed transactions after 30 days and credits the funds to the sender’s account.
activity_subtype
-
activity_subtype
enum
Filters the list by one or more activity subtypes. Valid only when the activity type isPAYMENT
orBILLING_AGREEMENT
. To separate values, use a comma (,
).- For the
PAYMENT
type, value is:Value Description ADJUSTMENT
Movement of funds between accounts by PayPal to resolve a chargeback or dispute. AUTHORIZATION
Authorized hold of funds by PayPal on a customer’s account. BONUS
PayPal-funded reward or award to a customer's account. CORRECTION
Addition or removal of funds by PayPal. CURRENCY_TRANSFER
Conversion of funds from one currency to another. HOLD
Payment is under review by PayPal. HOLDING_BALANCE_TRANSFER
Transfer of funds from a main PayPal balance account to another PayPal balance account. LOAN
PayPal credit offered to the seller. MONEY_TRANSFER
Transfer of funds from a customer's PayPal account to another funding instrument. PAYMENT
Payment of funds from one entity to another. PAYPAL_CREDIT_PAYMENT
Customer repayment of PayPal-provided credit. REFUND
Receiver-returned payment to the sender, sender-canceled payment, or unclaimed payment within 30 days. REVERSAL
PayPal-initiated return of funds to sender. VOID
Customer-placed authorization or order that no longer applies. - For the
BILLING_AGREEMENT
type, value is:Value Description SUBSCRIPTION_CANCELLATION
Billing agreement is cancelled. SUBSCRIPTION_COMPLETION
Billing agreement is complete. SUBSCRIPTION_CREATION
Billing agreement is created. SUBSCRIPTION_MODIFICATION
Billing agreement is modified.
- For the
activity_type
-
activity_type
enum
Filters the list by one or more activity types. To separate values, use a comma (,
). Value is:Value Description BILLING_AGREEMENT
An agreement for a recurring payment for merchant-provided goods or services. INVOICE
A bill for merchant-provided goods or services. MONEY_REQUEST
A request for money from one party to another. ORDER
An approved purchase without any hold on the funds. PAYMENT
A movement of money from one account to another. PAYOUT
A merchant-initiated simultaneous payment to multiple accounts. Typically a commission, rebate, reward, or general disbursement. RECURRING_PROFILE
A recurring profile. SUBSCRIPTION
A subscription.
counterparty
-
email
string
The other party's email address. For unregistered users only. -
phone_number
string
The other party's mobile phone number. -
name
string
The other party's name, which is usually the first and last name or the merchant's store name.
currency_code
-
currency_code
string
The three-character ISO-4217 currency code that identifies the currency.
debit_credit_code
-
debit_credit_code
enum
Filters the transactions in the list by whether the transaction moves money into or out of a PayPal account. Value is:CREDIT
. Includes transactions that move money into a PayPal account.DEBIT
. Includes transactions that move money out of a PayPal account.ALL
. Includes all transactions.
invoice_properties
-
role
The invoice role. -
invoice_number
string
The merchant-provided invoice number for the transaction.
link_description
-
href
string
required
The complete target URL. To make the related call, combine the method with this URI Template-formatted link. For pre-processing, include the$
,(
, and)
characters. Thehref
is the key HATEOAS component that links a completed call with a subsequent call. -
rel
string
required
The link relation type, which serves as an ID for a link that unambiguously describes the semantics of the link. See Link Relations. -
method
enum
The HTTP method required to make the related call.
money
-
The three-character ISO-4217 currency code that identifies the currency.
-
value
string
required
The value, which might be:- An integer for currencies like
JPY
that are not typically fractional. - A decimal fraction for currencies like
TND
that are subdivided into thousandths.
- An integer for currencies like
order_properties
-
role
Filters the list by one or more roles. To separate values, use a comma (,
).
payment_properties
-
debit_credit_code
enum
Filters the transactions in the list by whether the transaction moves money into or out of a PayPal account. Value is:CREDIT
. Includes transactions that move money into a PayPal account.DEBIT
. Includes transactions that move money out of a PayPal account.ALL
. Includes all transactions.
-
buyer_notes
string
The sender message for the transaction. -
order_id
string
The ID of the order. -
billing_agreement_id
string
The ID of the billing agreement. -
subtype_external
enum
Filters the list by one or more external subtypes. To separate values, use a comma (,
). If you include this parameter, the API ignores thesubtype
parameter. -
invoice_number
string
The merchant ID for the transaction.
request_money_properties
-
role
enum
Filters the list by one or more roles. To separate values, use a comma (,
).
role
-
role
enum
Filters the list by one or more roles. To separate values, use a comma (,
).
subtype_external
-
subtype_external
enum
Filters the list by one or more external subtypes. To separate values, use a comma (,
). If you include this parameter, the API ignores thesubtype
parameter.
Additional API information
Error messages
In addition to common HTTP status codes that the REST APIs return, the Activities API can return the following errors.