Paypal API
  1. Manage Accounts
Paypal API
  • Authorization
    • Generate access_token
      POST
    • Terminate access_token
      POST
    • User Info
      GET
    • Generate client_token
      POST
  • Orders
    • Create order
      POST
    • Show order details
      GET
    • Update order
      PATCH
    • Authorize payment for order
      POST
    • Capture payment for order
      POST
  • Payments
    • Show details for authorized payment
      GET
    • Reauthorize authorized payment
      POST
    • Void authorized payment
      POST
    • Capture authorized payment
      POST
    • Show captured payment details
      GET
    • Refund captured payment
      POST
    • Show refund details
      GET
  • Invoices
    • Invoices
      • Generate invoice number
      • Create draft invoice
      • Show invoice details
      • List invoices
      • Generate QR code
      • Fully update invoice
      • Send invoice
      • Send invoice reminder
      • Cancel sent invoice
      • Delete invoice
      • Search for invoices
      • Record payment for invoice
      • Delete external payment
      • Record refund for invoice
      • Delete external refund
    • Templates
      • List templates
      • Create template
      • Show template details
      • Fully update template
      • Delete template
  • Subscriptions
    • Catalog Products
      • Create product
      • List products
      • Show product details
      • Update product
    • Plans
      • Create plan
      • List plans
      • Show plan details
      • Update plan
      • Deactivate plan
      • Activate plan
      • Update pricing
    • Subscriptions
      • Create subscription
      • Show subscription details
      • Update subscription
      • Revise plan or quantity of subscription
      • Suspend subscription
      • Activate subscription
      • Cancel subscription
      • Capture authorized payment on subscription
      • List transactions for subscription
  • Payouts
    • Create batch payout
    • Show payout batch details
    • Show payout item details
    • Cancel unclaimed payout item
  • Webhooks
    • List available events
    • Create webhook
    • List webhooks
    • Show webhook details
    • List event notifications
    • List event subscriptions for webhook
    • Show event notification details
    • Trigger a sample event
    • Verify webhook signature
    • Resend event notification
    • Simulate webhook event
    • Update webhook
    • Delete webhook
  • Shipment Tracking
    • Add tracking information for multiple PayPal transactions
    • Show tracking information
    • Update or cancel tracking information for PayPal transaction
  • Transaction Search
    • List transactions
    • List all balances
  • Disputes
    • List disputes
    • Show dispute details
    • Accept claim
    • Appeal dispute
    • Settle dispute
    • Update dispute status
    • Make offer to resolve dispute
    • Provide evidence
    • Acknowledge returned item
    • Provide supporting information for dispute
    • Escalate dispute to claim
    • Accept offer to resolve dispute
    • Send message about dispute to other party
    • Deny offer to resolve dispute
    • Partially update dispute
  • Onboarding (Limited Release)
    • Manage Accounts
      • Create managed account
        POST
      • Search managed account through external id
        GET
      • Search managed account by Seller Id
        GET
      • Partially updates information for a managed account
        PATCH
      • Shows collection of registered wallet domains
        GET
  1. Manage Accounts

Create managed account

POST
/v3/customer/managed-accounts
Creates a managed account. Submit the account information in the JSON request body.
The details on what information is required for different business types in different countries can be found on PayPal Developer Portal.
The fields and parameters are described on PayPal Developer Portal under Managed Accounts.

请求参数

Authorization
在 Header 添加参数
Authorization
,其值为在 Bearer 之后拼接 Token
示例:
Authorization: Bearer ********************
Header 参数
Content-Type
string 
必需
The Content-Type header field is used to specify the nature of the data in the body of an entity. PayPal REST APIs support application/json.
示例值:
application/json
Accept
string 
必需
The Accept header field is used to specify the form of response that can be understand and processed
示例值:
application/json
Prefer
string 
必需
(Optional)The server returns complete resource representation along with process_view which includes policies information along with data/documents requirement to fulfill those.
示例值:
views=process_view
Body 参数application/json
external_id
string 
必需
legal_country_code
string 
必需
organization
string 
必需
user_id
string 
必需
primary_currency_code
string 
必需
individual_owners
array [object {2}] 
必需
names
array [object {3}] 
可选
addresses
array [object {5}] 
可选
business_entity
object 
必需
type
string 
必需
incorporation_details
object 
必需
names
array [object {2}] 
必需
registered_business_address
object 
必需
phone_numbers
array [object {3}] 
必需
identification_documents
array [object {3}] 
必需
beneficial_owners
object 
必需
office_bearers
array [object {6}] 
必需
declarations
array [object {2}] 
必需
agreements
array [object {4}] 
必需
type
string 
必需
major_version
integer 
必需
minor_version
integer 
必需
accepted_time
string 
必需
示例
{
  "external_id": "EXT-{{$timestamp}}",
  "legal_country_code": "US",
  "organization": "{{managed_path_organization}}",
  "user_id": "{{$timestamp}}",
  "primary_currency_code": "USD",
  "individual_owners": [
    {
      "names": [
        {
          "given_name": "TONY",
          "surname": "STARK",
          "type": "LEGAL"
        }
      ],
      "addresses": [
        {
          "address_line_1": "W 294 STR",
          "admin_area_2": "New York",
          "postal_code": "95014",
          "country_code": "US",
          "type": "HOME"
        }
      ]
    }
  ],
  "business_entity": {
    "type": "CORPORATION",
    "incorporation_details": {},
    "names": [
      {
        "business_name": "STARK INDUSTRY.",
        "type": "LEGAL"
      }
    ],
    "registered_business_address": {
      "address_line_1": "W 294 STR",
      "admin_area_2": "New York",
      "postal_code": "95014",
      "country_code": "US"
    },
    "phone_numbers": [
      {
        "country_code": "1",
        "national_number": "1",
        "type": "BUSINESS"
      }
    ],
    "identification_documents": [
      {
        "identification_number": "32-2124444",
        "issuing_country_code": "US",
        "type": "EMPLOYER_IDENTIFICATION_NUMBER"
      }
    ],
    "beneficial_owners": {
      "individuals": [
        {
          "names": [
            {
              "given_name": "Tom",
              "surname": "Norman",
              "type": "LEGAL"
            }
          ],
          "citizenship": "US",
          "addresses": [
            {
              "address_line_1": "W 294 STR",
              "admin_area_2": "New York",
              "postal_code": "95148",
              "country_code": "US",
              "type": "HOME"
            }
          ],
          "birth_details": {
            "date_of_birth": "1960-01-01"
          },
          "identification_documents": [
            {
              "identification_number": "123-44-6789",
              "issuing_country_code": "US",
              "type": "SOCIAL_SECURITY_NUMBER"
            }
          ],
          "percentage_of_ownership": "26",
          "controlling_influence": false
        },
        {
          "names": [
            {
              "given_name": "Mary",
              "surname": "Smoth",
              "type": "LEGAL"
            }
          ],
          "citizenship": "US",
          "addresses": [
            {
              "address_line_1": "W 294 STR",
              "admin_area_2": "New York",
              "postal_code": "95148",
              "country_code": "US",
              "type": "HOME"
            }
          ],
          "birth_details": {
            "date_of_birth": "1960-01-01"
          },
          "identification_documents": [
            {
              "identification_number": "123-54-6789",
              "issuing_country_code": "US",
              "type": "SOCIAL_SECURITY_NUMBER"
            }
          ],
          "percentage_of_ownership": "35",
          "controlling_influence": false
        }
      ]
    },
    "office_bearers": [
      {
        "names": [
          {
            "given_name": "Katy",
            "surname": "Collins",
            "type": "LEGAL"
          }
        ],
        "citizenship": "US",
        "addresses": [
          {
            "address_line_1": "W 294 STR",
            "admin_area_2": "New York",
            "postal_code": "22903",
            "country_code": "US",
            "type": "HOME"
          }
        ],
        "birth_details": {
          "date_of_birth": "1990-01-01"
        },
        "role": "CHAIRMAN"
      },
      {
        "names": [
          {
            "given_name": "Donald",
            "surname": "TREASWILLIAMSON",
            "type": "LEGAL"
          }
        ],
        "citizenship": "US",
        "addresses": [
          {
            "address_line_1": "W 294 STR",
            "admin_area_2": "New York",
            "postal_code": "29212",
            "country_code": "US",
            "type": "HOME"
          }
        ],
        "birth_details": {
          "date_of_birth": "1991-05-30"
        },
        "identification_documents": [
          {
            "identification_number": "729265100",
            "issuing_country_code": "US",
            "type": "SOCIAL_SECURITY_NUMBER"
          }
        ]
      }
    ],
    "declarations": [
      {
        "name": "TWENTY_FIVE_PERCENT_BENEFICIAL_OWNER",
        "value": "YES"
      }
    ]
  },
  "agreements": [
    {
      "type": "TERMS_ACCEPTED",
      "major_version": 3,
      "minor_version": 3,
      "accepted_time": "2022-09-10T00:00:00Z"
    },
    {
      "type": "PERSONAL_INFORMATION_COLLECTION_CONSENT",
      "major_version": 1,
      "minor_version": 1,
      "accepted_time": "2022-09-10T00:00:00Z"
    }
  ]
}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api-m.sandbox.paypal.com/v3/customer/managed-accounts' \
--header 'Accept: application/json' \
--header 'Prefer: views=process_view' \
--header 'Content-Type: application/json' \
--data-raw '{
    "external_id": "EXT-{{$timestamp}}",
    "legal_country_code": "US",
    "organization": "{{managed_path_organization}}",
    "user_id": "{{$timestamp}}",
    "primary_currency_code": "USD",
    "individual_owners": [
        {
            "names": [
                {
                    "given_name": "TONY",
                    "surname": "STARK",
                    "type": "LEGAL"
                }
            ],
            "addresses": [
                {
                    "address_line_1": "W 294 STR",
                    "admin_area_2": "New York",
                    "postal_code": "95014",
                    "country_code": "US",
                    "type": "HOME"
                }
            ]
        }
    ],
    "business_entity": {
        "type": "CORPORATION",
        "incorporation_details": {},
        "names": [
            {
                "business_name": "STARK INDUSTRY.",
                "type": "LEGAL"
            }
        ],
        "registered_business_address": {
            "address_line_1": "W 294 STR",
            "admin_area_2": "New York",
            "postal_code": "95014",
            "country_code": "US"
        },
        "phone_numbers": [
            {
                "country_code": "1",
                "national_number": "1",
                "type": "BUSINESS"
            }
        ],
        "identification_documents": [
            {
                "identification_number": "32-2124444",
                "issuing_country_code": "US",
                "type": "EMPLOYER_IDENTIFICATION_NUMBER"
            }
        ],
        "beneficial_owners": {
            "individuals": [
                {
                    "names": [
                        {
                            "given_name": "Tom",
                            "surname": "Norman",
                            "type": "LEGAL"
                        }
                    ],
                    "citizenship": "US",
                    "addresses": [
                        {
                            "address_line_1": "W 294 STR",
                            "admin_area_2": "New York",
                            "postal_code": "95148",
                            "country_code": "US",
                            "type": "HOME"
                        }
                    ],
                    "birth_details": {
                        "date_of_birth": "1960-01-01"
                    },
                    "identification_documents": [
                        {
                            "identification_number": "123-44-6789",
                            "issuing_country_code": "US",
                            "type": "SOCIAL_SECURITY_NUMBER"
                        }
                    ],
                    "percentage_of_ownership": "26",
                    "controlling_influence": false
                },
                {
                    "names": [
                        {
                            "given_name": "Mary",
                            "surname": "Smoth",
                            "type": "LEGAL"
                        }
                    ],
                    "citizenship": "US",
                    "addresses": [
                        {
                            "address_line_1": "W 294 STR",
                            "admin_area_2": "New York",
                            "postal_code": "95148",
                            "country_code": "US",
                            "type": "HOME"
                        }
                    ],
                    "birth_details": {
                        "date_of_birth": "1960-01-01"
                    },
                    "identification_documents": [
                        {
                            "identification_number": "123-54-6789",
                            "issuing_country_code": "US",
                            "type": "SOCIAL_SECURITY_NUMBER"
                        }
                    ],
                    "percentage_of_ownership": "35",
                    "controlling_influence": false
                }
            ]
        },
        "office_bearers": [
            {
                "names": [
                    {
                        "given_name": "Katy",
                        "surname": "Collins",
                        "type": "LEGAL"
                    }
                ],
                "citizenship": "US",
                "addresses": [
                    {
                        "address_line_1": "W 294 STR",
                        "admin_area_2": "New York",
                        "postal_code": "22903",
                        "country_code": "US",
                        "type": "HOME"
                    }
                ],
                "birth_details": {
                    "date_of_birth": "1990-01-01"
                },
                "role": "CHAIRMAN"
            },
            {
                "names": [
                    {
                        "given_name": "Donald",
                        "surname": "TREASWILLIAMSON",
                        "type": "LEGAL"
                    }
                ],
                "citizenship": "US",
                "addresses": [
                    {
                        "address_line_1": "W 294 STR",
                        "admin_area_2": "New York",
                        "postal_code": "29212",
                        "country_code": "US",
                        "type": "HOME"
                    }
                ],
                "birth_details": {
                    "date_of_birth": "1991-05-30"
                },
                "identification_documents": [
                    {
                        "identification_number": "729265100",
                        "issuing_country_code": "US",
                        "type": "SOCIAL_SECURITY_NUMBER"
                    }
                ]
            }
        ],
        "declarations": [
            {
                "name": "TWENTY_FIVE_PERCENT_BENEFICIAL_OWNER",
                "value": "YES"
            }
        ]
    },
    "agreements": [
        {
            "type": "TERMS_ACCEPTED",
            "major_version": 3,
            "minor_version": 3,
            "accepted_time": "2022-09-10T00:00:00Z"
        },
        {
            "type": "PERSONAL_INFORMATION_COLLECTION_CONSENT",
            "major_version": 1,
            "minor_version": 1,
            "accepted_time": "2022-09-10T00:00:00Z"
        }
    ]
}'

返回响应

🟢201201 - [US] Create Account for Corporation
application/json
Body
account_id
string 
必需
legal_country_code
string 
必需
individual_owners
array [object {3}] 
必需
id
string 
可选
names
array [object {4}] 
可选
primary_residence
object 
可选
business_entity
object 
必需
type
string 
必需
incorporation_details
object 
必需
names
array [object {3}] 
必需
registered_business_address
object 
必需
phone_numbers
array [object {4}] 
必需
identification_documents
array [object {4}] 
必需
beneficial_owners
object 
必需
office_bearers
array [object {7}] 
必需
declarations
array [object {2}] 
必需
agreements
array [object {2}] 
必需
type
string 
必需
accepted_time
string 
必需
external_id
string 
必需
organization
string 
必需
user_id
string 
必需
financial_instruments
object 
必需
banks
array [object {10}] 
必需
primary_currency_code
string 
必需
soft_descriptor
string 
必需
capabilities
array [object {3}] 
必需
name
string 
必需
status
string 
必需
limits
array [object {4}] 
可选
process_view
object 
必需
processes
array [object {3}] 
必需
links
array [object {3}] 
必需
href
string 
必需
rel
string 
必需
method
string 
必需
示例
{
  "account_id": "WCFPN4TSJG6L8",
  "legal_country_code": "US",
  "individual_owners": [
    {
      "id": "WCFPN4TSJG6L8",
      "names": [
        {
          "given_name": "TONY",
          "surname": "STARK",
          "id": "NJZNRF4WCEDK8",
          "type": "LEGAL"
        }
      ],
      "primary_residence": {
        "address_line_1": "W 294 STR",
        "admin_area_2": "New York",
        "postal_code": "95014",
        "country_code": "US"
      }
    }
  ],
  "business_entity": {
    "type": "CORPORATION",
    "incorporation_details": {},
    "names": [
      {
        "business_name": "STARK INDUSTRY.",
        "id": "PDQ5ALWYDGN72",
        "type": "LEGAL"
      }
    ],
    "registered_business_address": {
      "address_line_1": "W 294 STR",
      "admin_area_2": "New York",
      "postal_code": "95014",
      "country_code": "US"
    },
    "phone_numbers": [
      {
        "country_code": "1",
        "national_number": "1",
        "id": "8X8R3PJKLL248",
        "type": "BUSINESS"
      }
    ],
    "identification_documents": [
      {
        "id": "YQMC8E4KWPDTN",
        "identification_number": "****",
        "issuing_country_code": "US",
        "type": "EMPLOYER_IDENTIFICATION_NUMBER"
      }
    ],
    "beneficial_owners": {
      "individuals": [
        {
          "id": "H6M8DTKK4EPVQ",
          "names": [
            {
              "given_name": "Tom",
              "surname": "Norman",
              "id": "GRS7Q7F537S3N",
              "type": "LEGAL"
            }
          ],
          "citizenship": "US",
          "addresses": [
            {
              "address_line_1": "W 294 STR",
              "admin_area_2": "New York",
              "postal_code": "95148",
              "country_code": "US",
              "id": "6ZEHZAFBV9KY4",
              "type": "HOME"
            }
          ],
          "birth_details": {
            "date_of_birth": "1960-01-01"
          },
          "identification_documents": [
            {
              "id": "DVLF9C5Q2NXRQ",
              "identification_number": "****",
              "issuing_country_code": "US",
              "type": "SOCIAL_SECURITY_NUMBER"
            }
          ],
          "percentage_of_ownership": "26",
          "controlling_influence": false
        },
        {
          "id": "CSLV8CML2A6B2",
          "names": [
            {
              "given_name": "Mary",
              "surname": "Smoth",
              "id": "SJTSKNT6RRAX4",
              "type": "LEGAL"
            }
          ],
          "citizenship": "US",
          "addresses": [
            {
              "address_line_1": "W 294 STR",
              "admin_area_2": "New York",
              "postal_code": "95148",
              "country_code": "US",
              "id": "Q8XVYQAV9UVQJ",
              "type": "HOME"
            }
          ],
          "birth_details": {
            "date_of_birth": "1960-01-01"
          },
          "identification_documents": [
            {
              "id": "PM98FKLGMTDEW",
              "identification_number": "****",
              "issuing_country_code": "US",
              "type": "SOCIAL_SECURITY_NUMBER"
            }
          ],
          "percentage_of_ownership": "35",
          "controlling_influence": false
        }
      ]
    },
    "office_bearers": [
      {
        "id": "H25V3PXWLYMAW",
        "names": [
          {
            "given_name": "Katy",
            "surname": "Collins",
            "id": "ZFM46E6KN4FHW",
            "type": "LEGAL"
          }
        ],
        "citizenship": "US",
        "addresses": [
          {
            "address_line_1": "W 294 STR",
            "admin_area_2": "New York",
            "postal_code": "22903",
            "country_code": "US",
            "id": "MG59R54AEPVDC",
            "type": "HOME"
          }
        ],
        "birth_details": {
          "date_of_birth": "1990-01-01"
        },
        "role": "CHAIRMAN"
      },
      {
        "id": "QLBY4RAYCSSFS",
        "names": [
          {
            "given_name": "Donald",
            "surname": "TREASWILLIAMSON",
            "id": "CHEXASTTXQFV2",
            "type": "LEGAL"
          }
        ],
        "citizenship": "US",
        "addresses": [
          {
            "address_line_1": "W 294 STR",
            "admin_area_2": "New York",
            "postal_code": "29212",
            "country_code": "US",
            "id": "DRL3WMZLFRKPN",
            "type": "HOME"
          }
        ],
        "birth_details": {
          "date_of_birth": "1991-05-30"
        },
        "identification_documents": [
          {
            "id": "MUWYQQTZ2U396",
            "identification_number": "****",
            "issuing_country_code": "US",
            "type": "SOCIAL_SECURITY_NUMBER"
          }
        ]
      }
    ],
    "declarations": [
      {
        "name": "TWENTY_FIVE_PERCENT_BENEFICIAL_OWNER",
        "value": "YES"
      }
    ]
  },
  "agreements": [
    {
      "type": "TERMS_ACCEPTED",
      "accepted_time": "2022-09-10T00:00:00Z"
    },
    {
      "type": "PERSONAL_INFORMATION_COLLECTION_CONSENT",
      "accepted_time": "2022-09-10T00:00:00Z"
    }
  ],
  "external_id": "EXT-1682045234",
  "organization": "us",
  "user_id": "1682045234",
  "financial_instruments": {
    "banks": [
      {
        "id": "BA-QM4CAYLKZL8SA",
        "last_4_digits": "0882",
        "account_number_type": "BASIC_BANK_ACCOUNT_NUMBER",
        "account_type": "CHECKING",
        "routing_number": "074001048",
        "currency_code": "USD",
        "country_code": "US",
        "account_holder_details": {
          "name": "STARK INDUSTRY."
        },
        "branch_code": "08501",
        "bank_name": "KEY BANK NATIONAL ASSOCIATION"
      }
    ]
  },
  "primary_currency_code": "USD",
  "soft_descriptor": "STARKINDUST",
  "capabilities": [
    {
      "name": "RECEIVE_MONEY",
      "status": "ACTIVE"
    },
    {
      "name": "WITHDRAW_MONEY",
      "limits": [
        {
          "type": "AMOUNT",
          "unit": "USD",
          "value": "500.00",
          "remaining_value": "500.00"
        }
      ],
      "status": "ACTIVE"
    }
  ],
  "process_view": {
    "processes": [
      {
        "name": "MANAGED_PATH_KYC",
        "status": "NEED_MORE_DATA",
        "capabilities": [
          {
            "name": "WITHDRAW_MONEY",
            "limits": [
              {
                "type": "AMOUNT",
                "unit": "USD",
                "value": "500.00",
                "remaining_value": "500.00"
              }
            ]
          }
        ]
      },
      {
        "name": "MANAGED_PATH_BO_VERIFICATION",
        "status": "NEED_MORE_DATA",
        "capabilities": [
          {
            "name": "WITHDRAW_MONEY",
            "limits": [
              {
                "type": "AMOUNT",
                "unit": "USD",
                "value": "500.00",
                "remaining_value": "500.00"
              }
            ]
          }
        ]
      }
    ]
  },
  "links": [
    {
      "href": "https://api-m.sandbox.paypal.com/v3/customer/managed-accounts/WCFPN4TSJG6L8",
      "rel": "self",
      "method": "GET"
    },
    {
      "href": "https://api-m.sandbox.paypal.com/v3/customer/managed-accounts/WCFPN4TSJG6L8",
      "rel": "edit",
      "method": "PATCH"
    }
  ]
}
🟢201201 - [US] Create Account for Individual
🟢201201 - [US/Need More Data] Create Account
🟢201201 - [EU/FR] Create Account for Corporation
🟢201201 - [EU/FR] Create Account for Individual
🟢201201 - [EU/FR/Need More Data] Create Account
🟢201201 - Return Minimal Response
🟢201201 - Return Typical Response
🟢201201 - Return Detailed Response
🟠400400 Bad Request - Duplicate External ID
🟠400400 Bad Request - Invalid Bank Information
🟠401401 Unauthorized - Invalid Token
🟠422422 Unprocessable Entity - Invalid Organization
🔴500500 Internal Server Error - Internal Server Error
修改于 2023-08-16 07:18:59
上一页
Partially update dispute
下一页
Search managed account through external id
Built with