Create webhook - Paypal API

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Basic 之后拼接空格，以及经过 Base64 编码的 username:password

示例：

Authorization: Basic *****************

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

PayPal-Request-Id

string

必需

The server stores keys for 6 hours. The API callers can request the times to up to 72 hours by speaking to their Account Manager.

示例值:

Body 参数application/json

url

string

必需

event_types

array [object {1}]

必需

name

string

可选

示例

{
  "url": "{{webhook_url}}",
  "event_types": [
    {
      "name": "*"
    }
  ]
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://api-m.sandbox.paypal.com/v1/notifications/webhooks' \
--header 'PayPal-Request-Id: ' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic Og==' \
--data-raw '{
    "url": "{{webhook_url}}",
    "event_types": [
        {
            "name": "*"
        }
    ]
}'

返回响应

🟢201201 - Create Webhook

application/json

Body

id

string

必需

url

string

必需

event_types

array [object {2}]

必需

name

string

可选

description

string

可选

links

array [object {3}]

必需

href

string

必需

rel

string

必需

method

string

必需

示例

{
  "id": "1AV998667T7275054",
  "url": "https://enllwl46eqmr.x.pipedream.net",
  "event_types": [
    {
      "name": "*",
      "description": "ALL"
    }
  ],
  "links": [
    {
      "href": "https://api.sandbox.paypal.com/v1/notifications/webhooks/1AV998667T7275054",
      "rel": "self",
      "method": "GET"
    },
    {
      "href": "https://api.sandbox.paypal.com/v1/notifications/webhooks/1AV998667T7275054",
      "rel": "update",
      "method": "PATCH"
    },
    {
      "href": "https://api.sandbox.paypal.com/v1/notifications/webhooks/1AV998667T7275054",
      "rel": "delete",
      "method": "DELETE"
    }
  ]
}

🟢201201 - Create Webhook for Managed Accounts

🟠400400 Bad Request - Invalid URL

🟠400400 Bad Request - Webhook Already Exists

🟠400400 Bad Request - Webhook Limit Exceeded

🟠401401 Unauthorized - Invalid Token