You can use billing plans and subscriptions to create subscriptions that process recurring PayPal payments for physical or digital goods, or services. A plan includes pricing and billing cycle information that defines the amount and frequency of charge for a subscription. You can also define a fixed plan, such as a $5 basic plan or a volume- or graduated-based plan with pricing tiers based on the quantity purchased. For more information, see Subscriptions Overview.
Creates a plan that defines pricing and billing cycle details for subscriptions.
A successful request returns the HTTP 201 Created
status code and a JSON response body that shows billing plan details.
{- "product_id": "PROD-XXCD1234QWER65782",
- "name": "Video Streaming Service Plan",
- "description": "Video Streaming Service basic plan",
- "status": "ACTIVE",
- "billing_cycles": [
- {
- "frequency": {
- "interval_unit": "MONTH",
- "interval_count": 1
}, - "tenure_type": "TRIAL",
- "sequence": 1,
- "total_cycles": 2,
- "pricing_scheme": {
- "fixed_price": {
- "value": "3",
- "currency_code": "USD"
}
}
}, - {
- "frequency": {
- "interval_unit": "MONTH",
- "interval_count": 1
}, - "tenure_type": "TRIAL",
- "sequence": 2,
- "total_cycles": 3,
- "pricing_scheme": {
- "fixed_price": {
- "value": "6",
- "currency_code": "USD"
}
}
}, - {
- "frequency": {
- "interval_unit": "MONTH",
- "interval_count": 1
}, - "tenure_type": "REGULAR",
- "sequence": 3,
- "total_cycles": 12,
- "pricing_scheme": {
- "fixed_price": {
- "value": "10",
- "currency_code": "USD"
}
}
}
], - "payment_preferences": {
- "auto_bill_outstanding": true,
- "setup_fee": {
- "value": "10",
- "currency_code": "USD"
}, - "setup_fee_failure_action": "CONTINUE",
- "payment_failure_threshold": 3
}, - "taxes": {
- "percentage": "10",
- "inclusive": false
}
}
{- "id": "P-5ML4271244454362WXNWU5NQ",
- "product_id": "PROD-XXCD1234QWER65782",
- "name": "Video Streaming Service Plan",
- "description": "Video Streaming Service basic plan",
- "status": "ACTIVE",
- "billing_cycles": [
- {
- "frequency": {
- "interval_unit": "MONTH",
- "interval_count": 1
}, - "tenure_type": "TRIAL",
- "sequence": 1,
- "total_cycles": 2,
- "pricing_scheme": {
- "fixed_price": {
- "value": "3",
- "currency_code": "USD"
}, - "version": 1,
- "create_time": "2020-05-27T12:13:51Z",
- "update_time": "2020-05-27T12:13:51Z"
}
}, - {
- "frequency": {
- "interval_unit": "MONTH",
- "interval_count": 1
}, - "tenure_type": "TRIAL",
- "sequence": 2,
- "total_cycles": 3,
- "pricing_scheme": {
- "fixed_price": {
- "currency_code": "USD",
- "value": "6"
}, - "version": 1,
- "create_time": "2020-05-27T12:13:51Z",
- "update_time": "2020-05-27T12:13:51Z"
}
}, - {
- "frequency": {
- "interval_unit": "MONTH",
- "interval_count": 1
}, - "tenure_type": "REGULAR",
- "sequence": 3,
- "total_cycles": 12,
- "pricing_scheme": {
- "fixed_price": {
- "currency_code": "USD",
- "value": "10"
}, - "version": 1,
- "create_time": "2020-05-27T12:13:51Z",
- "update_time": "2020-05-27T12:13:51Z"
}
}
], - "payment_preferences": {
- "auto_bill_outstanding": true,
- "setup_fee": {
- "value": "10",
- "currency_code": "USD"
}, - "setup_fee_failure_action": "CONTINUE",
- "payment_failure_threshold": 3
}, - "taxes": {
- "percentage": "10",
- "inclusive": false
}, - "create_time": "2020-05-27T12:13:51Z",
- "update_time": "2020-05-27T12:13:51Z",
- "links": [
- {
- "rel": "self",
- "method": "GET"
}, - {
- "rel": "edit",
- "method": "PATCH"
}, - {
- "rel": "deactivate",
- "method": "POST"
}, - {
- "rel": "edit",
- "method": "POST"
}
]
}
Lists billing plans.
product_id | string [ 6 .. 50 ] characters Filters the response by a Product ID. |
page_size | integer [ 1 .. 20 ] Default: 10 The number of items to return in the response. |
page | integer [ 1 .. 100000 ] Default: 1 A non-zero integer which is the start index of the entire list of items to return in the response. The combination of |
total_required | boolean Default: false Indicates whether to show the total count in the response. |
Prefer | string Default: return=minimal The preferred server response upon successful completion of the request. Value is:
|
A successful request returns the HTTP 200 OK
status code and a JSON response body that lists billing plans.
{ }
{- "plans": [
- {
- "id": "P-9CT60829WM695623HL7QGYOI",
- "name": "Netflix Plan 17012019",
- "status": "ACTIVE",
- "description": "Netflix basic plan",
- "usage_type": "LICENSED",
- "create_time": "2020-12-23T07:08:40Z",
- "links": [
- {
- "rel": "self",
- "method": "GET"
}
]
}, - {
- "id": "P-7CE83846EJ264184CL7QHL3I",
- "name": "Netflix Plan 17012019",
- "status": "CREATED",
- "description": "Netflix basic plan",
- "usage_type": "LICENSED",
- "create_time": "2020-12-23T07:06:08Z",
- "links": [
- {
- "rel": "self",
- "method": "GET"
}
]
}, - {
- "id": "P-1HG35083DU289225LL7QIDKA",
- "name": "Netflix Plan 17012019",
- "status": "ACTIVE",
- "description": "Netflix basic plan",
- "usage_type": "LICENSED",
- "create_time": "2020-12-22T06:41:26Z",
- "links": [
- {
- "rel": "self",
- "method": "GET"
}
]
}, - {
- "id": "P-5V279629EP569145RL7QZKFQ",
- "name": "Netflix Plan 17012019",
- "status": "CREATED",
- "description": "Netflix basic plan",
- "usage_type": "LICENSED",
- "create_time": "2020-12-21T11:06:16Z",
- "links": [
- {
- "rel": "self",
- "method": "GET"
}
]
}, - {
- "id": "P-69D48725TK8139022L7ROYYA",
- "name": "Netflix Plan 17012019",
- "status": "ACTIVE",
- "description": "Netflix basic plan",
- "usage_type": "LICENSED",
- "create_time": "2020-12-21T10:16:13Z",
- "links": [
- {
- "rel": "self",
- "method": "GET"
}
]
}, - {
- "id": "P-87R81207W88552156L7ROZ6A",
- "name": "Netflix Plan 17012019",
- "status": "ACTIVE",
- "description": "Netflix basic plan",
- "usage_type": "LICENSED",
- "create_time": "2020-12-21T09:34:49Z",
- "links": [
- {
- "rel": "self",
- "method": "GET"
}
]
}
], - "links": [
- {
- "rel": "self",
- "method": "GET"
}
]
}
Shows details for a plan, by ID.
A successful request returns the HTTP 200 OK
status code and a JSON response body that shows plan details.
{- "id": "P-5ML4271244454362WXNWU5NQ",
- "product_id": "PROD-XXCD1234QWER65782",
- "name": "Basic Plan",
- "description": "Basic Plan",
- "status": "ACTIVE",
- "billing_cycles": [
- {
- "frequency": {
- "interval_unit": "MONTH",
- "interval_count": 1
}, - "tenure_type": "TRIAL",
- "sequence": 1,
- "total_cycles": 2,
- "pricing_scheme": {
- "fixed_price": {
- "currency_code": "USD",
- "value": "3"
}, - "version": 1,
- "create_time": "2020-05-27T12:13:51Z",
- "update_time": "2020-05-27T12:13:51Z"
}
}, - {
- "frequency": {
- "interval_unit": "MONTH",
- "interval_count": 1
}, - "tenure_type": "TRIAL",
- "sequence": 2,
- "total_cycles": 3,
- "pricing_scheme": {
- "fixed_price": {
- "currency_code": "USD",
- "value": "6"
}, - "version": 1,
- "create_time": "2020-05-27T12:13:51Z",
- "update_time": "2020-05-27T12:13:51Z"
}
}, - {
- "frequency": {
- "interval_unit": "MONTH",
- "interval_count": 1
}, - "tenure_type": "REGULAR",
- "sequence": 3,
- "total_cycles": 12,
- "pricing_scheme": {
- "fixed_price": {
- "value": "10",
- "currency_code": "USD"
}, - "status": "ACTIVE",
- "version": 1,
- "create_time": "2020-05-27T12:13:51Z",
- "update_time": "2020-05-27T12:13:51Z"
}
}
], - "taxes": {
- "percentage": "10",
- "inclusive": false
}, - "create_time": "2020-05-27T12:13:51Z",
- "update_time": "2020-05-27T12:13:51Z",
- "links": [
- {
- "rel": "self",
- "method": "GET"
}, - {
- "rel": "edit",
- "method": "PATCH"
}, - {
- "rel": "deactivate",
- "method": "POST"
}, - {
- "rel": "edit",
- "method": "POST"
}
]
}
Updates a plan with the CREATED
or ACTIVE
status. For an INACTIVE
plan, you can make only status updates.
You can patch these attributes and objects:
Attribute or object | Operations |
---|---|
description | replace |
payment_preferences.auto_bill_outstanding | replace |
taxes.percentage | replace |
payment_preferences.payment_failure_threshold | replace |
payment_preferences.setup_fee | replace |
payment_preferences.setup_fee_failure_action | replace |
name | replace |
op required | string The operation.
| ||||||||||||||||||||||||||
path | string The JSON Pointer to the target document location at which to complete the operation. | ||||||||||||||||||||||||||
value | any (Patch Value) The value to apply. The | ||||||||||||||||||||||||||
from | string The JSON Pointer to the target document location from which to move the value. Required for the |
A successful request returns the HTTP 204 No Content
status code with no JSON response body.
[- {
- "op": "replace",
- "path": "/payment_preferences/payment_failure_threshold",
- "value": 7
}, - {
- "op": "replace",
- "path": "/name",
- "value": "Updated Video Streaming Service Plan"
}
]
{ }
Updates pricing for a plan. For example, you can update a regular billing cycle from $5 per month to $7 per month.
A successful request returns the HTTP 204 No Content
status code with no JSON response body.
{- "pricing_schemes": [
- {
- "billing_cycle_sequence": 1,
- "pricing_scheme": {
- "fixed_price": {
- "value": "50",
- "currency_code": "USD"
}
}
}, - {
- "billing_cycle_sequence": 2,
- "pricing_scheme": {
- "fixed_price": {
- "value": "100",
- "currency_code": "USD"
}, - "pricing_model": "VOLUME",
- "tiers": [
- {
- "starting_quantity": "1",
- "ending_quantity": "1000",
- "amount": {
- "value": "150",
- "currency_code": "USD"
}
}, - {
- "starting_quantity": "1001",
- "amount": {
- "value": "250",
- "currency_code": "USD"
}
}
]
}
}
]
}
{ }
Creates a subscription.
Prefer | string Default: return=minimal The preferred server response upon successful completion of the request. Value is:
|
PayPal-Request-Id | string The server stores keys for 72 hours. |
PayPal-Client-Metadata-Id | string [ 1 .. 36 ] characters The PayPal Client Metadata Id(CMID) is used to provide device-specific information to PayPal's risk engine. This is crucial for transactions that require device-specific risk assessments. Merchants typically use the Paypal SDK that automatically submits the CMID or they use tools like Fraudnet JS for web or Magnes JS for mobile to generate the CMID on the frontend and then pass it to the API as part of the request headers. |
plan_id required | string = 26 characters ^P-[A-Z0-9]*$ The ID of the plan. |
quantity | string [ 1 .. 32 ] characters ^([0-9]+|([0-9]+)?[.][0-9]+)$ The quantity of the product in the subscription. |
auto_renewal | boolean Default: false DEPRECATED. Indicates whether the subscription auto-renews after the billing cycles complete. |
custom_id | string [ 1 .. 127 ] characters ^[\x20-\x7E]+ The custom id for the subscription. Can be invoice id. |
start_time | string <ppaas_date_time_v3> (date_time) [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|... Default: "Current time" The date and time when the subscription started, in Internet date and time format. |
object (Money) The shipping charges. | |
object <payer_v1> (subscriber_request) The subscriber request information . | |
object (application_context) DEPRECATED. The application context, which customizes the payer experience during the subscription approval process with PayPal. | |
object (plan_override) An inline plan object to customise the subscription. You can override plan level default attributes by providing customised values for the subscription in this object. |
A successful request returns the HTTP 201 Created
status code and a JSON response body that shows subscription details.
{- "plan_id": "P-5ML4271244454362WXNWU5NQ",
- "start_time": "2018-11-01T00:00:00Z",
- "quantity": "20",
- "shipping_amount": {
- "currency_code": "USD",
- "value": "10.00"
}, - "subscriber": {
- "name": {
- "given_name": "John",
- "surname": "Doe"
}, - "email_address": "customer@example.com",
- "shipping_address": {
- "name": {
- "full_name": "John Doe"
}, - "address": {
- "address_line_1": "2211 N First Street",
- "address_line_2": "Building 17",
- "admin_area_2": "San Jose",
- "admin_area_1": "CA",
- "postal_code": "95131",
- "country_code": "US"
}
}
}, - "application_context": {
- "brand_name": "walmart",
- "locale": "en-US",
- "shipping_preference": "SET_PROVIDED_ADDRESS",
- "user_action": "SUBSCRIBE_NOW",
- "payment_method": {
- "payer_selected": "PAYPAL",
- "payee_preferred": "IMMEDIATE_PAYMENT_REQUIRED"
},
}
}
{- "id": "I-BW452GLLEP1G",
- "status": "APPROVAL_PENDING",
- "status_update_time": "2018-12-10T21:20:49Z",
- "plan_id": "P-5ML4271244454362WXNWU5NQ",
- "plan_overridden": false,
- "start_time": "2018-11-01T00:00:00Z",
- "quantity": "20",
- "shipping_amount": {
- "currency_code": "USD",
- "value": "10.00"
}, - "subscriber": {
- "name": {
- "given_name": "John",
- "surname": "Doe"
}, - "email_address": "customer@example.com",
- "payer_id": "2BBBB8YJQSCCC",
- "shipping_address": {
- "name": {
- "full_name": "John Doe"
}, - "address": {
- "address_line_1": "2211 N First Street",
- "address_line_2": "Building 17",
- "admin_area_2": "San Jose",
- "admin_area_1": "CA",
- "postal_code": "95131",
- "country_code": "US"
}
}
}, - "create_time": "2018-12-10T21:20:49Z",
- "links": [
- {
- "rel": "approve",
- "method": "GET"
}, - {
- "rel": "edit",
- "method": "PATCH"
}, - {
- "rel": "self",
- "method": "GET"
}
]
}
List all subscriptions for merchant account.
plan_ids | string [ 3 .. 1890 ] Filters the response by list of plan IDs. Filter supports upto |
statuses | string [ 1 .. 70 ] characters ^[A-Z_,]+$ Filters the response by list of subscription statuses. |
created_after | string <ppaas_date_time_v3> [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|... Filters the response by subscription creation start time for a range of subscriptions. |
created_before | string <ppaas_date_time_v3> [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|... Filters the response by subscription creation end time for a range of subscriptions. |
status_updated_before | string <ppaas_date_time_v3> [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|... Filters the response by status update start time for a range of subscriptions. |
status_updated_after | string <ppaas_date_time_v3> [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|... Filters the response by status update end time for a range of subscriptions. |
filter | string [ 0 .. 100 ] characters Filter the response using complex expressions that could use comparison operators like ge, gt, le, lt and logical operators such as 'and' and 'or'. |
page_size | integer [ 1 .. 20 ] Default: 10 The number of items to return in the response. |
page | integer [ 1 .. 10000000 ] Default: 1 A non-zero integer which is the start index of the entire list of items to return in the response. The combination of |
A successful request returns the HTTP 200 OK
status code and a JSON response body that lists the subscriptions.
{ }
{- "subscriptions": [
- {
- "status": "ACTIVE",
- "id": "I-X5CK2V5CR245",
- "auto_renewal": false,
- "create_time": "2020-12-24T11:28:09Z",
- "links": [
- {
- "rel": "self",
- "method": "GET"
}
]
}, - {
- "status": "ACTIVE",
- "id": "I-1VM7B0TV24J8",
- "auto_renewal": false,
- "create_time": "2020-12-24T11:28:08Z",
- "links": [
- {
- "rel": "self",
- "method": "GET"
}
]
}, - {
- "status": "ACTIVE",
- "id": "I-7MKBR4PDE2YU",
- "auto_renewal": false,
- "create_time": "2020-12-24T11:28:07Z",
- "links": [
- {
- "rel": "self",
- "method": "GET"
}
]
}
], - "links": [
- {
- "rel": "self",
- "method": "GET"
}
]
}
Shows details for a subscription, by ID.
A successful request returns the HTTP 200 OK
status code and a JSON response body that shows subscription details.
{- "id": "I-BW452GLLEP1G",
- "plan_id": "P-5ML4271244454362WXNWU5NQ",
- "start_time": "2019-04-10T07:00:00Z",
- "quantity": "20",
- "shipping_amount": {
- "currency_code": "USD",
- "value": "10.0"
}, - "subscriber": {
- "shipping_address": {
- "name": {
- "full_name": "John Doe"
}, - "address": {
- "address_line_1": "2211 N First Street",
- "address_line_2": "Building 17",
- "admin_area_2": "San Jose",
- "admin_area_1": "CA",
- "postal_code": "95131",
- "country_code": "US"
}
}, - "name": {
- "given_name": "John",
- "surname": "Doe"
}, - "email_address": "customer@example.com",
- "payer_id": "2BBBB8YJQSCCC"
}, - "billing_info": {
- "outstanding_balance": {
- "currency_code": "USD",
- "value": "1.0"
}, - "cycle_executions": [
- {
- "tenure_type": "TRIAL",
- "sequence": 1,
- "cycles_completed": 0,
- "cycles_remaining": 2,
- "total_cycles": 2
}, - {
- "tenure_type": "TRIAL",
- "sequence": 2,
- "cycles_completed": 0,
- "cycles_remaining": 3,
- "total_cycles": 3
}, - {
- "tenure_type": "REGULAR",
- "sequence": 3,
- "cycles_completed": 0,
- "cycles_remaining": 12,
- "total_cycles": 12
}
], - "last_payment": {
- "amount": {
- "currency_code": "USD",
- "value": "1.15"
}, - "time": "2019-04-09T10:27:20Z"
}, - "next_billing_time": "2019-04-10T10:00:00Z",
- "failed_payments_count": 0
}, - "create_time": "2019-04-09T10:26:04Z",
- "update_time": "2019-04-09T10:27:27Z",
- "links": [
- {
- "rel": "cancel",
- "method": "POST"
}, - {
- "rel": "edit",
- "method": "PATCH"
}, - {
- "rel": "self",
- "method": "GET"
}, - {
- "rel": "suspend",
- "method": "POST"
}, - {
- "rel": "capture",
- "method": "POST"
}
], - "status": "ACTIVE",
- "status_update_time": "2019-04-09T10:27:27Z"
}
Updates a subscription which could be in ACTIVE
or SUSPENDED
status. You can override plan level default attributes by providing customised values for plan path in the patch request.
Attribute or object | Operations |
---|---|
billing_info.outstanding_balance | replace |
custom_id | add,replace |
plan.billing_cycles[@sequence==n]. | add,replace |
plan.billing_cycles[@sequence==n]. | replace |
plan.billing_cycles[@sequence==n]. | replace |
plan.payment_preferences. | replace |
plan.payment_preferences. | replace |
plan.taxes.inclusive | add,replace |
plan.taxes.percentage | add,replace |
shipping_amount | add,replace |
start_time | replace |
subscriber.shipping_address | add,replace |
subscriber.payment_source (for subscriptions funded | replace |
op required | string The operation.
| ||||||||||||||||||||||||||
path | string The JSON Pointer to the target document location at which to complete the operation. | ||||||||||||||||||||||||||
value | any (Patch Value) The value to apply. The | ||||||||||||||||||||||||||
from | string The JSON Pointer to the target document location from which to move the value. Required for the |
A successful request returns the HTTP 204 No Content
status code with no JSON response body.
[- {
- "op": "replace",
- "path": "/plan/billing_cycles/@sequence==1/pricing_scheme/fixed_price",
- "value": {
- "currency_code": "USD",
- "value": "50.00"
}
}, - {
- "op": "replace",
- "path": "/plan/billing_cycles/@sequence==2/pricing_scheme/tiers",
- "value": [
- {
- "starting_quantity": "1",
- "ending_quantity": "1000",
- "amount": {
- "value": "500",
- "currency_code": "USD"
}
}, - {
- "starting_quantity": "1001",
- "amount": {
- "value": "2000",
- "currency_code": "USD"
}
}
]
}, - {
- "op": "replace",
- "path": "/plan/payment_preferences/auto_bill_outstanding",
- "value": true
}, - {
- "op": "replace",
- "path": "/plan/payment_preferences/payment_failure_threshold",
- "value": 1
}, - {
- "op": "replace",
- "path": "/plan/taxes/percentage",
- "value": "10"
}
]
{ }
Updates the quantity of the product or service in a subscription. You can also use this method to switch the plan and update the shipping_amount
, shipping_address
values for the subscription. This type of update requires the buyer's consent.
plan_id | string = 26 characters ^P-[A-Z0-9]*$ The unique PayPal-generated ID for the plan. |
quantity | string [ 1 .. 32 ] characters ^([0-9]+|([0-9]+)?[.][0-9]+)$ The quantity of the product or service in the subscription. |
object (Money) The shipping charges. | |
object (shipping_detail) The shipping address of the subscriber. | |
object (application_context) The application context, which customizes the payer experience during the subscription approval process with PayPal. | |
object (plan_override) An inline plan object to customise the subscription. You can override plan level default attributes by providing customised values for the subscription in this object. Any existing overrides will not be carried forward during subscription revise. |
A successful request returns the HTTP 200 OK
status code and a JSON response body that shows subscription details.
{- "plan_id": "P-5ML4271244454362WXNWU5NQ",
- "shipping_amount": {
- "currency_code": "USD",
- "value": "10.00"
}, - "shipping_address": {
- "name": {
- "full_name": "John Doe"
}, - "address": {
- "address_line_1": "2211 N First Street",
- "address_line_2": "Building 17",
- "admin_area_2": "San Jose",
- "admin_area_1": "CA",
- "postal_code": "95131",
- "country_code": "US"
}
}, - "application_context": {
- "brand_name": "walmart",
- "locale": "en-US",
- "shipping_preference": "SET_PROVIDED_ADDRESS",
- "payment_method": {
- "payer_selected": "PAYPAL",
- "payee_preferred": "IMMEDIATE_PAYMENT_REQUIRED"
},
}
}
{- "plan_id": "P-5ML4271244454362WXNWU5NQ",
- "plan_overridden": false,
- "shipping_amount": {
- "currency_code": "USD",
- "value": "10.00"
}, - "shipping_address": {
- "name": {
- "full_name": "John Doe"
}, - "address": {
- "address_line_1": "2211 N First Street",
- "address_line_2": "Building 17",
- "admin_area_2": "San Jose",
- "admin_area_1": "CA",
- "postal_code": "95131",
- "country_code": "US"
}
}, - "links": [
- {
- "rel": "approve",
- "method": "GET"
}, - {
- "rel": "edit",
- "method": "PATCH"
}, - {
- "rel": "self",
- "method": "GET"
}, - {
- "rel": "cancel",
- "method": "POST"
}, - {
- "rel": "suspend",
- "method": "POST"
}, - {
- "rel": "capture",
- "method": "POST"
}
]
}
Suspends the subscription.
A successful request returns the HTTP 204 No Content
status code with no JSON response body.
{- "reason": "Item out of stock"
}
{ }
Cancels the subscription.
A successful request returns the HTTP 204 No Content
status code with no JSON response body.
{- "reason": "Not satisfied with the service"
}
{ }
Activates the subscription.
A successful request returns the HTTP 204 No Content
status code with no JSON response body.
{- "reason": "Reactivating the subscription"
}
{ }
Captures an authorized payment from the subscriber on the subscription.
note required | string [ 1 .. 128 ] characters ^.*$ The reason or note for the subscription charge. | ||||
capture_type required | string [ 1 .. 24 ] characters ^[A-Z_]+$ The type of capture.
| ||||
required | object (Money) The currency and amount for a financial transaction, such as a balance or payment due. |
Request Accepted.
{- "note": "Charging as the balance reached the limit",
- "capture_type": "OUTSTANDING_BALANCE",
- "amount": {
- "currency_code": "USD",
- "value": "100"
}
}
{ }
Lists transactions for a subscription.
start_time required | string <ppaas_date_time_v3> [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|... The start time of the range of transactions to list. |
end_time required | string <ppaas_date_time_v3> [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|... The end time of the range of transactions to list. |
A successful request returns the HTTP 200 OK
status code and a JSON response body that shows subscription details.
{- "transactions": [
- {
- "id": "TRFGHNJKOIIOJKL",
- "status": "COMPLETED",
- "payer_email": "customer@example.com",
- "payer_name": {
- "given_name": "John",
- "surname": "Doe"
}, - "amount_with_breakdown": {
- "gross_amount": {
- "currency_code": "USD",
- "value": "10.00"
}, - "fee_amount": {
- "currency_code": "USD",
- "value": "1.00"
}, - "net_amount": {
- "currency_code": "USD",
- "value": "9.00"
}
}, - "time": "2018-03-16T07:40:20.940Z"
}, - {
- "id": "VDFG45345FFGS",
- "status": "COMPLETED",
- "payer_email": "customer2@example.com",
- "payer_name": {
- "given_name": "Jhonny",
- "surname": "Cat"
}, - "amount_with_breakdown": {
- "gross_amount": {
- "currency_code": "USD",
- "value": "15.00"
}, - "fee_amount": {
- "currency_code": "USD",
- "value": "1.00"
}, - "net_amount": {
- "currency_code": "USD",
- "value": "14.00"
}
}, - "time": "2018-08-21T07:50:20.940Z"
}
], - "links": [
- {
- "rel": "self",
- "method": "GET"
}
]
}
This contains the URL details for the instrument. This is to be used by User Interfaces to render appropriate experience when card art images cannot be retrieved.
type | string (URL type) [ 1 .. 100 ] characters ^[0-9A-Z_]+$ Type of a URL e.g. terms & conditions or settings etc.
| ||||||
url | string <uri> (url) Institution specific URL. |
{- "type": "SETTINGS",
}
The breakdown details for the amount. Includes the gross, tax, fee, and shipping amounts.
required | object (Money) The amount for this transaction. |
object (Money) The item total for the transaction. | |
object (Money) The fee details for the transaction. | |
object (Money) The shipping amount for the transaction. | |
object (Money) The tax amount for the transaction. | |
object (Money) The net amount that the payee receives for this transaction in their PayPal account. The net amount is computed as |
{- "gross_amount": {
- "currency_code": "str",
- "value": "string"
}, - "total_item_amount": {
- "currency_code": "str",
- "value": "string"
}, - "fee_amount": {
- "currency_code": "str",
- "value": "string"
}, - "shipping_amount": {
- "currency_code": "str",
- "value": "string"
}, - "tax_amount": {
- "currency_code": "str",
- "value": "string"
}, - "net_amount": {
- "currency_code": "str",
- "value": "string"
}
}
The application context, which customizes the payer experience during the subscription approval process with PayPal.
brand_name | string [ 1 .. 127 ] characters ^.*$ The label that overrides the business name in the PayPal account on the PayPal site. | ||||||||
shipping_preference | string [ 1 .. 24 ] characters ^[A-Z_]+$ Default: "GET_FROM_FILE" The location from which the shipping address is derived.
| ||||||||
user_action | string [ 1 .. 24 ] characters ^[A-Z_]+$ Default: "SUBSCRIBE_NOW" Configures the label name to
| ||||||||
return_url required | string <uri> [ 10 .. 4000 ] characters The URL where the customer is redirected after the customer approves the payment. | ||||||||
cancel_url required | string <uri> [ 10 .. 4000 ] characters The URL where the customer is redirected after the customer cancels the payment. | ||||||||
locale | string <ppaas_common_language_v3> (language) [ 2 .. 10 ] characters ^[a-z]{2}(?:-[A-Z][a-z]{3})?(?:-(?:[A-Z]{2}|[... The BCP 47-formatted locale of pages that the PayPal payment experience shows. PayPal supports a five-character code. For example, | ||||||||
object (payment_method) The customer and merchant payment preferences. Currently only PAYPAL payment method is supported. |
{- "brand_name": "string",
- "shipping_preference": "GET_FROM_FILE",
- "user_action": "CONTINUE",
- "locale": "string",
- "payment_method": {
- "payee_preferred": "UNRESTRICTED"
}
}
The application context, which customizes the payer experience during the subscription approval process with PayPal.
brand_name | string [ 1 .. 127 ] characters ^.*$ The label that overrides the business name in the PayPal account on the PayPal site. | ||||||||
shipping_preference | string [ 1 .. 24 ] characters ^[A-Z_]+$ Default: "GET_FROM_FILE" The location from which the shipping address is derived.
| ||||||||
return_url required | string <uri> [ 10 .. 4000 ] characters The URL where the customer is redirected after the customer approves the payment. | ||||||||
cancel_url required | string <uri> [ 10 .. 4000 ] characters The URL where the customer is redirected after the customer cancels the payment. | ||||||||
locale | string <ppaas_common_language_v3> (language) [ 2 .. 10 ] characters ^[a-z]{2}(?:-[A-Z][a-z]{3})?(?:-(?:[A-Z]{2}|[... The BCP 47-formatted locale of pages that the PayPal payment experience shows. PayPal supports a five-character code. For example, | ||||||||
object (payment_method) The customer and merchant payment preferences. Currently only PAYPAL payment method is supported. |
{- "brand_name": "string",
- "shipping_preference": "GET_FROM_FILE",
- "locale": "string",
- "payment_method": {
- "payee_preferred": "UNRESTRICTED"
}
}
Results of Authentication such as 3D Secure.
liability_shift | string (liability_shift) [ 1 .. 255 ] characters ^[0-9A-Z_]+$ Liability shift indicator. The outcome of the issuer's authentication.
| ||||||||
object (three_d_secure_authentication_response) Results of 3D Secure Authentication. |
{- "liability_shift": "NO",
- "three_d_secure": {
- "authentication_status": "Y",
- "enrollment_status": "Y"
}
}
The PayPal Balance to fund a payment.
id | string [ 1 .. 16 ] characters ^([0-9A-Z]+-?[0-9A-Z]+)$ The PayPal-generated ID for the Balance Funding Instrument. |
{- "id": "string"
}
The billing cycle details.
tenure_type required | string [ 1 .. 24 ] characters ^[A-Z_]+$ The tenure type of the billing cycle. In case of a plan having trial cycle, only 2 trial cycles are allowed per plan.
| ||||||
sequence required | integer [ 1 .. 99 ] The order in which this cycle is to run among other billing cycles. For example, a trial billing cycle has a | ||||||
total_cycles | integer [ 0 .. 999 ] Default: 1 The number of times this billing cycle gets executed. Trial billing cycles can only be executed a finite number of times (value between | ||||||
object (pricing_scheme) The active pricing scheme for this billing cycle. A free trial billing cycle does not require a pricing scheme. | |||||||
required | object (frequency) The frequency details for this billing cycle. |
{- "tenure_type": "REGULAR",
- "sequence": 1,
- "total_cycles": 1,
- "pricing_scheme": {
- "version": 999,
- "pricing_model": "VOLUME",
- "tiers": [
- {
- "starting_quantity": "string",
- "ending_quantity": "string",
- "amount": {
- "currency_code": "str",
- "value": "string"
}
}
], - "fixed_price": {
- "currency_code": "str",
- "value": "string"
}, - "create_time": "string",
- "update_time": "string"
}, - "frequency": {
- "interval_unit": "DAY",
- "interval_count": 1
}
}
The billing cycle details to override at subscription level. The subscription billing cycle definition has to adhere to the plan billing cycle definition.
sequence required | integer [ 1 .. 99 ] The order in which this cycle is to run among other billing cycles. For example, a trial billing cycle has a |
total_cycles | integer [ 0 .. 999 ] The number of times this billing cycle gets executed. Trial billing cycles can only be executed a finite number of times (value between |
object (pricing_scheme) The active pricing scheme for this billing cycle. A free trial billing cycle does not require a pricing scheme. |
{- "sequence": 1,
- "total_cycles": 999,
- "pricing_scheme": {
- "version": 999,
- "pricing_model": "VOLUME",
- "tiers": [
- {
- "starting_quantity": "string",
- "ending_quantity": "string",
- "amount": {
- "currency_code": "str",
- "value": "string"
}
}
], - "fixed_price": {
- "currency_code": "str",
- "value": "string"
}, - "create_time": "string",
- "update_time": "string"
}
}
Bank Identification Number (BIN) details used to fund a payment.
bin | string [ 1 .. 25 ] characters ^[0-9]+$ The Bank Identification Number (BIN) signifies the number that is being used to identify the granular level details (except the PII information) of the card. |
issuing_bank | string [ 1 .. 64 ] characters The issuer of the card instrument. |
products | Array of strings [ 1 .. 256 ] items The type of card product assigned to the BIN by the issuer. These values are defined by the issuer and may change over time. Some examples include: PREPAID_GIFT, CONSUMER, CORPORATE. |
bin_country_code | string <ppaas_common_country_code_v2> (country_code) = 2 characters ^([A-Z]{2}|C2)$ The two-character ISO-3166-1 country code of the bank. |
{- "bin": "string",
- "issuing_bank": "string",
- "products": [
- "string"
], - "bin_country_code": "string"
}
The financial instrument (FI) capabilities.
name | string [ 1 .. 255 ] characters ^[0-9A-Z_]+$ Capability name.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
mode | string [ 1 .. 255 ] characters ^[0-9A-Z_]+$ The supported financial instrument (FI) mode.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (Network) [ 1 .. 100 ] items Networks for the Financial instrument. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
capability_initiator | string (capability_initiator) [ 1 .. 255 ] characters ^[0-9A-Z_]+$ Initiator of money movement.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
operation_type | string (Operation Type) [ 1 .. 255 ] characters ^[0-9A-Z_]+$ Operation type.
|
{- "name": "INSTALLMENT",
- "mode": "NON_REAL_TIME",
- "networks": [
- {
- "preferred": true,
- "cross_border_transaction_supported": true,
- "supported_currencies": [
- "str"
], - "transfer_type": "WIRE",
- "mandate_enforcement": "SEPA",
- "network_rules": [
- "string"
], - "name": "ACCEL"
}
], - "capability_initiator": "PAYPAL",
- "operation_type": "CAPABILITY_OP_SINK"
}
Initiator of money movement.
Initiator of money movement.
Enum Value | Description |
---|---|
PAYPAL | Indicates PayPal initiate the money movement. |
EXTERNAL | Indicates the money movement initiate from the external. |
"PAYPAL"
The status and status details of a captured payment.
status | string (Capture Status) The status of the captured payment.
|
{- "status": "COMPLETED"
}
The status and status details of a captured payment.
status | string (Capture Status) The status of the captured payment.
|
{- "status": "COMPLETED"
}
The details of the captured payment status.
reason | string (Capture Incomplete Reason) [ 1 .. 64 ] characters ^[A-Z_]+$ The reason why the captured payment status is
|
{- "reason": "BUYER_COMPLAINT"
}
The payment card to use to fund a payment. Can be a credit or debit card.
name | string [ 1 .. 300 ] characters ^.{1,300}$ The card holder's name as it appears on the card. | ||||||||||||||||||||||||||||||||||||||||||||||||||||
number | string [ 13 .. 19 ] characters ^[0-9]{13,19}$ The primary account number (PAN) for the payment card. | ||||||||||||||||||||||||||||||||||||||||||||||||||||
security_code | string [ 3 .. 4 ] characters ^[0-9]{3,4}$ The three- or four-digit security code of the card. Also known as the CVV, CVC, CVN, CVE, or CID. This parameter cannot be present in the request when | ||||||||||||||||||||||||||||||||||||||||||||||||||||
expiry | string (date_year_month) = 7 characters ^[0-9]{4}-(0[1-9]|1[0-2])$ The card expiration year and month, in Internet date format For example: 2028-04 | ||||||||||||||||||||||||||||||||||||||||||||||||||||
type | string (card_type) [ 1 .. 255 ] characters ^[A-Z_]+$ The payment card type.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||
brand | string (card_brand) [ 1 .. 255 ] characters ^[A-Z_]+$ The card brand or network. Typically used in the response.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Portable Postal Address (Medium-Grained)) The billing address for this card. Supports only the | |||||||||||||||||||||||||||||||||||||||||||||||||||||
object (card_attributes) Additional attributes associated with the use of this card. |
{- "name": "string",
- "number": "stringstrings",
- "security_code": "stri",
- "expiry": "string",
- "type": "CREDIT",
- "brand": "VISA",
- "billing_address": {
- "address_line_1": "string",
- "address_line_2": "string",
- "admin_area_2": "string",
- "admin_area_1": "string",
- "postal_code": "string",
- "country_code": "st"
}, - "attributes": {
- "customer": {
- "id": "string",
- "email_address": "string",
- "phone": {
- "phone_type": "FAX",
- "phone_number": {
- "national_number": "string"
}
}, - "merchant_customer_id": "string"
}, - "vault": {
- "store_in_vault": "ON_SUCCESS"
}, - "verification": {
- "method": "SCA_ALWAYS"
}
}
}
The payment card to use to fund a payment. Can be a credit or debit card.
name | string [ 1 .. 300 ] characters ^.{1,300}$ The card holder's name as it appears on the card. | ||||||||||||||||||||||||||||||||||||||||||||||||||||
number | string [ 13 .. 19 ] characters ^[0-9]{13,19}$ The primary account number (PAN) for the payment card. | ||||||||||||||||||||||||||||||||||||||||||||||||||||
security_code | string [ 3 .. 4 ] characters ^[0-9]{3,4}$ The three- or four-digit security code of the card. Also known as the CVV, CVC, CVN, CVE, or CID. This parameter cannot be present in the request when | ||||||||||||||||||||||||||||||||||||||||||||||||||||
expiry | string (date_year_month) = 7 characters ^[0-9]{4}-(0[1-9]|1[0-2])$ The card expiration year and month, in Internet date format For example: 2028-04 | ||||||||||||||||||||||||||||||||||||||||||||||||||||
type | string (card_type) [ 1 .. 255 ] characters ^[A-Z_]+$ The payment card type.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||
brand | string (card_brand) [ 1 .. 255 ] characters ^[A-Z_]+$ The card brand or network. Typically used in the response.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Portable Postal Address (Medium-Grained)) The billing address for this card. Supports only the | |||||||||||||||||||||||||||||||||||||||||||||||||||||
object (card_attributes) Additional attributes associated with the use of this card. |
{- "name": "string",
- "number": "stringstrings",
- "security_code": "stri",
- "expiry": "string",
- "type": "CREDIT",
- "brand": "VISA",
- "billing_address": {
- "address_line_1": "string",
- "address_line_2": "string",
- "admin_area_2": "string",
- "admin_area_1": "string",
- "postal_code": "string",
- "country_code": "st"
}, - "attributes": {
- "customer": {
- "id": "string",
- "email_address": "string",
- "phone": {
- "phone_type": "FAX",
- "phone_number": {
- "national_number": "string"
}
}, - "merchant_customer_id": "string"
}, - "vault": {
- "store_in_vault": "ON_SUCCESS"
}, - "verification": {
- "method": "SCA_ALWAYS"
}
}
}
The API caller can opt in to verify the card through PayPal offered verification services (e.g. Smart Dollar Auth, 3DS).
method | string [ 1 .. 255 ] characters ^[0-9A-Z_]+$ Default: "SCA_WHEN_REQUIRED" The method used for card verification.
|
{- "method": "SCA_ALWAYS"
}
Additional attributes associated with the use of this card.
object (card_customer) The details about a customer in PayPal's system of record. | |
object (vault_instruction_base) Instruction to vault the card based on the specified strategy. | |
object (Card Verification) Instruction to optionally verify the card based on the specified strategy. |
{- "customer": {
- "id": "string",
- "email_address": "string",
- "phone": {
- "phone_type": "FAX",
- "phone_number": {
- "national_number": "string"
}
}, - "merchant_customer_id": "string"
}, - "vault": {
- "store_in_vault": "ON_SUCCESS"
}, - "verification": {
- "method": "SCA_ALWAYS"
}
}
Additional attributes associated with the use of this card.
object (card_vault_response) The details about a saved Card payment source. |
{- "vault": {
- "id": "string",
- "status": "VAULTED",
- "links": [
- {
- "href": "string",
- "rel": "string",
- "method": "GET"
}
], - "customer": {
- "id": "string",
- "email_address": "string",
- "phone": {
- "phone_type": "FAX",
- "phone_number": {
- "national_number": "string"
}
}, - "merchant_customer_id": "string"
}
}
}
The card network or brand. Applies to credit, debit, gift, and payment cards.
The card network or brand. Applies to credit, debit, gift, and payment cards.
Enum Value | Description |
---|---|
VISA | Visa card. |
MASTERCARD | Mastercard card. |
DISCOVER | Discover card. |
AMEX | American Express card. |
SOLO | Solo debit card. |
JCB | Japan Credit Bureau card. |
STAR | Military Star card. |
DELTA | Delta Airlines card. |
SWITCH | Switch credit card. |
MAESTRO | Maestro credit card. |
CB_NATIONALE | Carte Bancaire (CB) credit card. |
CONFIGOGA | Configoga credit card. |
CONFIDIS | Confidis credit card. |
ELECTRON | Visa Electron credit card. |
CETELEM | Cetelem credit card. |
CHINA_UNION_PAY | China union pay credit card. |
DINERS | The Diners Club International banking and payment services capability network owned by Discover Financial Services (DFS), one of the most recognized brands in US financial services. |
ELO | The Brazilian Elo card payment network. |
HIPER | The Hiper - Ingenico ePayment network. |
HIPERCARD | The Brazilian Hipercard payment network that's widely accepted in the retail market. |
RUPAY | The RuPay payment network. |
GE | The GE Credit Union 3Point card payment network. |
SYNCHRONY | The Synchrony Financial (SYF) payment network. |
EFTPOS | The Electronic Fund Transfer At Point of Sale(EFTPOS) Debit card payment network. |
UNKNOWN | UNKNOWN payment network. |
"VISA"
The details about a customer in PayPal's system of record.
id | string (merchant_partner_customer_id) [ 1 .. 22 ] characters ^[0-9a-zA-Z_-]+$ The unique ID for a customer generated by PayPal. |
email_address | string <merchant_common_email_address_v2> (email) [ 3 .. 254 ] characters (?:[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-zA-... Email address of the buyer as provided to the merchant or on file with the merchant. Email Address is required if you are processing the transaction using PayPal Guest Processing which is offered to select partners and merchants. For all other use cases we do not expect partners/merchant to send email_address of their customer. |
object (phone_with_type) The phone number of the buyer as provided to the merchant or on file with the merchant. The | |
merchant_customer_id | string [ 1 .. 64 ] characters ^[0-9a-zA-Z-_.^*$@#]+$ Merchants and partners may already have a data-store where their customer information is persisted. Use merchant_customer_id to associate the PayPal-generated customer.id to your representation of a customer. |
{- "id": "string",
- "email_address": "string",
- "phone": {
- "phone_type": "FAX",
- "phone_number": {
- "national_number": "string"
}
}, - "merchant_customer_id": "string"
}
Representation of card details as received in the request.
last_digits | string [ 2 .. 4 ] characters [0-9]{2,} The last digits of the payment card. |
expiry | string (date_year_month) = 7 characters ^[0-9]{4}-(0[1-9]|1[0-2])$ The card expiration year and month, in Internet date format. |
{- "last_digits": "stri",
- "expiry": "string"
}
The payment card to use to fund a payment. Card can be a credit or debit card.
name | string [ 2 .. 300 ] characters The card holder's name as it appears on the card. | ||||||||||||||||||||||||||||||||||||||||||||||||||||
last_digits | string[0-9]{2,} The last digits of the payment card. | ||||||||||||||||||||||||||||||||||||||||||||||||||||
available_networks | Array of strings (card_brand) [ 1 .. 256 ] items Array of brands or networks associated with the card.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||
object (card_from_request) Representation of card details as received in the request. | |||||||||||||||||||||||||||||||||||||||||||||||||||||
object (card_stored_credential) Provides additional details to process a payment using a
| |||||||||||||||||||||||||||||||||||||||||||||||||||||
brand | string (card_brand) [ 1 .. 255 ] characters ^[A-Z_]+$ The card brand or network. Typically used in the response.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||
type | string (card_type) [ 1 .. 255 ] characters ^[A-Z_]+$ The payment card type.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||
object (authentication_response) Results of Authentication such as 3D Secure. | |||||||||||||||||||||||||||||||||||||||||||||||||||||
object (card_attributes_response) Additional attributes associated with the use of this card. | |||||||||||||||||||||||||||||||||||||||||||||||||||||
expiry | string (date_year_month) = 7 characters ^[0-9]{4}-(0[1-9]|1[0-2])$ The card expiration year and month, in Internet date format. | ||||||||||||||||||||||||||||||||||||||||||||||||||||
object (bin_details) Bank Identification Number (BIN) details used to fund a payment. |
{- "name": "string",
- "last_digits": "string",
- "available_networks": [
- "VISA"
], - "from_request": {
- "last_digits": "stri",
- "expiry": "string"
}, - "stored_credential": {
- "payment_initiator": "CUSTOMER",
- "payment_type": "ONE_TIME",
- "usage": "FIRST",
- "previous_network_transaction_reference": {
- "id": "stringstr",
- "date": "stri",
- "acquirer_reference_number": "string",
- "network": "VISA"
}
}, - "brand": "VISA",
- "type": "CREDIT",
- "authentication_result": {
- "liability_shift": "NO",
- "three_d_secure": {
- "authentication_status": "Y",
- "enrollment_status": "Y"
}
}, - "attributes": {
- "vault": {
- "id": "string",
- "status": "VAULTED",
- "links": [
- {
- "href": "string",
- "rel": "string",
- "method": "GET"
}
], - "customer": {
- "id": "string",
- "email_address": "string",
- "phone": {
- "phone_type": "FAX",
- "phone_number": {
- "national_number": "string"
}
}, - "merchant_customer_id": "string"
}
}
}, - "expiry": "string",
- "bin_details": {
- "bin": "string",
- "issuing_bank": "string",
- "products": [
- "string"
], - "bin_country_code": "string"
}
}
The payment card used to fund the payment. Card can be a credit or debit card.
name | string [ 2 .. 300 ] characters The card holder's name as it appears on the card. | ||||||||||||||||||||||||||||||||||||||||||||||||||||
last_digits | string[0-9]{2,} The last digits of the payment card. | ||||||||||||||||||||||||||||||||||||||||||||||||||||
available_networks | Array of strings (card_brand) [ 1 .. 256 ] items Array of brands or networks associated with the card.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||
object (card_from_request) Representation of card details as received in the request. | |||||||||||||||||||||||||||||||||||||||||||||||||||||
object (card_stored_credential) Provides additional details to process a payment using a
| |||||||||||||||||||||||||||||||||||||||||||||||||||||
brand | string (card_brand) [ 1 .. 255 ] characters ^[A-Z_]+$ The card brand or network. Typically used in the response.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||
type | string (card_type) [ 1 .. 255 ] characters ^[A-Z_]+$ The payment card type.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||
object (authentication_response) Results of Authentication such as 3D Secure. | |||||||||||||||||||||||||||||||||||||||||||||||||||||
object (card_attributes_response) Additional attributes associated with the use of this card. | |||||||||||||||||||||||||||||||||||||||||||||||||||||
expiry | string (date_year_month) = 7 characters ^[0-9]{4}-(0[1-9]|1[0-2])$ The card expiration year and month, in Internet date format. | ||||||||||||||||||||||||||||||||||||||||||||||||||||
object (bin_details) Bank Identification Number (BIN) details used to fund a payment. | |||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Portable Postal Address (Medium-Grained)) The portable international postal address. Maps to AddressValidationMetadata and HTML 5.1 Autofilling form controls: the autocomplete attribute. | |||||||||||||||||||||||||||||||||||||||||||||||||||||
currency_code | string <ppaas_common_currency_code_v2> (currency_code) = 3 characters Currency code of the given instrument |
{- "name": "string",
- "last_digits": "string",
- "available_networks": [
- "VISA"
], - "from_request": {
- "last_digits": "stri",
- "expiry": "string"
}, - "stored_credential": {
- "payment_initiator": "CUSTOMER",
- "payment_type": "ONE_TIME",
- "usage": "FIRST",
- "previous_network_transaction_reference": {
- "id": "stringstr",
- "date": "stri",
- "acquirer_reference_number": "string",
- "network": "VISA"
}
}, - "brand": "VISA",
- "type": "CREDIT",
- "authentication_result": {
- "liability_shift": "NO",
- "three_d_secure": {
- "authentication_status": "Y",
- "enrollment_status": "Y"
}
}, - "attributes": {
- "vault": {
- "id": "string",
- "status": "VAULTED",
- "links": [
- {
- "href": "string",
- "rel": "string",
- "method": "GET"
}
], - "customer": {
- "id": "string",
- "email_address": "string",
- "phone": {
- "phone_type": "FAX",
- "phone_number": {
- "national_number": "string"
}
}, - "merchant_customer_id": "string"
}
}
}, - "expiry": "string",
- "bin_details": {
- "bin": "string",
- "issuing_bank": "string",
- "products": [
- "string"
], - "bin_country_code": "string"
}, - "billing_address": {
- "address_line_1": "string",
- "address_line_2": "string",
- "admin_area_2": "string",
- "admin_area_1": "string",
- "postal_code": "string",
- "country_code": "st"
}, - "currency_code": "string"
}
Provides additional details to process a payment using a card
that has been stored or is intended to be stored (also referred to as stored_credential or card-on-file).
Parameter compatibility:
payment_type=ONE_TIME
is compatible only with payment_initiator=CUSTOMER
.usage=FIRST
is compatible only with payment_initiator=CUSTOMER
.previous_transaction_reference
or previous_network_transaction_reference
is compatible only with payment_initiator=MERCHANT
.previous_transaction_reference
and previous_network_transaction_reference
- can be present in the request.payment_initiator required | string (payment_initiator) [ 1 .. 255 ] characters ^[0-9A-Z_]+$ The person or party who initiated or triggered the payment.
| ||||||||
payment_type required | string (stored_payment_source_payment_type) [ 1 .. 255 ] characters ^[0-9A-Z_]+$ Indicates the type of the stored payment_source payment.
| ||||||||
usage | string (stored_payment_source_usage_type) [ 1 .. 255 ] characters ^[0-9A-Z_]+$ Default: "DERIVED" Indicates if this is a
| ||||||||
object (network_transaction_reference) Reference values used by the card network to identify a transaction. |
{- "payment_initiator": "CUSTOMER",
- "payment_type": "ONE_TIME",
- "usage": "FIRST",
- "previous_network_transaction_reference": {
- "id": "stringstr",
- "date": "stri",
- "acquirer_reference_number": "string",
- "network": "VISA"
}
}
Type of card. i.e Credit, Debit and so on.
Type of card. i.e Credit, Debit and so on.
Enum Value | Description |
---|---|
CREDIT | A credit card. |
DEBIT | A debit card. |
PREPAID | A Prepaid card. |
STORE | A store card. |
UNKNOWN | Card type cannot be determined. |
"CREDIT"
The details about a saved Card payment source.
id | string [ 1 .. 255 ] characters The PayPal-generated ID for the saved payment source. | ||||||||
status | string (Vault Status) [ 1 .. 255 ] characters ^[0-9A-Z_]+$ The vault status.
| ||||||||
Array of objects (Link Description) [ 1 .. 10 ] items An array of request-related HATEOAS links. | |||||||||
object (card_customer) The details about a customer in PayPal's system of record. |
{- "id": "string",
- "status": "VAULTED",
- "links": [
- {
- "href": "string",
- "rel": "string",
- "method": "GET"
}
], - "customer": {
- "id": "string",
- "email_address": "string",
- "phone": {
- "phone_type": "FAX",
- "phone_number": {
- "national_number": "string"
}
}, - "merchant_customer_id": "string"
}
}
The 2-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain isGB
and notUK
as used in the top-level domain names for that country. Use theC2
country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.
The 2-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain isGB
and notUK
as used in the top-level domain names for that country. Use theC2
country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.
"st"
The two-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain isGB
and notUK
as used in the top-level domain names for that country. Use theC2
country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.
The two-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain isGB
and notUK
as used in the top-level domain names for that country. Use theC2
country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.
"st"
The three-character ISO-4217 currency code that identifies the currency.
The three-character ISO-4217 currency code that identifies the currency.
"str"
The 3-character ISO-4217 currency code that identifies the currency.
The 3-character ISO-4217 currency code that identifies the currency.
"str"
The decimal precision to be used for a currency.
The decimal precision to be used for a currency.
50
The details about a customer in PayPal's system of record.
id | string (merchant_partner_customer_id) [ 1 .. 22 ] characters ^[0-9a-zA-Z_-]+$ The unique ID for a customer generated by PayPal. |
{- "id": "string"
}
The details about a customer in PayPal's system of record.
id | string (merchant_partner_customer_id) [ 1 .. 22 ] characters ^[0-9a-zA-Z_-]+$ The unique ID for a customer generated by PayPal. |
email_address | string <merchant_common_email_address_v2> (email) [ 3 .. 254 ] characters (?:[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-zA-... Email address of the buyer as provided to the merchant or on file with the merchant. Email Address is required if you are processing the transaction using PayPal Guest Processing which is offered to select partners and merchants. For all other use cases we do not expect partners/merchant to send email_address of their customer. |
object (phone_with_type) The phone number of the buyer as provided to the merchant or on file with the merchant. The |
{- "id": "string",
- "email_address": "string",
- "phone": {
- "phone_type": "FAX",
- "phone_number": {
- "national_number": "string"
}
}
}
The regular and trial execution details for a billing cycle.
tenure_type required | string [ 1 .. 24 ] characters ^[A-Z_]+$ The type of the billing cycle.
| ||||||
sequence required | integer [ 0 .. 99 ] The order in which to run this cycle among other billing cycles. | ||||||
cycles_completed required | integer [ 0 .. 9999 ] The number of billing cycles that have completed. | ||||||
cycles_remaining | integer [ 0 .. 9999 ] For a finite billing cycle, cycles_remaining is the number of remaining cycles. For an infinite billing cycle, cycles_remaining is set as 0. | ||||||
current_pricing_scheme_version | integer [ 1 .. 99 ] The active pricing scheme version for the billing cycle. | ||||||
total_cycles | integer [ 0 .. 999 ] The number of times this billing cycle gets executed. Trial billing cycles can only be executed a finite number of times (value between |
{- "tenure_type": "REGULAR",
- "sequence": 99,
- "cycles_completed": 9999,
- "cycles_remaining": 9999,
- "current_pricing_scheme_version": 1,
- "total_cycles": 999
}
The stand-alone date, in Internet date and time format. To represent special legal values, such as a date of birth, you should use dates with no associated time or time-zone data. Whenever possible, use the standard date_time
type. This regular expression does not validate all dates. For example, February 31 is valid and nothing is known about leap years.
The stand-alone date, in Internet date and time format. To represent special legal values, such as a date of birth, you should use dates with no associated time or time-zone data. Whenever possible, use the standard date_time
type. This regular expression does not validate all dates. For example, February 31 is valid and nothing is known about leap years.
"stringstri"
The date and time, in Internet date and time format. Seconds are required while fractional seconds are optional.
Note: The regular expression provides guidance but does not reject all invalid dates.
The date and time, in Internet date and time format. Seconds are required while fractional seconds are optional.
Note: The regular expression provides guidance but does not reject all invalid dates.
"stringstringstringst"
The date and time, in Internet date and time format. Seconds are required while fractional seconds are optional.
Note: The regular expression provides guidance but does not reject all invalid dates.
The date and time, in Internet date and time format. Seconds are required while fractional seconds are optional.
Note: The regular expression provides guidance but does not reject all invalid dates.
"stringstringstringst"
The year and month, in ISO-8601 YYYY-MM
date format. See Internet date and time format.
The year and month, in ISO-8601 YYYY-MM
date format. See Internet date and time format.
"strings"
The year and month, in ISO-8601 YYYY-MM
date format. See Internet date and time format.
The year and month, in ISO-8601 YYYY-MM
date format. See Internet date and time format.
"strings"
The type of the denomination.
The type of the denomination.
Enum Value | Description |
---|---|
CURRENCY | The currency denomination type. |
REWARDS_CURRENCY | The rewards currency denomination type. |
"CURRENCY"
A statement that describes the information of a field. Unicode is supported.
A statement that describes the information of a field. Unicode is supported.
"string"
The internationalized email address.
Note: Up to 64 characters are allowed before and 255 characters are allowed after the@
sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted@
sign exists.
The internationalized email address.
Note: Up to 64 characters are allowed before and 255 characters are allowed after the@
sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted@
sign exists.
"string"
The internationalized email address.
Note: Up to 64 characters are allowed before and 255 characters are allowed after the@
sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted@
sign exists.
The internationalized email address.
Note: Up to 64 characters are allowed before and 255 characters are allowed after the@
sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted@
sign exists.
"string"
The internationalized email address.
Note: Up to 64 characters are allowed before and 255 characters are allowed after the@
sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted@
sign exists.
The internationalized email address.
Note: Up to 64 characters are allowed before and 255 characters are allowed after the@
sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted@
sign exists.
"string"
Status of Authentication eligibility.
Status of Authentication eligibility.
Enum Value | Description |
---|---|
Y | Yes. The bank is participating in 3-D Secure protocol and will return the ACSUrl. |
N | No. The bank is not participating in 3-D Secure protocol. |
U | Unavailable. The DS or ACS is not available for authentication at the time of the request. |
B | Bypass. The merchant authentication rule is triggered to bypass authentication. |
"Y"
The error details.
name required | string The human-readable, unique name of the error. |
message required | string The message that describes the error. |
debug_id required | string The PayPal internal ID. Used for correlation purposes. |
information_link | string The information link, or URI, that shows detailed information about this error for the developer. |
Array of objects (Error Details) An array of additional details about the error. | |
Array of objects (Link Description) An array of request-related HATEOAS links. |
{- "name": "string",
- "message": "string",
- "debug_id": "string",
- "information_link": "string",
- "details": [
- {
- "field": "string",
- "value": "string",
- "location": "body",
- "issue": "string",
- "description": "string",
- "links": [
- {
- "href": "string",
- "rel": "string",
- "method": "GET"
}
]
}
], - "links": [
- {
- "href": "string",
- "rel": "string",
- "method": "GET"
}
]
}
The error details. Required for client-side 4XX
errors.
field | string The field that caused the error. If this field is in the body, set this value to the field's JSON pointer value. Required for client-side errors. |
value | string The value of the field that caused the error. |
location | string Default: "body" The location of the field that caused the error. Value is |
issue required | string The unique, fine-grained application-level error code. |
description | string The human-readable description for an issue. The description can change over the lifetime of an API, so clients must not depend on this value. |
Array of objects (Link Description) [ 1 .. 4 ] items An array of request-related HATEOAS links that are either relevant to the issue by providing additional information or offering potential resolutions. |
{- "field": "string",
- "value": "string",
- "location": "body",
- "issue": "string",
- "description": "string",
- "links": [
- {
- "href": "string",
- "rel": "string",
- "method": "GET"
}
]
}
The error details. Required for client-side 4XX
errors.
field | string The field that caused the error. If this field is in the body, set this value to the field's JSON pointer value. Required for client-side errors. |
value | string The value of the field that caused the error. |
location | string Default: "body" The location of the field that caused the error. Value is |
issue required | string The unique, fine-grained application-level error code. |
description | string The human-readable description for an issue. The description can change over the lifetime of an API, so clients must not depend on this value. |
{- "field": "string",
- "value": "string",
- "location": "body",
- "issue": "string",
- "description": "string"
}
The resource object that specifies the evaluate funding options api response which returns the evaluated eligible funding options that can be used by the buyer for billing agreement or subscription sign-up.
Array of objects (Link Description) [ 1 .. 10 ] items An array of request-related HATEOAS links. |
{- "links": [
- {
- "href": "string",
- "rel": "string",
- "method": "GET"
}
]
}
Holds the external reference identifier of the instrument.
Holds the external reference identifier of the instrument.
"string"
The details for the failed payment of the subscription.
reason_code | string [ 1 .. 120 ] characters ^[A-Z_]+$ The reason code for the payment failure.
| ||||||||||||||||||
required | object (Money) The failed payment amount. | ||||||||||||||||||
time required | string <ppaas_date_time_v3> (date_time) [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|... The date and time when the failed payment was made, in Internet date and time format. | ||||||||||||||||||
next_payment_retry_time | string <ppaas_date_time_v3> (date_time) [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|... The time when the retry attempt for the failed payment occurs, in Internet date and time format. |
{- "reason_code": "PAYMENT_DENIED",
- "amount": {
- "currency_code": "str",
- "value": "string"
}, - "time": "string",
- "next_payment_retry_time": "string"
}
The float value. Also allows for negative values needed for rewards/balances.
The float value. Also allows for negative values needed for rewards/balances.
"string"
The frequency of the billing cycle.
interval_unit required | string [ 1 .. 24 ] characters ^[A-Z_]+$ The interval at which the subscription is charged or billed.
| ||||||||||
interval_count | integer [ 1 .. 365 ] Default: 1 The number of intervals after which a subscriber is billed. For example, if the
|
{- "interval_unit": "DAY",
- "interval_count": 1
}
The full name of the party, for example, the name of a cardholder.
name | string [ 1 .. 300 ] characters The full representation of a name, for example, |
{- "name": "string"
}
Full Name of an entity, use this in cases like native name on a bank account.
name required | string [ 1 .. 300 ] characters The full representation of a name, for example, | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
orthography | string (Orthography Type) = 4 characters ^[A-Z][a-z]{3}$ The script in which the name is provided like English, Kanji, etc.
|
{- "name": "string",
- "orthography": "Zyyy"
}
The instrument account number in HMAC format.
The instrument account number in HMAC format.
"string"
The display category for an image.
The display category for an image.
Enum Value | Description |
---|---|
PRIMARY | The image is intended to display a financial institution. |
WALLET | The image is intended to display a financial institution wallet. |
THUMBNAIL | The image is intended for thumbnail display. |
REWARD | The image is intended to display a reward program. |
PAYMENT_TOKEN | The image is intended to display a payment token program. |
STACK_VIEW | The image is intended for stack view display. |
"PRIMARY"
The type of image location.
The type of image location.
Enum Value | Description |
---|---|
INTERNAL | The image is located in the PayPal Content Delivery Network (CDN). |
EXTERNAL | The image is located outside of PayPal. |
"INTERNAL"
Institution art details including image content and metadata.
original_mime_type | string [ 1 .. 255 ] characters ^[A-Za-z0-9-_.+/=\s]* The original image format specified in Web MIME Type form. For example, a PNG image would be represented as | ||||||
original_width | integer [ 0 .. 2147483647 ] The width of the original image in pixels. | ||||||
original_height | integer [ 0 .. 2147483647 ] The height of the original image in pixels. | ||||||
background_color | string [ 1 .. 32 ] characters ^[A-Za-z0-9-_.+/=\s]+ The background color of the UI or display space for the card, in CSS-style hexadecimal format, such as 0x0f21a2. | ||||||
foreground_color | string [ 1 .. 32 ] characters ^[A-Za-z0-9-_.+/=\s]+ The foreground color of the UI or display space for the card, in CSS-style hexadecimal format, such as 0x0f21a2. | ||||||
label_color | string [ 1 .. 32 ] characters ^[A-Za-z0-9-_.+/=\s]+ The label color of the UI or display space for the card, in CSS-style hexadecimal format, such as 0x0f21a2. | ||||||
location_type | string (Image location type) [ 1 .. 100 ] characters ^[0-9A-Z_]+$ Type of image location.
| ||||||
image_path | string <uri> (url) The image's location. | ||||||
path_format_type | string (Path format) [ 1 .. 100 ] characters ^[0-9A-Z_]+$ The path format for this image link.
|
{- "original_mime_type": "string",
- "original_width": 2147483647,
- "original_height": 2147483647,
- "background_color": "string",
- "foreground_color": "string",
- "label_color": "string",
- "location_type": "INTERNAL",
- "path_format_type": "ABSOLUTE"
}
Contains image details along with how image has been categorized.
Array of objects (Institution art details) [ 1 .. 50 ] items Institution Art Details including image content and metadata. | |||||||||||||||
image_classification | string [ 1 .. 32 ] characters ^[A-Z]+$ Describes source of image.
| ||||||||||||||
category | string (Image category) [ 1 .. 255 ] characters ^[0-9A-Z_]+$ A category of all the images.
|
{- "image_details": [
- {
- "original_mime_type": "string",
- "original_width": 2147483647,
- "original_height": 2147483647,
- "background_color": "string",
- "foreground_color": "string",
- "label_color": "string",
- "location_type": "INTERNAL",
- "path_format_type": "ABSOLUTE"
}
], - "image_classification": "NETWORK",
- "category": "PRIMARY"
}
The wallet instrument state. Indicates whether the financial instrument (FI) is available for payments and verification.
The wallet instrument state. Indicates whether the financial instrument (FI) is available for payments and verification.
Enum Value | Description |
---|---|
ACTIVE | FI State active. |
BLOCKED | FI State blocked. Should not be exposed externally. |
INACTIVE | FI State inactive. |
ON_HOLD | FI State on hold. Should not be exposed externally. |
REMOVED | FI State removed. |
NOT_CREATED | FI State not created. |
CLOSED | FI State closed. |
"ACTIVE"
The identifier of the instrument.
The identifier of the instrument.
"string"
The language tag for the language in which to localize the error-related strings, such as messages, issues, and suggested actions. The tag is made up of the ISO 639-2 language code, the optional ISO-15924 script tag, and the ISO-3166 alpha-2 country code or M49 region code.
The language tag for the language in which to localize the error-related strings, such as messages, issues, and suggested actions. The tag is made up of the ISO 639-2 language code, the optional ISO-15924 script tag, and the ISO-3166 alpha-2 country code or M49 region code.
"string"
The details for the last payment.
status | string (Capture Status) The status of the captured payment.
| ||||||||||||||
required | object (Money) The last payment amount. | ||||||||||||||
time required | string <ppaas_date_time_v3> (date_time) [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|... The date and time when the last payment was made, in Internet date and time format. |
{- "status": "COMPLETED",
- "amount": {
- "currency_code": "str",
- "value": "string"
}, - "time": "string"
}
Liability shift indicator. The outcome of the issuer's authentication.
Liability shift indicator. The outcome of the issuer's authentication.
Enum Value | Description |
---|---|
NO | Liability is with the merchant. |
POSSIBLE | Liability may shift to the card issuer. |
UNKNOWN | The authentication system is not available. |
"NO"
The request-related HATEOAS link information.
href required | string The complete target URL. To make the related call, combine the method with this URI Template-formatted link. For pre-processing, include the |
rel required | string The link relation type, which serves as an ID for a link that unambiguously describes the semantics of the link. See Link Relations. |
method | string The HTTP method required to make the related call. |
{- "href": "string",
- "rel": "string",
- "method": "GET"
}
The request-related HATEOAS link information.
href required | string The complete target URL. To make the related call, combine the method with this URI Template-formatted link. For pre-processing, include the |
rel required | string The link relation type, which serves as an ID for a link that unambiguously describes the semantics of the link. See Link Relations. |
method | string The HTTP method required to make the related call. |
{- "href": "string",
- "rel": "string",
- "method": "GET"
}
The capability network.
The capability network.
Enum Value | Description |
---|---|
ACCEL | Indicates ACCEL network support for given instrument. |
AMEX | Indicates AMEX network support for given instrument.. |
BACS | Indicates BACS network support for given instrument. |
BML | Indicates BML network support for given instrument. |
CB_NATIONALE | Indicates CB_NATIONALE network support for given instrument. |
CET | Indicates CET network support for given instrument. |
CETELEM | Indicates CETELEM network support for given instrument. |
CHAPS | Indicates CHAPS network support for given instrument. |
CHASENET | Indicates CHASENET network support for given instrument. |
CHINA_UNION_PAY | Indicates CHINA_UNION_PAY network support for given instrument. |
COFIDIS | Indicates COFIDIS network support for given instrument. |
COFINOGA | Indicates COFINOGA network support for given instrument. |
DELTA | Indicates DELTA network support for given instrument. |
DINERS | Indicates DINERS network support for given instrument. |
DISCOVER | Indicates DISCOVER network support for given instrument. |
EFTPOS | Indicates EFTPOS network support for given instrument. |
ELECTRON | Indicates ELECTRON network support for given instrument. |
ELO | Indicates ELO network support for given instrument. |
FPS | Indicates FPS network support for given instrument. |
GE | Indicates GE network support for given instrument. |
HIPER | Indicates HIPER network support for given instrument. |
HIPERCARD | Indicates HIPERCARD network support for given instrument. |
IAV_YODLEE | Indicates IAV_YODLEE network support for given instrument. |
JCB | Indicates JCB network support for given instrument. |
LOCAL | Indicates LOCAL network support for given instrument. |
MAESTRO | Indicates MAESTRO network support for given instrument. |
MASTER_CARD | Indicates MASTER_CARD network support for given instrument. |
NYCE | Indicates NYCE network support for given instrument. |
OPEN_WALLET | Indicates OPEN_WALLET network support for given instrument. |
PAYPAL | Indicates PAYPAL network support for given instrument. |
POSTEPAY | Indicates POSTEPAY network support for given instrument. |
PULSE | Indicates PULSE network support for given instrument. |
PWMB | Indicates PWMB network support for given instrument. |
RUPAY | Indicates RUPAY network support for given instrument. |
SAN | Indicates SAN network support for given instrument. |
SEPA | Indicates SEPA network support for given instrument. |
SEPA_COR1 | Indicates SEPA_COR1 network support for given instrument. |
SEPA_CORE | Indicates SEPA_CORE network support for given instrument. |
SOLO | Indicates SOLO network support for given instrument. |
SSG | Indicates SSG network support for given instrument. |
STAR | Indicates STAR network support for given instrument. |
STAR_FINANZ | Indicates STAR_FINANZ network support for given instrument. |
STAR_ACCESS | Indicates STAR_ACCESS network support for given instrument. |
SWITCH | Indicates SWITCH network support for given instrument. |
VISA | Indicates VISA network support for given instrument. |
WIRE | Indicates WIRE network support for given instrument. |
FASTER_CLEARING | Indicates FASTER_CLEARING network support for given instrument. |
SYNCHRONY_FINANCIAL_SUPPORT | Indicates Synchrony Financial network support for given instrument. |
REAL_TIME_PAYMENTS | Indicates REAL_TIME_PAYMENTS network support for given instrument. |
"ACCEL"
The unique ID for a customer generated by PayPal.
The unique ID for a customer generated by PayPal.
"string"
The currency and amount for a financial transaction, such as a balance or payment due.
currency_code required | string <ppaas_common_currency_code_v2> (currency_code) = 3 characters The three-character ISO-4217 currency code that identifies the currency. |
value required | string <= 32 characters ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$ The value, which might be:
|
{- "currency_code": "str",
- "value": "string"
}
The currency and amount for a financial transaction, such as a balance or payment due.
currency_code required | string <ppaas_common_currency_code_v2> (currency_code) = 3 characters The 3-character ISO-4217 currency code that identifies the currency. |
value required | string <= 32 characters ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$ The value, which might be:
|
{- "currency_code": "str",
- "value": "string"
}
The name of the party.
given_name | string <= 140 characters When the party is a person, the party's given, or first, name. |
surname | string <= 140 characters When the party is a person, the party's surname or family name. Also known as the last name. Required when the party is a person. Use also to store multiple surnames including the matronymic, or mother's, surname. |
{- "given_name": "string",
- "surname": "string"
}
The name of the party.
full_name | string <= 300 characters When the party is a person, the party's full name. |
{- "full_name": "string"
}
The name of the party.
prefix | string <= 140 characters The prefix, or title, to the party's name. |
given_name | string <= 140 characters When the party is a person, the party's given, or first, name. |
surname | string <= 140 characters When the party is a person, the party's surname or family name. Also known as the last name. Required when the party is a person. Use also to store multiple surnames including the matronymic, or mother's, surname. |
middle_name | string <= 140 characters When the party is a person, the party's middle name. Use also to store multiple middle names including the patronymic, or father's, middle name. |
suffix | string <= 140 characters The suffix for the party's name. |
full_name | string <= 300 characters When the party is a person, the party's full name. |
{- "prefix": "string",
- "given_name": "string",
- "surname": "string",
- "middle_name": "string",
- "suffix": "string",
- "full_name": "string"
}
The name of the party.
given_name | string <= 140 characters When the party is a person, the party's given, or first, name. |
surname | string <= 140 characters When the party is a person, the party's surname or family name. Also known as the last name. Required when the party is a person. Use also to store multiple surnames including the matronymic, or mother's, surname. |
{- "given_name": "string",
- "surname": "string"
}
The capability network.
preferred | boolean Indicates whether the network is the preferred network to complete the operation. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
cross_border_transaction_supported | boolean Is cross border transaction supported. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
supported_currencies | Array of strings <ppaas_common_currency_code_v2> (currency_code) [ 1 .. 100 ] items Supported currencies for the instrument. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
transfer_type | string [ 1 .. 255 ] characters ^[0-9A-Z_]+$ Transfer type for particular network.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
mandate_enforcement | string [ 1 .. 255 ] characters ^[0-9A-Z_]+$ Mandate enforcement for the network.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
network_rules | Array of strings [ 1 .. 100 ] items Specific rules associated with Network. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
name | string (List of network names) [ 1 .. 255 ] characters ^[0-9A-Z_]+$ The capability Network.
|
{- "preferred": true,
- "cross_border_transaction_supported": true,
- "supported_currencies": [
- "str"
], - "transfer_type": "WIRE",
- "mandate_enforcement": "SEPA",
- "network_rules": [
- "string"
], - "name": "ACCEL"
}
Reference values used by the card network to identify a transaction.
id required | string [ 9 .. 36 ] characters ^[a-zA-Z0-9-_@.:&+=*^'~#!$%()]+$ Transaction reference id returned by the scheme. For Visa and Amex, this is the "Tran id" field in response. For MasterCard, this is the "BankNet reference id" field in response. For Discover, this is the "NRID" field in response. The pattern we expect for this field from Visa/Amex/CB/Discover is numeric, Mastercard/BNPP is alphanumeric and Paysecure is alphanumeric with special character -. | ||||||||||||||||||||||||||||||||||||||||||||||||||||
date | string = 4 characters ^[0-9]+$ The date that the transaction was authorized by the scheme. This field may not be returned for all networks. MasterCard refers to this field as "BankNet reference date. | ||||||||||||||||||||||||||||||||||||||||||||||||||||
acquirer_reference_number | string [ 1 .. 36 ] characters ^[a-zA-Z0-9]+$ Reference ID issued for the card transaction. This ID can be used to track the transaction across processors, card brands and issuing banks. | ||||||||||||||||||||||||||||||||||||||||||||||||||||
network | string (card_brand) [ 1 .. 255 ] characters ^[A-Z_]+$ Name of the card network through which the transaction was routed.
|
{- "id": "stringstr",
- "date": "stri",
- "acquirer_reference_number": "string",
- "network": "VISA"
}
The Operation.
The Operation.
Enum Value | Description |
---|---|
CAPABILITY_OP_SINK | CAPABILITY_OP_SINK. |
CAPABILITY_OP_SOURCE | CAPABILITY_OP_SOURCE. |
CAPABILITY_OP_READ | CAPABILITY_OP_READ. |
READ | READ. |
SINK | SINK. |
SOURCE | SOURCE. |
"CAPABILITY_OP_SINK"
The orthography type based on the ISO 15924 names for scripts. Scipts are chosen based on most widely used writing systems.
The orthography type based on the ISO 15924 names for scripts. Scipts are chosen based on most widely used writing systems.
Enum Value | Description |
---|---|
Zyyy | The orthography cannot be determined. |
Zzzz | The orthography is unknown. |
Kana | An angular form of Japanese writing for words of foreign origin. |
Cyrl | The Slavic languages alphabet. Used in eastern Europe. |
Arab | The Arabic language alphabet. |
Armn | The Armenian alphabet. |
Beng | The Bengali alphabet. Used in eastern India. |
Cans | The Unified Canadian Aboriginal Syllabics alphabet. |
Deva | The Devanagari (Nagari) alphabet. |
Ethi | The Ethiopic alphabet. |
Geor | The Georgian (Mkhedruli and Mtavruli) alphabet. |
Grek | The Greek alphabet. |
Gujr | The Gujurati language alphabet. Used in western India. |
Guru | The Gurmukhi alphabet. Used in the northern Indian state of Punjab. |
Hani | The Han (Hanzi, Kanji, Hanja) alphabet. |
Hebr | The Hebrew alphabet. |
Java | The Javanese alphabet. |
Jpan | The Japanese (alias for Han + Hiragana + Katakana) alphabet. |
Khmr | The Khmer alphabet. |
Knda | The Kannada alphabet. Used in the southern Indian state of Karnataka. |
Kore | Korean (alias for Hangul + Han). |
Laoo | The Lao alphabet. |
Latn | The Latin alphabet. |
Mlym | The Malayalam alphabet. Used in the southern Indian state of Kerala. |
Mong | The Mongolian alphabet. |
Mymr | The Myanmar (Burmese) alphabet. |
Orya | The Oriya (Odia) alphabet. Used in the eastern Indian state of Odisha. |
Sinh | The Sinhala alphabet. |
Sund | The Sundanese alphabet. |
Syrc | The Syriac alphabet. |
Taml | The Tamil alphabet. Used in the southern Indian state of Tamilnadu. |
Telu | The Telugu language alphabet. Used in the southern Indian state of Andhra pradesh. |
Thaa | The Thaana (Maldivian) alphabet. |
Thai | The Thai alphabet. Used in Thailand. |
Tibt | The Tibetan alphabet. |
Yiii | The Yi alphabet. |
"Zyyy"
Transactions status result identifier. The outcome of the issuer's authentication.
Transactions status result identifier. The outcome of the issuer's authentication.
Enum Value | Description |
---|---|
Y | Successful authentication. |
N | Failed authentication / account not verified / transaction denied. |
U | Unable to complete authentication. |
A | Successful attempts transaction. |
C | Challenge required for authentication. |
R | Authentication rejected (merchant must not submit for authorization). |
D | Challenge required; decoupled authentication confirmed. |
I | Informational only; 3DS requestor challenge preference acknowledged. |
"Y"
The JSON patch object to apply partial updates to resources.
op required | string The operation.
| ||||||||||||||||||||||||||
path | string The JSON Pointer to the target document location at which to complete the operation. | ||||||||||||||||||||||||||
value | any (Patch Value) The value to apply. The | ||||||||||||||||||||||||||
from | string The JSON Pointer to the target document location from which to move the value. Required for the |
{- "op": "add",
- "path": "string",
- "value": null,
- "from": "string"
}
An array of JSON patch objects to apply partial updates to resources.
op required | string The operation.
| ||||||||||||||||||||||||||
path | string The JSON Pointer to the target document location at which to complete the operation. | ||||||||||||||||||||||||||
value | any (Patch Value) The value to apply. The | ||||||||||||||||||||||||||
from | string The JSON Pointer to the target document location from which to move the value. Required for the |
[- {
- "op": "add",
- "path": "string",
- "value": null,
- "from": "string"
}
]
Provides path format for the image.
Provides path format for the image.
Enum Value | Description |
---|---|
ABSOLUTE | Complete path is given not the CDN. |
PARTIAL | Partial path is given e.g. CDN and a specific size can be requested. |
"ABSOLUTE"
The merchant-preferred payment methods.
The merchant-preferred payment methods.
Enum Value | Description |
---|---|
UNRESTRICTED | Accepts any type of payment from the customer. |
IMMEDIATE_PAYMENT_REQUIRED | Accepts only immediate payment from the customer. For example, credit card, PayPal balance, or instant ACH. Ensures that at the time of capture, the payment does not have the |
"UNRESTRICTED"
The customer who approves and pays for the order. The customer is also known as the payer.
email_address | string <merchant_common_email_address_v2> (email) [ 3 .. 254 ] characters (?:[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-zA-... The email address of the payer. |
payer_id | string <ppaas_payer_id_v3> (PayPal Account Identifier) = 13 characters ^[2-9A-HJ-NP-Z]{13}$ The PayPal-assigned ID for the payer. |
object (Name) The name of the payer. Supports only the | |
object (phone_with_type) The phone number of the customer. Available only when you enable the Contact Telephone Number option in the Profile & Settings for the merchant's PayPal account. The |
{- "email_address": "string",
- "payer_id": "string",
- "name": {
- "given_name": "string",
- "surname": "string"
}, - "phone": {
- "phone_type": "FAX",
- "phone_number": {
- "national_number": "string"
}
}
}
The customer who approves and pays for the order. The customer is also known as the payer.
email_address | string <merchant_common_email_address_v2> (email) [ 3 .. 254 ] characters (?:[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-zA-... The email address of the payer. |
payer_id | string <ppaas_payer_id_v3> (PayPal Account Identifier) = 13 characters ^[2-9A-HJ-NP-Z]{13}$ The PayPal-assigned ID for the payer. |
object (Name) The name of the payer. Supports only the | |
object (phone_with_type) The phone number of the customer. Available only when you enable the Contact Telephone Number option in the Profile & Settings for the merchant's PayPal account. The |
{- "email_address": "string",
- "payer_id": "string",
- "name": {
- "given_name": "string",
- "surname": "string"
}, - "phone": {
- "phone_type": "FAX",
- "phone_number": {
- "national_number": "string"
}
}
}
The customer who approves and pays for the order. The customer is also known as the payer.
email_address | string <merchant_common_email_address_v2> (email) [ 3 .. 254 ] characters (?:[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-zA-... The email address of the payer. |
payer_id | string <ppaas_payer_id_v3> (PayPal Account Identifier) = 13 characters ^[2-9A-HJ-NP-Z]{13}$ The PayPal-assigned ID for the payer. |
{- "email_address": "string",
- "payer_id": "string"
}
The person or party who initiated or triggered the payment.
The person or party who initiated or triggered the payment.
Enum Value | Description |
---|---|
CUSTOMER | Payment is initiated with the active engagement of the customer. e.g. a customer checking out on a merchant website. |
MERCHANT | Payment is initiated by merchant on behalf of the customer without the active engagement of customer. e.g. a merchant charging the monthly payment of a subscription to the customer. |
"CUSTOMER"
The customer and merchant payment preferences.
payee_preferred | string (payee_payment_method_preference) [ 1 .. 255 ] characters ^[0-9A-Z_]+$ Default: "UNRESTRICTED" The merchant-preferred payment methods.
|
{- "payee_preferred": "UNRESTRICTED"
}
The payment preferences for a subscription.
auto_bill_outstanding | boolean Default: true Indicates whether to automatically bill the outstanding amount in the next billing cycle. | ||||||
setup_fee_failure_action | string [ 1 .. 24 ] characters ^[A-Z_]+$ Default: "CANCEL" The action to take on the subscription if the initial payment for the setup fails.
| ||||||
payment_failure_threshold | integer [ 0 .. 999 ] Default: 0 The maximum number of payment failures before a subscription is suspended. For example, if | ||||||
object (Money) The initial set-up fee for the service. |
{- "auto_bill_outstanding": true,
- "setup_fee_failure_action": "CONTINUE",
- "payment_failure_threshold": 0,
- "setup_fee": {
- "currency_code": "str",
- "value": "string"
}
}
The payment preferences to override at subscription level.
auto_bill_outstanding | boolean Indicates whether to automatically bill the outstanding amount in the next billing cycle. | ||||||
setup_fee_failure_action | string [ 1 .. 24 ] characters ^[A-Z_]+$ The action to take on the subscription if the initial payment for the setup fails.
| ||||||
payment_failure_threshold | integer [ 0 .. 999 ] The maximum number of payment failures before a subscription is suspended. For example, if | ||||||
object (Money) The initial set-up fee for the service. |
{- "auto_bill_outstanding": true,
- "setup_fee_failure_action": "CONTINUE",
- "payment_failure_threshold": 999,
- "setup_fee": {
- "currency_code": "str",
- "value": "string"
}
}
The payment source definition. To be eligible to create subscription using debit or credit card, you will need to sign up here (https://www.paypal.com/bizsignup/entry/product/ppcp). Please note, its available only for non-3DS cards and for merchants in US and AU regions.
object (card) The payment card to use to fund a payment. Can be a credit or debit card. |
{- "card": {
- "name": "string",
- "number": "stringstrings",
- "security_code": "stri",
- "expiry": "string",
- "type": "CREDIT",
- "brand": "VISA",
- "billing_address": {
- "address_line_1": "string",
- "address_line_2": "string",
- "admin_area_2": "string",
- "admin_area_1": "string",
- "postal_code": "string",
- "country_code": "st"
}, - "attributes": {
- "customer": {
- "id": "string",
- "email_address": "string",
- "phone": {
- "phone_type": "FAX",
- "phone_number": {
- "national_number": "string"
}
}, - "merchant_customer_id": "string"
}, - "vault": {
- "store_in_vault": "ON_SUCCESS"
}, - "verification": {
- "method": "SCA_ALWAYS"
}
}
}
}
The payment source used to fund the payment.
object (card_response_with_billing_address) The payment card used to fund the payment. Card can be a credit or debit card. |
{- "card": {
- "name": "string",
- "last_digits": "string",
- "available_networks": [
- "VISA"
], - "from_request": {
- "last_digits": "stri",
- "expiry": "string"
}, - "stored_credential": {
- "payment_initiator": "CUSTOMER",
- "payment_type": "ONE_TIME",
- "usage": "FIRST",
- "previous_network_transaction_reference": {
- "id": "stringstr",
- "date": "stri",
- "acquirer_reference_number": "string",
- "network": "VISA"
}
}, - "brand": "VISA",
- "type": "CREDIT",
- "authentication_result": {
- "liability_shift": "NO",
- "three_d_secure": {
- "authentication_status": "Y",
- "enrollment_status": "Y"
}
}, - "attributes": {
- "vault": {
- "id": "string",
- "status": "VAULTED",
- "links": [
- {
- "href": "string",
- "rel": "string",
- "method": "GET"
}
], - "customer": {
- "id": "string",
- "email_address": "string",
- "phone": {
- "phone_type": "FAX",
- "phone_number": {
- "national_number": "string"
}
}, - "merchant_customer_id": "string"
}
}
}, - "expiry": "string",
- "bin_details": {
- "bin": "string",
- "issuing_bank": "string",
- "products": [
- "string"
], - "bin_country_code": "string"
}, - "billing_address": {
- "address_line_1": "string",
- "address_line_2": "string",
- "admin_area_2": "string",
- "admin_area_1": "string",
- "postal_code": "string",
- "country_code": "st"
}, - "currency_code": "string"
}
}
The account identifier for a PayPal account.
The account identifier for a PayPal account.
"stringstrings"
The details about a customer in PayPal's system of record.
id | string (merchant_partner_customer_id) [ 1 .. 22 ] characters ^[0-9a-zA-Z_-]+$ The unique ID for a customer generated by PayPal. |
merchant_customer_id | string [ 1 .. 64 ] characters ^[0-9a-zA-Z-_.^*$@#]+$ Merchants and partners may already have a data-store where their customer information is persisted. Use merchant_customer_id to associate the PayPal-generated customer.id to your representation of a customer. |
{- "id": "string",
- "merchant_customer_id": "string"
}
The details about a customer in PayPal's system of record.
id | string (merchant_partner_customer_id) [ 1 .. 22 ] characters ^[0-9a-zA-Z_-]+$ The unique ID for a customer generated by PayPal. |
merchant_customer_id | string [ 1 .. 64 ] characters ^[0-9a-zA-Z-_.^*$@#]+$ Merchants and partners may already have a data-store where their customer information is persisted. Use merchant_customer_id to associate the PayPal-generated customer.id to your representation of a customer. |
{- "id": "string",
- "merchant_customer_id": "string"
}
The details about a saved PayPal Wallet payment source.
id | string [ 1 .. 255 ] characters The PayPal-generated ID for the saved payment source. | ||||||||
status | string (Vault Status) [ 1 .. 255 ] characters ^[0-9A-Z_]+$ The vault status.
| ||||||||
object (paypal_wallet_customer) The details about a customer in PayPal's system of record. |
{- "id": "string",
- "status": "VAULTED",
- "customer": {
- "id": "string",
- "merchant_customer_id": "string"
}
}
The percentage, as a fixed-point, signed decimal number. For example, define a 19.99% interest rate as 19.99
.
The percentage, as a fixed-point, signed decimal number. For example, define a 19.99% interest rate as 19.99
.
"string"
The phone number, in its canonical international E.164 numbering plan format.
national_number required | string [ 1 .. 14 ] characters ^[0-9]{1,14}?$ The national number, in its canonical international E.164 numbering plan format. The combined length of the country calling code (CC) and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN). |
{- "national_number": "string"
}
The phone number, in its canonical international E.164 numbering plan format.
country_code required | string [ 1 .. 3 ] characters ^[0-9]{1,3}?$ The country calling code (CC), in its canonical international E.164 numbering plan format. The combined length of the CC and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN). |
national_number required | string [ 1 .. 14 ] characters ^[0-9]{1,14}?$ The national number, in its canonical international E.164 numbering plan format. The combined length of the country calling code (CC) and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN). |
{- "country_code": "str",
- "national_number": "string"
}
The phone type.
The phone type.
"FAX"
The phone information.
phone_type | string (Phone Type) The phone type. |
required | object (Phone) The phone number, in its canonical international E.164 numbering plan format. Supports only the |
{- "phone_type": "FAX",
- "phone_number": {
- "national_number": "string"
}
}
The plan details.
id | string = 26 characters ^P-[A-Z0-9]*$ The unique PayPal-generated ID for the plan. | ||||||||
product_id | string = 22 characters ^PROD-[A-Z0-9]*$ The ID for the product. | ||||||||
name | string [ 1 .. 127 ] characters ^.*$ The plan name. | ||||||||
status | string [ 1 .. 24 ] characters ^[A-Z_]+$ The plan status.
| ||||||||
description | string [ 1 .. 127 ] characters ^.*$ The detailed description of the plan. | ||||||||
Array of objects (billing_cycle) [ 1 .. 12 ] items An array of billing cycles for trial billing and regular billing. A plan can have at most two trial cycles and only one regular cycle. | |||||||||
quantity_supported | boolean Default: false Indicates whether you can subscribe to this plan by providing a quantity for the goods or service. | ||||||||
Array of objects (Link Description) [ 1 .. 10 ] items An array of request-related HATEOAS links. | |||||||||
object (payment_preferences) The payment preferences for a subscription. | |||||||||
object (taxes) The tax details. | |||||||||
create_time | string <ppaas_date_time_v3> (date_time) [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|... The date and time when the plan was created, in Internet date and time format. | ||||||||
update_time | string <ppaas_date_time_v3> (date_time) [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|... The date and time when the plan was last updated, in Internet date and time format. |
{- "id": "stringstringstringstringst",
- "product_id": "stringstringstringstri",
- "name": "string",
- "status": "CREATED",
- "description": "string",
- "billing_cycles": [
- {
- "tenure_type": "REGULAR",
- "sequence": 1,
- "total_cycles": 1,
- "pricing_scheme": {
- "version": 999,
- "pricing_model": "VOLUME",
- "tiers": [
- {
- "starting_quantity": "string",
- "ending_quantity": "string",
- "amount": {
- "currency_code": "str",
- "value": "string"
}
}
], - "fixed_price": {
- "currency_code": "str",
- "value": "string"
}, - "create_time": "string",
- "update_time": "string"
}, - "frequency": {
- "interval_unit": "DAY",
- "interval_count": 1
}
}
], - "quantity_supported": false,
- "links": [
- {
- "href": "string",
- "rel": "string",
- "method": "GET"
}
], - "payment_preferences": {
- "auto_bill_outstanding": true,
- "setup_fee_failure_action": "CONTINUE",
- "payment_failure_threshold": 0,
- "setup_fee": {
- "currency_code": "str",
- "value": "string"
}
}, - "taxes": {
- "inclusive": true,
- "percentage": "string"
}, - "create_time": "string",
- "update_time": "string"
}
The plan details.
product_id | string = 22 characters ^PROD-[A-Z0-9]*$ The ID for the product. |
name | string [ 1 .. 127 ] characters ^.*$ The plan name. |
description | string [ 1 .. 127 ] characters ^.*$ The detailed description of the plan. |
Array of objects (billing_cycle) [ 1 .. 12 ] items An array of billing cycles for trial billing and regular billing. A plan can have at most two trial cycles and only one regular cycle. | |
quantity_supported | boolean Default: false Indicates whether you can subscribe to this plan by providing a quantity for the goods or service. |
object (payment_preferences) The payment preferences for a subscription. | |
object (taxes) The tax details. |
{- "product_id": "stringstringstringstri",
- "name": "string",
- "description": "string",
- "billing_cycles": [
- {
- "tenure_type": "REGULAR",
- "sequence": 1,
- "total_cycles": 1,
- "pricing_scheme": {
- "version": 999,
- "pricing_model": "VOLUME",
- "tiers": [
- {
- "starting_quantity": "string",
- "ending_quantity": "string",
- "amount": {
- "currency_code": "str",
- "value": "string"
}
}
], - "fixed_price": {
- "currency_code": "str",
- "value": "string"
}, - "create_time": "string",
- "update_time": "string"
}, - "frequency": {
- "interval_unit": "DAY",
- "interval_count": 1
}
}
], - "quantity_supported": false,
- "payment_preferences": {
- "auto_bill_outstanding": true,
- "setup_fee_failure_action": "CONTINUE",
- "payment_failure_threshold": 0,
- "setup_fee": {
- "currency_code": "str",
- "value": "string"
}
}, - "taxes": {
- "inclusive": true,
- "percentage": "string"
}
}
The list of plans with details.
Array of objects (plan) [ 0 .. 32767 ] items An array of plans. | |
total_items | integer [ 0 .. 500000000 ] The total number of items. |
total_pages | integer [ 0 .. 100000000 ] The total number of pages. |
Array of objects (Link Description) [ 1 .. 10 ] items An array of request-related HATEOAS links. |
{- "plans": [
- {
- "id": "stringstringstringstringst",
- "product_id": "stringstringstringstri",
- "name": "string",
- "status": "CREATED",
- "description": "string",
- "billing_cycles": [
- {
- "tenure_type": "REGULAR",
- "sequence": 1,
- "total_cycles": 1,
- "pricing_scheme": {
- "version": 999,
- "pricing_model": "VOLUME",
- "tiers": [
- {
- "starting_quantity": null,
- "ending_quantity": null,
- "amount": null
}
], - "fixed_price": {
- "currency_code": "str",
- "value": "string"
}, - "create_time": "string",
- "update_time": "string"
}, - "frequency": {
- "interval_unit": "DAY",
- "interval_count": 1
}
}
], - "quantity_supported": false,
- "links": [
- {
- "href": "string",
- "rel": "string",
- "method": "GET"
}
], - "payment_preferences": {
- "auto_bill_outstanding": true,
- "setup_fee_failure_action": "CONTINUE",
- "payment_failure_threshold": 0,
- "setup_fee": {
- "currency_code": "str",
- "value": "string"
}
}, - "taxes": {
- "inclusive": true,
- "percentage": "string"
}, - "create_time": "string",
- "update_time": "string"
}
], - "total_items": 500000000,
- "total_pages": 100000000,
- "links": [
- {
- "href": "string",
- "rel": "string",
- "method": "GET"
}
]
}
An inline plan object to customise the subscription. You can override plan level default attributes by providing customised values for the subscription in this object.
Array of objects (billing_cycle_override) [ 1 .. 12 ] items An array of billing cycles for trial billing and regular billing. The subscription billing cycle definition has to adhere to the plan billing cycle definition. | |
object (payment_preferences_override) The payment preferences to override at subscription level. | |
object (taxes_override) The tax details. |
{- "billing_cycles": [
- {
- "sequence": 1,
- "total_cycles": 999,
- "pricing_scheme": {
- "version": 999,
- "pricing_model": "VOLUME",
- "tiers": [
- {
- "starting_quantity": "string",
- "ending_quantity": "string",
- "amount": {
- "currency_code": "str",
- "value": "string"
}
}
], - "fixed_price": {
- "currency_code": "str",
- "value": "string"
}, - "create_time": "string",
- "update_time": "string"
}
}
], - "payment_preferences": {
- "auto_bill_outstanding": true,
- "setup_fee_failure_action": "CONTINUE",
- "payment_failure_threshold": 999,
- "setup_fee": {
- "currency_code": "str",
- "value": "string"
}
}, - "taxes": {
- "inclusive": true,
- "percentage": "string"
}
}
The create plan request details.
product_id required | string = 22 characters ^PROD-[A-Z0-9]*$ The ID of the product created through Catalog Products API. | ||||||||
name required | string [ 1 .. 127 ] characters ^.*$ The plan name. | ||||||||
status | string [ 1 .. 24 ] characters ^[A-Z_]+$ Default: "ACTIVE" The initial state of the plan. Allowed input values are CREATED and ACTIVE.
| ||||||||
description | string [ 1 .. 127 ] characters ^.*$ The detailed description of the plan. | ||||||||
required | Array of objects (billing_cycle) [ 1 .. 12 ] items An array of billing cycles for trial billing and regular billing. A plan can have at most two trial cycles and only one regular cycle. | ||||||||
quantity_supported | boolean Default: false Indicates whether you can subscribe to this plan by providing a quantity for the goods or service. | ||||||||
required | object (payment_preferences) The payment preferences for a subscription. | ||||||||
object (taxes) The tax details. |
{- "product_id": "stringstringstringstri",
- "name": "string",
- "status": "CREATED",
- "description": "string",
- "billing_cycles": [
- {
- "tenure_type": "REGULAR",
- "sequence": 1,
- "total_cycles": 1,
- "pricing_scheme": {
- "version": 999,
- "pricing_model": "VOLUME",
- "tiers": [
- {
- "starting_quantity": "string",
- "ending_quantity": "string",
- "amount": {
- "currency_code": "str",
- "value": "string"
}
}
], - "fixed_price": {
- "currency_code": "str",
- "value": "string"
}, - "create_time": "string",
- "update_time": "string"
}, - "frequency": {
- "interval_unit": "DAY",
- "interval_count": 1
}
}
], - "quantity_supported": false,
- "payment_preferences": {
- "auto_bill_outstanding": true,
- "setup_fee_failure_action": "CONTINUE",
- "payment_failure_threshold": 0,
- "setup_fee": {
- "currency_code": "str",
- "value": "string"
}
}, - "taxes": {
- "inclusive": true,
- "percentage": "string"
}
}
The portable international postal address. Maps to AddressValidationMetadata and HTML 5.1 Autofilling form controls: the autocomplete attribute.
address_line_1 | string <= 300 characters The first line of the address, such as number and street, for example, |
address_line_2 | string <= 300 characters The second line of the address, for example, a suite or apartment number. |
admin_area_2 | string <= 120 characters A city, town, or village. Smaller than |
admin_area_1 | string <= 300 characters The highest-level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision. This data is formatted for postal delivery, for example,
|
postal_code | string <= 60 characters The postal code, which is the ZIP code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code. |
country_code required | string <ppaas_common_country_code_v2> (country_code) = 2 characters ^([A-Z]{2}|C2)$ The 2-character ISO 3166-1 code that identifies the country or region. Note: The country code for Great Britain is |
{- "address_line_1": "string",
- "address_line_2": "string",
- "admin_area_2": "string",
- "admin_area_1": "string",
- "postal_code": "string",
- "country_code": "st"
}
The portable international postal address. Maps to AddressValidationMetadata and HTML 5.1 Autofilling form controls: the autocomplete attribute.
address_line_1 | string <= 300 characters The first line of the address, such as number and street, for example, |
address_line_2 | string <= 300 characters The second line of the address, for example, a suite or apartment number. |
admin_area_2 | string <= 120 characters A city, town, or village. Smaller than |
admin_area_1 | string <= 300 characters The highest-level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision. This data is formatted for postal delivery, for example,
|
postal_code | string <= 60 characters The postal code, which is the ZIP code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code. |
country_code required | string <ppaas_common_country_code_v2> (country_code) = 2 characters ^([A-Z]{2}|C2)$ The 2-character ISO 3166-1 code that identifies the country or region. Note: The country code for Great Britain is |
{- "address_line_1": "string",
- "address_line_2": "string",
- "admin_area_2": "string",
- "admin_area_1": "string",
- "postal_code": "string",
- "country_code": "st"
}
The portable international postal address. Maps to AddressValidationMetadata and HTML 5.1 Autofilling form controls: the autocomplete attribute.
address_line_1 | string <= 300 characters The first line of the address, such as number and street, for example, |
address_line_2 | string <= 300 characters The second line of the address, for example, a suite or apartment number. |
admin_area_2 | string <= 120 characters A city, town, or village. Smaller than |
admin_area_1 | string <= 300 characters The highest-level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision. This data is formatted for postal delivery, for example,
|
postal_code | string <= 60 characters The postal code, which is the ZIP code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code. |
country_code required | string <ppaas_common_country_code_v2> (country_code) = 2 characters ^([A-Z]{2}|C2)$ The 2-character ISO 3166-1 code that identifies the country or region. Note: The country code for Great Britain is |
{- "address_line_1": "string",
- "address_line_2": "string",
- "admin_area_2": "string",
- "admin_area_1": "string",
- "postal_code": "string",
- "country_code": "st"
}
The portable international postal address. Maps to AddressValidationMetadata and HTML 5.1 Autofilling form controls: the autocomplete attribute.
address_line_1 | string <= 300 characters The first line of the address, such as number and street, for example, |
address_line_2 | string <= 300 characters The second line of the address, for example, a suite or apartment number. |
admin_area_2 | string <= 120 characters A city, town, or village. Smaller than |
admin_area_1 | string <= 300 characters The highest-level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision. This data is formatted for postal delivery, for example,
|
postal_code | string <= 60 characters The postal code, which is the ZIP code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code. |
country_code required | string <ppaas_common_country_code_v2> (country_code) = 2 characters ^([A-Z]{2}|C2)$ The 2-character ISO 3166-1 code that identifies the country or region. Note: The country code for Great Britain is |
{- "address_line_1": "string",
- "address_line_2": "string",
- "admin_area_2": "string",
- "admin_area_1": "string",
- "postal_code": "string",
- "country_code": "st"
}
The portable international postal address. Maps to AddressValidationMetadata and HTML 5.1 Autofilling form controls: the autocomplete attribute.
address_line_1 | string <= 300 characters The first line of the address, such as number and street, for example, |
address_line_2 | string <= 300 characters The second line of the address, for example, a suite or apartment number. |
admin_area_2 | string <= 120 characters A city, town, or village. Smaller than |
admin_area_1 | string <= 300 characters The highest-level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision. This data is formatted for postal delivery, for example,
|
postal_code | string <= 60 characters The postal code, which is the ZIP code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code. |
country_code required | string <ppaas_common_country_code_v2> (country_code) = 2 characters ^([A-Z]{2}|C2)$ The 2-character ISO 3166-1 code that identifies the country or region. Note: The country code for Great Britain is |
{- "address_line_1": "string",
- "address_line_2": "string",
- "admin_area_2": "string",
- "admin_area_1": "string",
- "postal_code": "string",
- "country_code": "st"
}
The pricing scheme details.
version | integer [ 0 .. 999 ] The version of the pricing scheme. | ||||||
pricing_model | string [ 1 .. 24 ] characters ^[A-Z_]+$ The pricing model for tiered plan. The
| ||||||
Array of objects (pricing_tier) [ 1 .. 32 ] items An array of pricing tiers which are used for billing volume/tiered plans. pricing_model field has to be specified. | |||||||
object (Money) The fixed amount to charge for the subscription. The changes to fixed amount are applicable to both existing and future subscriptions. For existing subscriptions, payments within 10 days of price change are not affected. | |||||||
create_time | string <ppaas_date_time_v3> (date_time) [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|... The date and time when this pricing scheme was created, in Internet date and time format. | ||||||
update_time | string <ppaas_date_time_v3> (date_time) [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|... The date and time when this pricing scheme was last updated, in Internet date and time format. |
{- "version": 999,
- "pricing_model": "VOLUME",
- "tiers": [
- {
- "starting_quantity": "string",
- "ending_quantity": "string",
- "amount": {
- "currency_code": "str",
- "value": "string"
}
}
], - "fixed_price": {
- "currency_code": "str",
- "value": "string"
}, - "create_time": "string",
- "update_time": "string"
}
The pricing tier details.
starting_quantity required | string [ 1 .. 32 ] characters ^([0-9]+|([0-9]+)?[.][0-9]+)$ The starting quantity for the tier. |
ending_quantity | string [ 1 .. 32 ] characters ^([0-9]+|([0-9]+)?[.][0-9]+)$ The ending quantity for the tier. Optional for the last tier. |
required | object (Money) The pricing amount for the tier. |
{- "starting_quantity": "string",
- "ending_quantity": "string",
- "amount": {
- "currency_code": "str",
- "value": "string"
}
}
The rewards provider which acts as a gateway to the rewards issuer, for example, the financial instruments' aggregator for multiple banks.
The rewards provider which acts as a gateway to the rewards issuer, for example, the financial instruments' aggregator for multiple banks.
"string"
Reasons for disallowing a funding option.
Reasons for disallowing a funding option.
Enum Value | Description |
---|---|
CUSTOM_REASON | Generic bucket. |
DISALLOWED_DUE_TO_INCOMPLETE_COMMERCIAL_ENTITY_REGISTRATION | Disallowed due to incomplete entity registration. |
UNSUPPORTED_FOR_GAMING | Disallowed because gaming is not supported. |
DISALLOWED_DUE_TO_UNSUPPORTED_PROCESSING | Disallowed because processing is not supported. |
UNSUPPORTED_CURRENCY_CODE | Disallowed because currency code is not supported. |
DISALLOWED_DUE_TO_UNSUPPORTED_MCC | Disallowed because MCC is not supported. |
"CUSTOM_REASON"
The rewards redemption type.
The rewards redemption type.
Enum Value | Description |
---|---|
STATEMENT_CREDIT | Indicates that authorization should be performed on the card whenever the rewards are used in the transaction. |
REAL_TIME | Indicates that authorization should be performed on the rewards instrument. |
STATEMENT_CREDIT_WITH_CHOICE | The statement credit redemption with choice to specify the amount. |
"STATEMENT_CREDIT"
A rewards account resource.
account_number | string [ 1 .. 256 ] characters ^[A-Za-z0-9-_.+/=]+$ The permanent account number (PAN) for card with which this rewards account is associated or the account number of the rewards account, like Honey Gold rewards. And pattern supports JWT, Plain(account number of the instrument), Encrypted. | ||||||||
Array of objects (Capability) [ 1 .. 100 ] items Capabilities for the rewards account. | |||||||||
Array of objects (Network) [ 1 .. 100 ] items Networks support for the rewards account. | |||||||||
Array of objects (Institution art images content) [ 1 .. 100 ] items Institution images and related image details (as card art). | |||||||||
Array of objects (A URL details of an institution) [ 1 .. 40 ] items Provides all the URLs applicable for the rewards program, for example, settings and terms & conditions. Because for different rewards programs, URLs may vary, they are user wallet's attribute. | |||||||||
registration_id | string (external_reference_id) [ 1 .. 256 ] characters ^.+$ The registration ID or external identifier. | ||||||||
expiration_date | string (date_year_month) = 7 characters ^[0-9]{4}-(0[1-9]|1[0-2])$ The rewards expiry date, in | ||||||||
object (Rewards issuer details) The issuer of the rewards account. | |||||||||
object (Rewards Denomination details) The rewards denomination details. | |||||||||
object (Name) The beneficiary name on the rewards account. | |||||||||
redemption_type | string (Redemption type) [ 1 .. 255 ] characters ^[0-9A-Z_]+$ The rewards redemption type like STATEMENT_CREDIT or REAL_TIME.
| ||||||||
status | string (Status of the Instrument) [ 1 .. 12 ] characters ^[A-Z_]+$ Status of the rewards account.
| ||||||||
type | string (Rewards account type) [ 1 .. 255 ] characters ^[0-9A-Z_]+$ Type of rewards account.
|
{- "account_number": "string",
- "capabilities": [
- {
- "name": "INSTALLMENT",
- "mode": "NON_REAL_TIME",
- "networks": [
- {
- "preferred": true,
- "cross_border_transaction_supported": true,
- "supported_currencies": [
- "str"
], - "transfer_type": "WIRE",
- "mandate_enforcement": "SEPA",
- "network_rules": [
- "string"
], - "name": "ACCEL"
}
], - "capability_initiator": "PAYPAL",
- "operation_type": "CAPABILITY_OP_SINK"
}
], - "networks": [
- {
- "preferred": true,
- "cross_border_transaction_supported": true,
- "supported_currencies": [
- "str"
], - "transfer_type": "WIRE",
- "mandate_enforcement": "SEPA",
- "network_rules": [
- "string"
], - "name": "ACCEL"
}
], - "institution_images": [
- {
- "image_details": [
- {
- "original_mime_type": "string",
- "original_width": 2147483647,
- "original_height": 2147483647,
- "background_color": "string",
- "foreground_color": "string",
- "label_color": "string",
- "location_type": "INTERNAL",
- "path_format_type": "ABSOLUTE"
}
], - "image_classification": "NETWORK",
- "category": "PRIMARY"
}
], - "registration_id": "string",
- "expiration_date": "strings",
- "issuer": {
- "name": {
- "name": "string",
- "orthography": "Zyyy"
}, - "provider": "string",
- "sponsor_id": "string",
- "sponsor_account_id": "string",
- "sponsor_instrument_type": "string",
- "country_code": "st",
- "display_name": {
- "name": "string",
- "orthography": "Zyyy"
}, - "customer_support_email": "string",
- "product_description": "string"
}, - "balance": {
- "balance_eligible": true,
- "monetary": true,
- "rewards_program_currency_code": "string",
- "rewards_program_denomination_value": "string",
- "type": "CURRENCY",
- "amount": {
- "currency_code": "str",
- "value": "string"
}, - "conversion_factor": "string",
- "target_amount": {
- "currency_code": "str",
- "value": "string"
}, - "denomination_type_description": "string",
- "minimum_target_currency_rewards_spend": "string",
- "maximum_target_currency_rewards_spend": "string",
- "program_currency_decimal_precision": 50,
- "target_currency_decimal_precision": 50,
- "target_currency_rounding_mode": "UP",
- "program_currency_rounding_mode": "UP",
- "balance_snapshot_key": "string",
- "target_currency_code": "string"
}, - "beneficiary_name": {
- "prefix": "string",
- "given_name": "string",
- "surname": "string",
- "middle_name": "string",
- "suffix": "string",
- "full_name": "string"
}, - "redemption_type": "STATEMENT_CREDIT",
- "status": "OPEN",
- "type": "STANDALONE"
}
Type of rewards account.
Type of rewards account.
Enum Value | Description |
---|---|
STANDALONE | Indicates rewards account, like Honey Gold, that is independent of a specific instrument. |
INSTRUMENT_RELATED | A rewards account that is associated with an external card. |
"STANDALONE"
The rewards denomination details.
balance_eligible | boolean The flag to represent the rewards eligibility. Added for Chase Pay®. | ||||||||||||||
monetary | boolean The flag to indicate whether the rewards are monetary or not. | ||||||||||||||
rewards_program_currency_code | string [ 1 .. 32 ] characters ^[0-9A-Za-z_]+$ The currency code for rewards program example CBB, MI2, WPTS, TYP, Cash, Points etc. This is not ISO currency code. | ||||||||||||||
rewards_program_denomination_value | string [ 1 .. 32 ] characters ^(-?[0-9A-Za-z.+-]+)$ The Denomination value for rewards program. | ||||||||||||||
type | string (Denomination Type) [ 1 .. 128 ] characters ^[0-9A-Z_]+$ The denomination type.
| ||||||||||||||
object (Money) The amount. | |||||||||||||||
conversion_factor | string (float_value) [ 1 .. 50 ] characters ^(-?[0-9]+([.][0-9]*)?|[.][0-9]+)$ The conversion factor. | ||||||||||||||
object (Money) The target amount | |||||||||||||||
denomination_type_description | string (description) [ 1 .. 256 ] characters The denomination type description. This can contain information like ThankYou Points. | ||||||||||||||
minimum_target_currency_rewards_spend | string (float_value) [ 1 .. 50 ] characters ^(-?[0-9]+([.][0-9]*)?|[.][0-9]+)$ The minimum rewards to spend in the target currency. | ||||||||||||||
maximum_target_currency_rewards_spend | string (float_value) [ 1 .. 50 ] characters ^(-?[0-9]+([.][0-9]*)?|[.][0-9]+)$ The maximum rewards to spend in the target currency. | ||||||||||||||
program_currency_decimal_precision | integer (currency_decimal_precision) [ 0 .. 50 ] The decimal precision to be used for the program currency. | ||||||||||||||
target_currency_decimal_precision | integer (currency_decimal_precision) [ 0 .. 50 ] The decimal precision to be used for the target currency. | ||||||||||||||
target_currency_rounding_mode | string (rounding_mode) [ 1 .. 255 ] characters ^[0-9A-Z_]+$ The rounding mode to be applied to the target currency.
| ||||||||||||||
program_currency_rounding_mode | string (rounding_mode) [ 1 .. 255 ] characters ^[0-9A-Z_]+$ The rounding mode to be applied to the program currency.
| ||||||||||||||
balance_snapshot_key | string (snapshot_key) [ 1 .. 128 ] characters ^.+$ This is a unique number generated by Issuer for each account rewards request. Applicable for any statement credit redemption cases like ChasePay. The key which ties back to the snapshot of the rewards balance that's used for the transaction. | ||||||||||||||
target_currency_code | string <ppaas_common_currency_code_v2> (currency_code) = 3 characters The primary ISO 4217 3-letter alphabetic code that represents the target currency for reward instrument. |
{- "balance_eligible": true,
- "monetary": true,
- "rewards_program_currency_code": "string",
- "rewards_program_denomination_value": "string",
- "type": "CURRENCY",
- "amount": {
- "currency_code": "str",
- "value": "string"
}, - "conversion_factor": "string",
- "target_amount": {
- "currency_code": "str",
- "value": "string"
}, - "denomination_type_description": "string",
- "minimum_target_currency_rewards_spend": "string",
- "maximum_target_currency_rewards_spend": "string",
- "program_currency_decimal_precision": 50,
- "target_currency_decimal_precision": 50,
- "target_currency_rounding_mode": "UP",
- "program_currency_rounding_mode": "UP",
- "balance_snapshot_key": "string",
- "target_currency_code": "string"
}
The rewards account issuer related details.
object (Full Name with orthography) Issuer name. | |
provider | string (provider) [ 1 .. 256 ] characters ^[0-9a-zA-Z_]+$ The rewards provider which acts as a gateway to the rewards issuer, for example, the financial instruments' aggregator for multiple banks. |
sponsor_id | string (sponsor_id) [ 1 .. 32 ] characters ^[0-9A-Z]+(?:-[0-9A-Z]+)*$ Encrypted identifier of the rewards sponsor or institution that manages the payment instrument. |
sponsor_account_id | string (sponsor_account_id) [ 1 .. 256 ] characters ^[A-Za-z0-9-_.+/=]+$ The encrypted identifier of the main account of the rewards sponsor. |
sponsor_instrument_type | string (sponsor_instrument_type) [ 1 .. 256 ] characters ^[A-Za-z0-9-_.+/=]+$ The sponsor-supported payment instrument type. |
country_code | string <ppaas_common_country_code_v2> (country_code) = 2 characters ^([A-Z]{2}|C2)$ Country Code of the Issuer. |
object (Full Name with orthography) The issuer name of the rewards to be displayed to the user. | |
customer_support_email | string <ppaas_common_email_address_v2> (email_address) [ 3 .. 254 ] characters ^(?:[A-Za-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[A-Za... This issuer's customer support email address. |
product_description | string (description) [ 1 .. 256 ] characters This is the card issuer's product and brand information, for example, Costco Anywhere Visa® Card by Citi. |
{- "name": {
- "name": "string",
- "orthography": "Zyyy"
}, - "provider": "string",
- "sponsor_id": "string",
- "sponsor_account_id": "string",
- "sponsor_instrument_type": "string",
- "country_code": "st",
- "display_name": {
- "name": "string",
- "orthography": "Zyyy"
}, - "customer_support_email": "string",
- "product_description": "string"
}
The rounding modes for a given rewards program currency.
The rounding modes for a given rewards program currency.
Enum Value | Description |
---|---|
UP | Round away from zero. |
DOWN | Round toward zero. |
HALF_UP | Round toward nearest neighbor unless both neighbors are equidistant. If equidistant, round up. |
HALF_DOWN | Round toward nearest neighbor unless both neighbors are equidistant. If equidistant, round down. |
HALF_EVEN | Round toward the nearest neighbor unless both neighbors are equidistant. If equidistant, round toward the even neighbor. |
UNNECESSARY | Because the requested operation has an exact result, no rounding is necessary. |
"UP"
The shipping details.
type | string (Fulfillment Type) [ 1 .. 255 ] characters ^[0-9A-Z_]+$ A classification for the method of purchase fulfillment (e.g shipping, in-store pickup, etc). Either
| ||||||||||
Array of objects (shipping_option) [ 0 .. 10 ] items An array of shipping options that the payee or merchant offers to the payer to ship or pick up their items. | |||||||||||
object (Name) The name of the person to whom to ship the items. Supports only the | |||||||||||
email_address | string <ppaas_common_email_address_v2> (email_address) [ 3 .. 254 ] characters ^(?:[A-Za-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[A-Za... The email address of the recipient of the shipped items, which may belong to either the payer, or an alternate contact, for delivery. | ||||||||||
object (Phone) The phone number of the recipient of the shipped items, which may belong to either the payer, or an alternate contact, for delivery. [Format - canonical international E.164 numbering plan] | |||||||||||
object (Portable Postal Address (Medium-Grained)) The address of the person to whom to ship the items. Supports only the |
{- "type": "SHIPPING",
- "options": [
- {
- "id": "string",
- "label": "string",
- "selected": true,
- "type": "SHIPPING",
- "amount": {
- "currency_code": "str",
- "value": "string"
}
}
], - "name": {
- "full_name": "string"
}, - "email_address": "string",
- "phone_number": {
- "country_code": "str",
- "national_number": "string"
}, - "address": {
- "address_line_1": "string",
- "address_line_2": "string",
- "admin_area_2": "string",
- "admin_area_1": "string",
- "postal_code": "string",
- "country_code": "st"
}
}
The options that the payee or merchant offers to the payer to ship or pick up their items.
id required | string <= 127 characters A unique ID that identifies a payer-selected shipping option. | ||||||||||
label required | string <= 127 characters A description that the payer sees, which helps them choose an appropriate shipping option. For example, | ||||||||||
selected required | boolean If the API request sets | ||||||||||
type | string (shipping_type) A classification for the method of purchase fulfillment.
| ||||||||||
object (Money) The shipping cost for the selected option. |
{- "id": "string",
- "label": "string",
- "selected": true,
- "type": "SHIPPING",
- "amount": {
- "currency_code": "str",
- "value": "string"
}
}
A classification for the method of purchase fulfillment.
A classification for the method of purchase fulfillment.
Enum Value | Description |
---|---|
SHIPPING | The payer intends to receive the items at a specified address. |
PICKUP | DEPRECATED. To ensure that seller protection is correctly assigned, please use 'PICKUP_IN_STORE' or 'PICKUP_FROM_PERSON' instead. Currently, this field indicates that the payer intends to pick up the items at a specified address (ie. a store address). |
PICKUP_IN_STORE | The payer intends to pick up the item(s) from the payee's physical store. Also termed as BOPIS, "Buy Online, Pick-up in Store". Seller protection is provided with this option. |
PICKUP_FROM_PERSON | The payer intends to pick up the item(s) from the payee in person. Also termed as BOPIP, "Buy Online, Pick-up in Person". Seller protection is not available, since the payer is receiving the item from the payee in person, and can validate the item prior to payment. |
"SHIPPING"
This is a unique number generated by Issuer for each account rewards request.
This is a unique number generated by Issuer for each account rewards request.
"string"
The encrypted identifier of the sponsor's main account.
The encrypted identifier of the sponsor's main account.
"string"
Encrypted Sponsor identifier of issuer/institution which manages the payment token which controls characteristics of the instrument and is associated with how the instrument is processed.
Encrypted Sponsor identifier of issuer/institution which manages the payment token which controls characteristics of the instrument and is associated with how the instrument is processed.
"string"
The issuer-supported payment instrument type.
The issuer-supported payment instrument type.
"string"
Status of the instrument, indicates whether it is available for clients.
Status of the instrument, indicates whether it is available for clients.
Enum Value | Description |
---|---|
OPEN | Status of the instrument - OPEN. Instrument is available for transactions. |
CLOSED | Status of the instrument - CLOSED. Instrument is unavailable for transactions. |
"OPEN"
Defines how and when the payment source gets vaulted.
Defines how and when the payment source gets vaulted.
Value | Description |
---|---|
ON_SUCCESS | Defines that the payment_source will be vaulted only when at least one authorization or capture using that payment_source is successful. |
"ON_SUCCESS"
Indicates the type of the stored payment_source payment.
Indicates the type of the stored payment_source payment.
Enum Value | Description |
---|---|
ONE_TIME | One Time payment such as online purchase or donation. (e.g. Checkout with one-click). |
RECURRING | Payment which is part of a series of payments with fixed or variable amounts, following a fixed time interval. (e.g. Subscription payments). |
UNSCHEDULED | Payment which is part of a series of payments that occur on a non-fixed schedule and/or have variable amounts. (e.g. Account Topup payments). |
"ONE_TIME"
Indicates if this is a first
or subsequent
payment using a stored payment source (also referred to as stored credential or card on file).
Indicates if this is a first
or subsequent
payment using a stored payment source (also referred to as stored credential or card on file).
Enum Value | Description |
---|---|
FIRST | Indicates the Initial/First payment with a payment_source that is intended to be stored upon successful processing of the payment. |
SUBSEQUENT | Indicates a payment using a stored payment_source which has been successfully used previously for a payment. |
DERIVED | Indicates that PayPal will derive the value of |
"FIRST"
The subscriber response information.
email_address | string <merchant_common_email_address_v2> (email) [ 3 .. 254 ] characters (?:[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-zA-... The email address of the payer. |
payer_id | string <ppaas_payer_id_v3> (PayPal Account Identifier) = 13 characters ^[2-9A-HJ-NP-Z]{13}$ The PayPal-assigned ID for the payer. |
object (Name) The name of the payer. Supports only the | |
object (phone_with_type) The phone number of the customer. Available only when you enable the Contact Telephone Number option in the Profile & Settings for the merchant's PayPal account. The | |
object (shipping_detail) The shipping details. | |
object (payment_source_response) The payment source used to fund the payment. |
{- "email_address": "string",
- "payer_id": "string",
- "name": {
- "given_name": "string",
- "surname": "string"
}, - "phone": {
- "phone_type": "FAX",
- "phone_number": {
- "national_number": "string"
}
}, - "shipping_address": {
- "type": "SHIPPING",
- "options": [
- {
- "id": "string",
- "label": "string",
- "selected": true,
- "type": "SHIPPING",
- "amount": {
- "currency_code": "str",
- "value": "string"
}
}
], - "name": {
- "full_name": "string"
}, - "email_address": "string",
- "phone_number": {
- "country_code": "str",
- "national_number": "string"
}, - "address": {
- "address_line_1": "string",
- "address_line_2": "string",
- "admin_area_2": "string",
- "admin_area_1": "string",
- "postal_code": "string",
- "country_code": "st"
}
}, - "payment_source": {
- "card": {
- "name": "string",
- "last_digits": "string",
- "available_networks": [
- "VISA"
], - "from_request": {
- "last_digits": "stri",
- "expiry": "string"
}, - "stored_credential": {
- "payment_initiator": "CUSTOMER",
- "payment_type": "ONE_TIME",
- "usage": "FIRST",
- "previous_network_transaction_reference": {
- "id": "stringstr",
- "date": "stri",
- "acquirer_reference_number": "string",
- "network": "VISA"
}
}, - "brand": "VISA",
- "type": "CREDIT",
- "authentication_result": {
- "liability_shift": "NO",
- "three_d_secure": {
- "authentication_status": "Y",
- "enrollment_status": "Y"
}
}, - "attributes": {
- "vault": {
- "id": "string",
- "status": "VAULTED",
- "links": [
- {
- "href": "string",
- "rel": "string",
- "method": "GET"
}
], - "customer": {
- "id": "string",
- "email_address": "string",
- "phone": {
- "phone_type": "FAX",
- "phone_number": {
- "national_number": null
}
}, - "merchant_customer_id": "string"
}
}
}, - "expiry": "string",
- "bin_details": {
- "bin": "string",
- "issuing_bank": "string",
- "products": [
- "string"
], - "bin_country_code": "string"
}, - "billing_address": {
- "address_line_1": "string",
- "address_line_2": "string",
- "admin_area_2": "string",
- "admin_area_1": "string",
- "postal_code": "string",
- "country_code": "st"
}, - "currency_code": "string"
}
}
}
The subscriber request information .
email_address | string <merchant_common_email_address_v2> (email) [ 3 .. 254 ] characters (?:[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-zA-... The email address of the payer. |
payer_id | string <ppaas_payer_id_v3> (PayPal Account Identifier) = 13 characters ^[2-9A-HJ-NP-Z]{13}$ The PayPal-assigned ID for the payer. |
object (Name) The name of the payer. Supports only the | |
object (phone_with_type) The phone number of the customer. Available only when you enable the Contact Telephone Number option in the Profile & Settings for the merchant's PayPal account. The | |
object (shipping_detail) The shipping details. | |
object (payment_source) The payment source definition. To be eligible to create subscription using debit or credit card, you will need to sign up here (https://www.paypal.com/bizsignup/entry/product/ppcp). Please note, its available only for non-3DS cards and for merchants in US and AU regions. |
{- "email_address": "string",
- "payer_id": "string",
- "name": {
- "given_name": "string",
- "surname": "string"
}, - "phone": {
- "phone_type": "FAX",
- "phone_number": {
- "national_number": "string"
}
}, - "shipping_address": {
- "type": "SHIPPING",
- "options": [
- {
- "id": "string",
- "label": "string",
- "selected": true,
- "type": "SHIPPING",
- "amount": {
- "currency_code": "str",
- "value": "string"
}
}
], - "name": {
- "full_name": "string"
}, - "email_address": "string",
- "phone_number": {
- "country_code": "str",
- "national_number": "string"
}, - "address": {
- "address_line_1": "string",
- "address_line_2": "string",
- "admin_area_2": "string",
- "admin_area_1": "string",
- "postal_code": "string",
- "country_code": "st"
}
}, - "payment_source": {
- "card": {
- "name": "string",
- "number": "stringstrings",
- "security_code": "stri",
- "expiry": "string",
- "type": "CREDIT",
- "brand": "VISA",
- "billing_address": {
- "address_line_1": "string",
- "address_line_2": "string",
- "admin_area_2": "string",
- "admin_area_1": "string",
- "postal_code": "string",
- "country_code": "st"
}, - "attributes": {
- "customer": {
- "id": "string",
- "email_address": "string",
- "phone": {
- "phone_type": "FAX",
- "phone_number": {
- "national_number": "string"
}
}, - "merchant_customer_id": "string"
}, - "vault": {
- "store_in_vault": "ON_SUCCESS"
}, - "verification": {
- "method": "SCA_ALWAYS"
}
}
}
}
}
The subscription details.
status | string [ 1 .. 24 ] characters ^[A-Z_]+$ The status of the subscription.
| ||||||||||||||
status_change_note | string [ 1 .. 128 ] characters ^.*$ The reason or notes for the status of the subscription. | ||||||||||||||
status_update_time | string <ppaas_date_time_v3> (date_time) [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|... The date and time, in Internet date and time format. Seconds are required while fractional seconds are optional. Note: The regular expression provides guidance but does not reject all invalid dates. | ||||||||||||||
id | string [ 3 .. 50 ] characters The PayPal-generated ID for the subscription. | ||||||||||||||
plan_id | string [ 3 .. 50 ] characters The ID of the plan. | ||||||||||||||
quantity | string [ 1 .. 32 ] characters ^([0-9]+|([0-9]+)?[.][0-9]+)$ The quantity of the product in the subscription. | ||||||||||||||
custom_id | string [ 1 .. 127 ] characters ^[\x20-\x7E]+ The custom id for the subscription. Can be invoice id. | ||||||||||||||
plan_overridden | boolean Indicates whether the subscription has overridden any plan attributes. | ||||||||||||||
Array of objects (Link Description) An array of request-related HATEOAS links. | |||||||||||||||
start_time | string <ppaas_date_time_v3> (date_time) [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|... The date and time, in Internet date and time format. Seconds are required while fractional seconds are optional. Note: The regular expression provides guidance but does not reject all invalid dates. | ||||||||||||||
object (Money) The currency and amount for a financial transaction, such as a balance or payment due. | |||||||||||||||
object <payer_v1> (subscriber) The subscriber response information. | |||||||||||||||
object (subscription_billing_info) The billing details for the subscription. If the subscription was or is active, these fields are populated. | |||||||||||||||
create_time | string <ppaas_date_time_v3> (date_time) [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|... The date and time, in Internet date and time format. Seconds are required while fractional seconds are optional. Note: The regular expression provides guidance but does not reject all invalid dates. | ||||||||||||||
update_time | string <ppaas_date_time_v3> (date_time) [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|... The date and time, in Internet date and time format. Seconds are required while fractional seconds are optional. Note: The regular expression provides guidance but does not reject all invalid dates. | ||||||||||||||
object (plan) Inline plan details. |
{- "status": "APPROVAL_PENDING",
- "status_change_note": "string",
- "status_update_time": "string",
- "id": "string",
- "plan_id": "string",
- "quantity": "string",
- "custom_id": "string",
- "plan_overridden": true,
- "links": [
- {
- "href": "string",
- "rel": "string",
- "method": "GET"
}
], - "start_time": "string",
- "shipping_amount": {
- "currency_code": "str",
- "value": "string"
}, - "subscriber": {
- "email_address": "string",
- "payer_id": "string",
- "name": {
- "given_name": "string",
- "surname": "string"
}, - "phone": {
- "phone_type": "FAX",
- "phone_number": {
- "national_number": "string"
}
}, - "shipping_address": {
- "type": "SHIPPING",
- "options": [
- {
- "id": "string",
- "label": "string",
- "selected": true,
- "type": "SHIPPING",
- "amount": {
- "currency_code": "str",
- "value": "string"
}
}
], - "name": {
- "full_name": "string"
}, - "email_address": "string",
- "phone_number": {
- "country_code": "str",
- "national_number": "string"
}, - "address": {
- "address_line_1": "string",
- "address_line_2": "string",
- "admin_area_2": "string",
- "admin_area_1": "string",
- "postal_code": "string",
- "country_code": "st"
}
}, - "payment_source": {
- "card": {
- "name": "string",
- "last_digits": "string",
- "available_networks": [
- "VISA"
], - "from_request": {
- "last_digits": "stri",
- "expiry": "string"
}, - "stored_credential": {
- "payment_initiator": "CUSTOMER",
- "payment_type": "ONE_TIME",
- "usage": "FIRST",
- "previous_network_transaction_reference": {
- "id": "stringstr",
- "date": "stri",
- "acquirer_reference_number": "string",
- "network": "VISA"
}
}, - "brand": "VISA",
- "type": "CREDIT",
- "authentication_result": {
- "liability_shift": "NO",
- "three_d_secure": {
- "authentication_status": "Y",
- "enrollment_status": "Y"
}
}, - "attributes": {
- "vault": {
- "id": "string",
- "status": "VAULTED",
- "links": [
- {
- "href": null,
- "rel": null,
- "method": null
}
], - "customer": {
- "id": "string",
- "email_address": "string",
- "phone": {
- "phone_type": null,
- "phone_number": null
}, - "merchant_customer_id": "string"
}
}
}, - "expiry": "string",
- "bin_details": {
- "bin": "string",
- "issuing_bank": "string",
- "products": [
- "string"
], - "bin_country_code": "string"
}, - "billing_address": {
- "address_line_1": "string",
- "address_line_2": "string",
- "admin_area_2": "string",
- "admin_area_1": "string",
- "postal_code": "string",
- "country_code": "st"
}, - "currency_code": "string"
}
}
}, - "billing_info": {
- "cycle_executions": [
- {
- "tenure_type": "REGULAR",
- "sequence": 99,
- "cycles_completed": 9999,
- "cycles_remaining": 9999,
- "current_pricing_scheme_version": 1,
- "total_cycles": 999
}
], - "failed_payments_count": 999,
- "outstanding_balance": {
- "currency_code": "str",
- "value": "string"
}, - "last_payment": {
- "status": "COMPLETED",
- "amount": {
- "currency_code": "str",
- "value": "string"
}, - "time": "string"
}, - "next_billing_time": "string",
- "final_payment_time": "string",
- "last_failed_payment": {
- "reason_code": "PAYMENT_DENIED",
- "amount": {
- "currency_code": "str",
- "value": "string"
}, - "time": "string",
- "next_payment_retry_time": "string"
}
}, - "create_time": "string",
- "update_time": "string",
- "plan": {
- "product_id": "stringstringstringstri",
- "name": "string",
- "description": "string",
- "billing_cycles": [
- {
- "tenure_type": "REGULAR",
- "sequence": 1,
- "total_cycles": 1,
- "pricing_scheme": {
- "version": 999,
- "pricing_model": "VOLUME",
- "tiers": [
- {
- "starting_quantity": "string",
- "ending_quantity": "string",
- "amount": {
- "currency_code": null,
- "value": null
}
}
], - "fixed_price": {
- "currency_code": "str",
- "value": "string"
}, - "create_time": "string",
- "update_time": "string"
}, - "frequency": {
- "interval_unit": "DAY",
- "interval_count": 1
}
}
], - "quantity_supported": false,
- "payment_preferences": {
- "auto_bill_outstanding": true,
- "setup_fee_failure_action": "CONTINUE",
- "payment_failure_threshold": 0,
- "setup_fee": {
- "currency_code": "str",
- "value": "string"
}
}, - "taxes": {
- "inclusive": true,
- "percentage": "string"
}
}
}
The activate subscription request details.
reason | string [ 1 .. 128 ] characters ^.*$ The reason for activation of a subscription. Required to reactivate the subscription. |
{- "reason": "string"
}
The billing details for the subscription. If the subscription was or is active, these fields are populated.
Array of objects (cycle_execution) [ 0 .. 3 ] items The trial and regular billing executions. | |
failed_payments_count required | integer [ 0 .. 999 ] The number of consecutive payment failures. Resets to |
required | object (Money) The total pending bill amount, to be paid by the subscriber. |
object (last_payment_details) The details for the last payment of the subscription. | |
next_billing_time | string <ppaas_date_time_v3> (date_time) [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|... The next date and time for billing this subscription, in Internet date and time format. |
final_payment_time | string <ppaas_date_time_v3> (date_time) [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|... The date and time when the final billing cycle occurs, in Internet date and time format. |
object (failed_payment_details) The details for the last failed payment of the subscription. |
{- "cycle_executions": [
- {
- "tenure_type": "REGULAR",
- "sequence": 99,
- "cycles_completed": 9999,
- "cycles_remaining": 9999,
- "current_pricing_scheme_version": 1,
- "total_cycles": 999
}
], - "failed_payments_count": 999,
- "outstanding_balance": {
- "currency_code": "str",
- "value": "string"
}, - "last_payment": {
- "status": "COMPLETED",
- "amount": {
- "currency_code": "str",
- "value": "string"
}, - "time": "string"
}, - "next_billing_time": "string",
- "final_payment_time": "string",
- "last_failed_payment": {
- "reason_code": "PAYMENT_DENIED",
- "amount": {
- "currency_code": "str",
- "value": "string"
}, - "time": "string",
- "next_payment_retry_time": "string"
}
}
The cancel subscription request details.
reason required | string [ 1 .. 128 ] characters ^.*$ The reason for the cancellation of a subscription. |
{- "reason": "string"
}
The charge amount from the subscriber.
note required | string [ 1 .. 128 ] characters ^.*$ The reason or note for the subscription charge. | ||||
capture_type required | string [ 1 .. 24 ] characters ^[A-Z_]+$ The type of capture.
| ||||
required | object (Money) The currency and amount for a financial transaction, such as a balance or payment due. |
{- "note": "string",
- "capture_type": "OUTSTANDING_BALANCE",
- "amount": {
- "currency_code": "str",
- "value": "string"
}
}
The list of subscriptions.
Array of objects (subscription) [ 0 .. 32767 ] items An array of subscriptions. | |
Array of objects (Link Description) [ 1 .. 10 ] items An array of request-related HATEOAS links. |
{- "subscriptions": [
- {
- "status": "APPROVAL_PENDING",
- "status_change_note": "string",
- "status_update_time": "string",
- "id": "string",
- "plan_id": "string",
- "quantity": "string",
- "custom_id": "string",
- "plan_overridden": true,
- "links": [
- {
- "href": "string",
- "rel": "string",
- "method": "GET"
}
], - "start_time": "string",
- "shipping_amount": {
- "currency_code": "str",
- "value": "string"
}, - "subscriber": {
- "email_address": "string",
- "payer_id": "string",
- "name": {
- "given_name": "string",
- "surname": "string"
}, - "phone": {
- "phone_type": "FAX",
- "phone_number": {
- "national_number": "string"
}
}, - "shipping_address": {
- "type": "SHIPPING",
- "options": [
- {
- "id": "string",
- "label": "string",
- "selected": true,
- "type": "SHIPPING",
- "amount": {
- "currency_code": null,
- "value": null
}
}
], - "name": {
- "full_name": "string"
}, - "email_address": "string",
- "phone_number": {
- "country_code": "str",
- "national_number": "string"
}, - "address": {
- "address_line_1": "string",
- "address_line_2": "string",
- "admin_area_2": "string",
- "admin_area_1": "string",
- "postal_code": "string",
- "country_code": "st"
}
}, - "payment_source": {
- "card": {
- "name": "string",
- "last_digits": "string",
- "available_networks": [
- "VISA"
], - "from_request": {
- "last_digits": "stri",
- "expiry": "string"
}, - "stored_credential": {
- "payment_initiator": "CUSTOMER",
- "payment_type": "ONE_TIME",
- "usage": "FIRST",
- "previous_network_transaction_reference": {
- "id": null,
- "date": null,
- "acquirer_reference_number": null,
- "network": null
}
}, - "brand": "VISA",
- "type": "CREDIT",
- "authentication_result": {
- "liability_shift": "NO",
- "three_d_secure": {
- "authentication_status": null,
- "enrollment_status": null
}
}, - "attributes": {
- "vault": {
- "id": null,
- "status": null,
- "links": [ ],
- "customer": null
}
}, - "expiry": "string",
- "bin_details": {
- "bin": "string",
- "issuing_bank": "string",
- "products": [
- null
], - "bin_country_code": "string"
}, - "billing_address": {
- "address_line_1": "string",
- "address_line_2": "string",
- "admin_area_2": "string",
- "admin_area_1": "string",
- "postal_code": "string",
- "country_code": "st"
}, - "currency_code": "string"
}
}
}, - "billing_info": {
- "cycle_executions": [
- {
- "tenure_type": "REGULAR",
- "sequence": 99,
- "cycles_completed": 9999,
- "cycles_remaining": 9999,
- "current_pricing_scheme_version": 1,
- "total_cycles": 999
}
], - "failed_payments_count": 999,
- "outstanding_balance": {
- "currency_code": "str",
- "value": "string"
}, - "last_payment": {
- "status": "COMPLETED",
- "amount": {
- "currency_code": "str",
- "value": "string"
}, - "time": "string"
}, - "next_billing_time": "string",
- "final_payment_time": "string",
- "last_failed_payment": {
- "reason_code": "PAYMENT_DENIED",
- "amount": {
- "currency_code": "str",
- "value": "string"
}, - "time": "string",
- "next_payment_retry_time": "string"
}
}, - "create_time": "string",
- "update_time": "string",
- "plan": {
- "product_id": "stringstringstringstri",
- "name": "string",
- "description": "string",
- "billing_cycles": [
- {
- "tenure_type": "REGULAR",
- "sequence": 1,
- "total_cycles": 1,
- "pricing_scheme": {
- "version": 999,
- "pricing_model": "VOLUME",
- "tiers": [
- null
], - "fixed_price": {
- "currency_code": null,
- "value": null
}, - "create_time": "string",
- "update_time": "string"
}, - "frequency": {
- "interval_unit": "DAY",
- "interval_count": 1
}
}
], - "quantity_supported": false,
- "payment_preferences": {
- "auto_bill_outstanding": true,
- "setup_fee_failure_action": "CONTINUE",
- "payment_failure_threshold": 0,
- "setup_fee": {
- "currency_code": "str",
- "value": "string"
}
}, - "taxes": {
- "inclusive": true,
- "percentage": "string"
}
}
}
], - "links": [
- {
- "href": "string",
- "rel": "string",
- "method": "GET"
}
]
}
The create subscription request details.
plan_id required | string = 26 characters ^P-[A-Z0-9]*$ The ID of the plan. |
quantity | string [ 1 .. 32 ] characters ^([0-9]+|([0-9]+)?[.][0-9]+)$ The quantity of the product in the subscription. |
auto_renewal | boolean Default: false DEPRECATED. Indicates whether the subscription auto-renews after the billing cycles complete. |
custom_id | string [ 1 .. 127 ] characters ^[\x20-\x7E]+ The custom id for the subscription. Can be invoice id. |
start_time | string <ppaas_date_time_v3> (date_time) [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|... Default: "Current time" The date and time when the subscription started, in Internet date and time format. |
object (Money) The shipping charges. | |
object <payer_v1> (subscriber_request) The subscriber request information . | |
object (application_context) DEPRECATED. The application context, which customizes the payer experience during the subscription approval process with PayPal. | |
object (plan_override) An inline plan object to customise the subscription. You can override plan level default attributes by providing customised values for the subscription in this object. |
{- "plan_id": "stringstringstringstringst",
- "quantity": "string",
- "auto_renewal": false,
- "custom_id": "string",
- "start_time": "string",
- "shipping_amount": {
- "currency_code": "str",
- "value": "string"
}, - "subscriber": {
- "email_address": "string",
- "payer_id": "string",
- "name": {
- "given_name": "string",
- "surname": "string"
}, - "phone": {
- "phone_type": "FAX",
- "phone_number": {
- "national_number": "string"
}
}, - "shipping_address": {
- "type": "SHIPPING",
- "options": [
- {
- "id": "string",
- "label": "string",
- "selected": true,
- "type": "SHIPPING",
- "amount": {
- "currency_code": "str",
- "value": "string"
}
}
], - "name": {
- "full_name": "string"
}, - "email_address": "string",
- "phone_number": {
- "country_code": "str",
- "national_number": "string"
}, - "address": {
- "address_line_1": "string",
- "address_line_2": "string",
- "admin_area_2": "string",
- "admin_area_1": "string",
- "postal_code": "string",
- "country_code": "st"
}
}, - "payment_source": {
- "card": {
- "name": "string",
- "number": "stringstrings",
- "security_code": "stri",
- "expiry": "string",
- "type": "CREDIT",
- "brand": "VISA",
- "billing_address": {
- "address_line_1": "string",
- "address_line_2": "string",
- "admin_area_2": "string",
- "admin_area_1": "string",
- "postal_code": "string",
- "country_code": "st"
}, - "attributes": {
- "customer": {
- "id": "string",
- "email_address": "string",
- "phone": {
- "phone_type": "FAX",
- "phone_number": {
- "national_number": null
}
}, - "merchant_customer_id": "string"
}, - "vault": {
- "store_in_vault": "ON_SUCCESS"
}, - "verification": {
- "method": "SCA_ALWAYS"
}
}
}
}
}, - "application_context": {
- "brand_name": "string",
- "shipping_preference": "GET_FROM_FILE",
- "user_action": "CONTINUE",
- "locale": "string",
- "payment_method": {
- "payee_preferred": "UNRESTRICTED"
}
}, - "plan": {
- "billing_cycles": [
- {
- "sequence": 1,
- "total_cycles": 999,
- "pricing_scheme": {
- "version": 999,
- "pricing_model": "VOLUME",
- "tiers": [
- {
- "starting_quantity": "string",
- "ending_quantity": "string",
- "amount": {
- "currency_code": null,
- "value": null
}
}
], - "fixed_price": {
- "currency_code": "str",
- "value": "string"
}, - "create_time": "string",
- "update_time": "string"
}
}
], - "payment_preferences": {
- "auto_bill_outstanding": true,
- "setup_fee_failure_action": "CONTINUE",
- "payment_failure_threshold": 999,
- "setup_fee": {
- "currency_code": "str",
- "value": "string"
}
}, - "taxes": {
- "inclusive": true,
- "percentage": "string"
}
}
}
The request to update the quantity of the product or service in a subscription. You can also use this method to switch the plan and update the shipping_amount
and shipping_address
values for the subscription. This type of update requires the buyer's consent.
plan_id | string = 26 characters ^P-[A-Z0-9]*$ The unique PayPal-generated ID for the plan. |
quantity | string [ 1 .. 32 ] characters ^([0-9]+|([0-9]+)?[.][0-9]+)$ The quantity of the product or service in the subscription. |
object (Money) The shipping charges. | |
object (shipping_detail) The shipping address of the subscriber. | |
object (application_context) The application context, which customizes the payer experience during the subscription approval process with PayPal. | |
object (plan_override) An inline plan object to customise the subscription. You can override plan level default attributes by providing customised values for the subscription in this object. Any existing overrides will not be carried forward during subscription revise. |
{- "plan_id": "stringstringstringstringst",
- "quantity": "string",
- "shipping_amount": {
- "currency_code": "str",
- "value": "string"
}, - "shipping_address": {
- "type": "SHIPPING",
- "options": [
- {
- "id": "string",
- "label": "string",
- "selected": true,
- "type": "SHIPPING",
- "amount": {
- "currency_code": "str",
- "value": "string"
}
}
], - "name": {
- "full_name": "string"
}, - "email_address": "string",
- "phone_number": {
- "country_code": "str",
- "national_number": "string"
}, - "address": {
- "address_line_1": "string",
- "address_line_2": "string",
- "admin_area_2": "string",
- "admin_area_1": "string",
- "postal_code": "string",
- "country_code": "st"
}
}, - "application_context": {
- "brand_name": "string",
- "shipping_preference": "GET_FROM_FILE",
- "locale": "string",
- "payment_method": {
- "payee_preferred": "UNRESTRICTED"
}
}, - "plan": {
- "billing_cycles": [
- {
- "sequence": 1,
- "total_cycles": 999,
- "pricing_scheme": {
- "version": 999,
- "pricing_model": "VOLUME",
- "tiers": [
- {
- "starting_quantity": "string",
- "ending_quantity": "string",
- "amount": {
- "currency_code": null,
- "value": null
}
}
], - "fixed_price": {
- "currency_code": "str",
- "value": "string"
}, - "create_time": "string",
- "update_time": "string"
}
}
], - "payment_preferences": {
- "auto_bill_outstanding": true,
- "setup_fee_failure_action": "CONTINUE",
- "payment_failure_threshold": 999,
- "setup_fee": {
- "currency_code": "str",
- "value": "string"
}
}, - "taxes": {
- "inclusive": true,
- "percentage": "string"
}
}
}
The request to update the quantity of the product or service in a subscription. You can also use this method to switch the plan and update the shipping_amount
and shipping_address
values for the subscription. This type of update requires the buyer's consent.
plan_id | string = 26 characters ^P-[A-Z0-9]*$ The unique PayPal-generated ID for the plan. |
quantity | string [ 1 .. 32 ] characters ^([0-9]+|([0-9]+)?[.][0-9]+)$ The quantity of the product or service in the subscription. |
object (Money) The shipping charges. | |
object (shipping_detail) The shipping address of the subscriber. | |
object (plan_override) An inline plan object to customise the subscription. You can override plan level default attributes by providing customised values for the subscription in this object. Any existing overrides will not be carried forward during subscription revise. |
{- "plan_id": "stringstringstringstringst",
- "quantity": "string",
- "shipping_amount": {
- "currency_code": "str",
- "value": "string"
}, - "shipping_address": {
- "type": "SHIPPING",
- "options": [
- {
- "id": "string",
- "label": "string",
- "selected": true,
- "type": "SHIPPING",
- "amount": {
- "currency_code": "str",
- "value": "string"
}
}
], - "name": {
- "full_name": "string"
}, - "email_address": "string",
- "phone_number": {
- "country_code": "str",
- "national_number": "string"
}, - "address": {
- "address_line_1": "string",
- "address_line_2": "string",
- "admin_area_2": "string",
- "admin_area_1": "string",
- "postal_code": "string",
- "country_code": "st"
}
}, - "plan": {
- "billing_cycles": [
- {
- "sequence": 1,
- "total_cycles": 999,
- "pricing_scheme": {
- "version": 999,
- "pricing_model": "VOLUME",
- "tiers": [
- {
- "starting_quantity": "string",
- "ending_quantity": "string",
- "amount": {
- "currency_code": null,
- "value": null
}
}
], - "fixed_price": {
- "currency_code": "str",
- "value": "string"
}, - "create_time": "string",
- "update_time": "string"
}
}
], - "payment_preferences": {
- "auto_bill_outstanding": true,
- "setup_fee_failure_action": "CONTINUE",
- "payment_failure_threshold": 999,
- "setup_fee": {
- "currency_code": "str",
- "value": "string"
}
}, - "taxes": {
- "inclusive": true,
- "percentage": "string"
}
}
}
The response to a request to update the quantity of the product or service in a subscription. You can also use this method to switch the plan and update the shipping_amount
and shipping_address
values for the subscription. This type of update requires the buyer's consent.
plan_id | string = 26 characters ^P-[A-Z0-9]*$ The unique PayPal-generated ID for the plan. |
quantity | string [ 1 .. 32 ] characters ^([0-9]+|([0-9]+)?[.][0-9]+)$ The quantity of the product or service in the subscription. |
object (Money) The shipping charges. | |
object (shipping_detail) The shipping address of the subscriber. | |
object (plan_override) An inline plan object to customise the subscription. You can override plan level default attributes by providing customised values for the subscription in this object. Any existing overrides will not be carried forward during subscription revise. | |
plan_overridden | boolean Indicates whether the subscription has overridden any plan attributes. |
Array of objects (Link Description) An array of request-related HATEOAS links. |
{- "plan_id": "stringstringstringstringst",
- "quantity": "string",
- "shipping_amount": {
- "currency_code": "str",
- "value": "string"
}, - "shipping_address": {
- "type": "SHIPPING",
- "options": [
- {
- "id": "string",
- "label": "string",
- "selected": true,
- "type": "SHIPPING",
- "amount": {
- "currency_code": "str",
- "value": "string"
}
}
], - "name": {
- "full_name": "string"
}, - "email_address": "string",
- "phone_number": {
- "country_code": "str",
- "national_number": "string"
}, - "address": {
- "address_line_1": "string",
- "address_line_2": "string",
- "admin_area_2": "string",
- "admin_area_1": "string",
- "postal_code": "string",
- "country_code": "st"
}
}, - "plan": {
- "billing_cycles": [
- {
- "sequence": 1,
- "total_cycles": 999,
- "pricing_scheme": {
- "version": 999,
- "pricing_model": "VOLUME",
- "tiers": [
- {
- "starting_quantity": "string",
- "ending_quantity": "string",
- "amount": {
- "currency_code": null,
- "value": null
}
}
], - "fixed_price": {
- "currency_code": "str",
- "value": "string"
}, - "create_time": "string",
- "update_time": "string"
}
}
], - "payment_preferences": {
- "auto_bill_outstanding": true,
- "setup_fee_failure_action": "CONTINUE",
- "payment_failure_threshold": 999,
- "setup_fee": {
- "currency_code": "str",
- "value": "string"
}
}, - "taxes": {
- "inclusive": true,
- "percentage": "string"
}
}, - "plan_overridden": true,
- "links": [
- {
- "href": "string",
- "rel": "string",
- "method": "GET"
}
]
}
The subscription status details.
status | string [ 1 .. 24 ] characters ^[A-Z_]+$ The status of the subscription.
| ||||||||||||||
status_change_note | string [ 1 .. 128 ] characters ^.*$ The reason or notes for the status of the subscription. | ||||||||||||||
status_update_time | string <ppaas_date_time_v3> (date_time) [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|... The date and time, in Internet date and time format. Seconds are required while fractional seconds are optional. Note: The regular expression provides guidance but does not reject all invalid dates. |
{- "status": "APPROVAL_PENDING",
- "status_change_note": "string",
- "status_update_time": "string"
}
The suspend subscription request details.
reason required | string [ 1 .. 128 ] characters ^.*$ The reason for suspension of the Subscription. |
{- "reason": "string"
}
The tax ID of the customer. The customer is also known as the payer. Both tax_id
and tax_id_type
are required.
tax_id required | string [ 1 .. 14 ] characters ([a-zA-Z0-9]) The customer's tax ID value. | ||||||
tax_id_type required | string [ 1 .. 14 ] characters ^[A-Z0-9_]+$ The customer's tax ID type.
|
{- "tax_id": "string",
- "tax_id_type": "BR_CPF"
}
The tax details.
inclusive | boolean Default: true Indicates whether the tax was already included in the billing amount. |
percentage required | string <ppaas_common_percentage_v2> (percentage) ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$ The tax percentage on the billing amount. |
{- "inclusive": true,
- "percentage": "string"
}
The tax details.
inclusive | boolean Indicates whether the tax was already included in the billing amount. |
percentage | string <ppaas_common_percentage_v2> (percentage) ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$ The tax percentage on the billing amount. |
{- "inclusive": true,
- "percentage": "string"
}
The reason code that is associated with current instrument state. Use this code to get more information about the financial instrument (FI) state.
The reason code that is associated with current instrument state. Use this code to get more information about the financial instrument (FI) state.
Enum Value | Description |
---|---|
INACTIVE_DUE_TO_EXPIRY | Reason is inactive due to expiry. |
INACTIVE_DUE_TO_HARD_BUSINESS_FAILURE | Reason is inactive due to hard business failure. |
INACTIVE_DUE_TO_SOFT_BUSINESS_FAILURE | Reason is inactive due to soft business failure. |
NEARING_EXPIRY | Reason is nearing of the instrument expiry. |
NOT_APPLICABLE | Reason is not applicable. |
ON_HOLD_DUE_TO_PENDING_AUTHORIZATION | Reason is on hold due to pending authorization. |
ON_HOLD_DUE_TO_PENDING_CONFIRMATION | Reason is on hold due to pending confirmation. |
INACTIVE_DUE_TO_PENDING_ORIGINAL_USER_CHECK | Reason is inactive due to pending original user check. |
INACTIVE_DUE_TO_UNENROLL | Reason is inactive due to enroll status reason. |
"INACTIVE_DUE_TO_EXPIRY"
Results of 3D Secure Authentication.
authentication_status | string (pares_status) [ 1 .. 255 ] characters ^[0-9A-Z_]+$ The outcome of the issuer's authentication.
| ||||||||||||||||||
enrollment_status | string (enrolled) [ 1 .. 255 ] characters ^[0-9A-Z_]+$ Status of authentication eligibility.
|
{- "authentication_status": "Y",
- "enrollment_status": "Y"
}
Identifies the reason of 3DS contingency.
Identifies the reason of 3DS contingency.
Enum Value | Description |
---|---|
MANDATED | A mandate or regulation requires 3DS. |
NON_MANDATED | A reason other than a mandate or merchant request. |
MERCHANT_REQUESTED | A merchant requested 3DS explicitly. |
SOFT_DECLINE | Soft decline by processor indicating 3DS required. |
DATA_ONLY_3DS | A merchant shares only the transaction data with the Issuer through the 3DS rail, without presenting a challenge to the cardholder. |
"MANDATED"
Identifies the source of 3DS contingency.
Identifies the source of 3DS contingency.
Enum Value | Description |
---|---|
CARD | Due to the state of the card in the wallet. i.e. the card needs 3DS confirmation. |
TRANSACTION | Due to the transaction context, not due to the card state. |
RISK | Due to Risk decisioning, not due to card state or transaction context. |
AUTHORIZATION | Identified as 3DS required during authorization. |
"CARD"
The ISO-8601-formatted length of time in years, months, weeks, days, hours, minutes, and seconds.
Note: The format isPyYmMdDThHmMsS
. When an amount is zero, you can omit it. Because week cannot co-exist with other time components in ISO-8601 duration, specifyP7D
. Make provisions to incorporate the effects of daylight savings time.
The ISO-8601-formatted length of time in years, months, weeks, days, hours, minutes, and seconds.
Note: The format isPyYmMdDThHmMsS
. When an amount is zero, you can omit it. Because week cannot co-exist with other time components in ISO-8601 duration, specifyP7D
. Make provisions to incorporate the effects of daylight savings time.
"string"
The transaction details.
status | string (Capture Status) The status of the captured payment.
| ||||||||||||||
id required | string [ 3 .. 50 ] characters The PayPal-generated transaction ID. | ||||||||||||||
required | object (amount_with_breakdown) The breakdown details for the amount. Includes the gross, tax, fee, and shipping amounts. | ||||||||||||||
object (Name) The name of the customer. | |||||||||||||||
payer_email | string <ppaas_common_email_address_v2> (email_address) [ 3 .. 254 ] characters ^(?:[A-Za-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[A-Za... The email ID of the customer. | ||||||||||||||
time required | string <ppaas_date_time_v3> (date_time) [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|... The date and time when the transaction was processed, in Internet date and time format. |
{- "status": "COMPLETED",
- "id": "string",
- "amount_with_breakdown": {
- "gross_amount": {
- "currency_code": "str",
- "value": "string"
}, - "total_item_amount": {
- "currency_code": "str",
- "value": "string"
}, - "fee_amount": {
- "currency_code": "str",
- "value": "string"
}, - "shipping_amount": {
- "currency_code": "str",
- "value": "string"
}, - "tax_amount": {
- "currency_code": "str",
- "value": "string"
}, - "net_amount": {
- "currency_code": "str",
- "value": "string"
}
}, - "payer_name": {
- "prefix": "string",
- "given_name": "string",
- "surname": "string",
- "middle_name": "string",
- "suffix": "string",
- "full_name": "string"
}, - "payer_email": "string",
- "time": "string"
}
The list transactions for a subscription request details.
Array of objects (transaction) [ 0 .. 32767 ] items An array of transactions. | |
total_items | integer [ 0 .. 500000000 ] The total number of items. |
total_pages | integer [ 0 .. 100000000 ] The total number of pages. |
Array of objects (Link Description) [ 1 .. 10 ] items An array of request-related HATEOAS links. |
{- "transactions": [
- {
- "status": "COMPLETED",
- "id": "string",
- "amount_with_breakdown": {
- "gross_amount": {
- "currency_code": "str",
- "value": "string"
}, - "total_item_amount": {
- "currency_code": "str",
- "value": "string"
}, - "fee_amount": {
- "currency_code": "str",
- "value": "string"
}, - "shipping_amount": {
- "currency_code": "str",
- "value": "string"
}, - "tax_amount": {
- "currency_code": "str",
- "value": "string"
}, - "net_amount": {
- "currency_code": "str",
- "value": "string"
}
}, - "payer_name": {
- "prefix": "string",
- "given_name": "string",
- "surname": "string",
- "middle_name": "string",
- "suffix": "string",
- "full_name": "string"
}, - "payer_email": "string",
- "time": "string"
}
], - "total_items": 500000000,
- "total_pages": 100000000,
- "links": [
- {
- "href": "string",
- "rel": "string",
- "method": "GET"
}
]
}
The update pricing scheme request details.
billing_cycle_sequence required | integer [ 1 .. 99 ] The billing cycle sequence. |
required | object (pricing_scheme) The pricing scheme details. |
{- "billing_cycle_sequence": 1,
- "pricing_scheme": {
- "version": 999,
- "pricing_model": "VOLUME",
- "tiers": [
- {
- "starting_quantity": "string",
- "ending_quantity": "string",
- "amount": {
- "currency_code": "str",
- "value": "string"
}
}
], - "fixed_price": {
- "currency_code": "str",
- "value": "string"
}, - "create_time": "string",
- "update_time": "string"
}
}
The update pricing scheme request details.
required | Array of objects (update_pricing_scheme_request) [ 1 .. 99 ] items An array of pricing schemes. |
{- "pricing_schemes": [
- {
- "billing_cycle_sequence": 1,
- "pricing_scheme": {
- "version": 999,
- "pricing_model": "VOLUME",
- "tiers": [
- {
- "starting_quantity": "string",
- "ending_quantity": "string",
- "amount": {
- "currency_code": "str",
- "value": "string"
}
}
], - "fixed_price": {
- "currency_code": "str",
- "value": "string"
}, - "create_time": "string",
- "update_time": "string"
}
}
]
}
Describes the URL.
Describes the URL.
Type associated with an institution URL.
Type associated with an institution URL.
Enum Value | Description |
---|---|
SETTINGS | Settings URL Type. |
TERMS_AND_CONDITIONS | Terms & Conditions URL Type. |
"SETTINGS"
The identifier for the vaulted instrument.
The identifier for the vaulted instrument.
"stringstringstringstringst"
Basic vault instruction specification that can be extended by specific payment sources that supports vaulting.
store_in_vault | string (store_in_vault_instruction) [ 1 .. 255 ] characters ^[0-9A-Z_]+$ Defines how and when the payment source gets vaulted.
|
{- "store_in_vault": "ON_SUCCESS"
}
The details about a saved payment source.
id | string [ 1 .. 255 ] characters The PayPal-generated ID for the saved payment source. | ||||||||
status | string (Vault Status) [ 1 .. 255 ] characters ^[0-9A-Z_]+$ The vault status.
| ||||||||
Array of objects (Link Description) [ 1 .. 10 ] items An array of request-related HATEOAS links. |
{- "id": "string",
- "status": "VAULTED",
- "links": [
- {
- "href": "string",
- "rel": "string",
- "method": "GET"
}
]
}
The details about a saved payment source.
id | string [ 1 .. 255 ] characters The PayPal-generated ID for the saved payment source. | ||||||||
status | string (Vault Status) [ 1 .. 255 ] characters ^[0-9A-Z_]+$ The vault status.
|
{- "id": "string",
- "status": "VAULTED"
}