0

0

通过PayPal订单详情API获取Payer信息与交易详情

DDD

DDD

发布时间:2025-09-13 12:06:12

|

235人浏览过

|

来源于php中文网

原创

通过PayPal订单详情API获取Payer信息与交易详情

本文旨在指导开发者如何通过PayPal的订单详情API(Order Details API)获取完整的交易数据和付款人(Payer)信息,特别是当PayPal仅返回Payer ID时。教程将详细阐述如何利用订单ID(而非Payer ID)构建API请求、处理响应,并提取包括电子邮件地址在内的关键付款人详情,附带Java示例代码和最佳实践。

在paypal交易流程中,有时回调url或某些场景下仅提供payerid。然而,payerid主要用于标识一个付款人,它本身并非一个唯一的交易标识符,因此paypal并没有直接通过payerid获取特定交易所有详细信息的api。要获取包括客户电子邮件地址、姓名及其他交易详情在内的完整数据,我们需要依赖于交易的唯一标识符,即order_id(订单id)或payment_id(支付id),并通过paypal的订单详情api进行查询。

1. 理解Payer ID与订单ID的区别

  • Payer ID: 标识一个PayPal账户的唯一ID。一个付款人可以进行多笔交易,因此PayerID无法唯一确定一笔特定的交易。
  • Order ID (或 Payment ID): 标识一笔PayPal订单或支付的唯一ID。这是获取特定交易详情的关键。通常在创建PayPal订单或授权支付时,PayPal会返回一个order_id或payment_id。开发者需要在支付流程中妥善保存此ID,以便后续查询。

当您在回调URL中只收到PayerID时,这通常意味着支付授权已完成,但您需要使用之前在支付发起阶段获得的order_id来查询该笔授权对应的订单详情。

2. 通过PayPal订单详情API获取交易数据

PayPal的订单详情API是获取交易完整信息的官方途径。该API允许您通过order_id检索特定订单的所有相关数据,包括付款人信息、购买单位详情、交易状态等。

2.1 认证与授权

所有PayPal API请求都需要进行认证。通常,这意味着您需要获取一个有效的Bearer Access Token。这个Token通过OAuth 2.0流程从PayPal的认证服务获取,并需要在每个API请求的Authorization头中传递。

// 假设您已有一个获取Access Token的方法
public String getAccessToken() {
    // 实现获取PayPal Access Token的逻辑
    // 通常涉及向PayPal /v1/oauth2/token 端点发送POST请求
    // 使用您的Client ID和Secret进行基本认证
    return "YOUR_PAYPAL_ACCESS_TOKEN"; // 示例
}

2.2 构建API请求

获取订单详情的API端点是:/v2/checkout/orders/{id}。您需要将{id}替换为实际的order_id。

以下是一个使用Java HttpClient发送GET请求获取订单详情的示例:

import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import com.fasterxml.jackson.databind.ObjectMapper; // 假设使用Jackson进行JSON解析
import com.fasterxml.jackson.annotation.JsonProperty;
import java.util.List;

public class PayPalService {

    private final HttpClient httpClient;
    private final ObjectMapper objectMapper;
    private static final String BASE_URL = "https://api-m.paypal.com"; // 或沙箱环境 "https://api-m.sandbox.paypal.com"
    private static final String ORDER_DETAILS_PATH = "/v2/checkout/orders/{id}";

    public PayPalService() {
        this.httpClient = HttpClient.newHttpClient();
        this.objectMapper = new ObjectMapper();
    }

    /**
     * 获取PayPal订单的详细信息。
     * @param orderId PayPal订单的唯一ID。
     * @return 包含订单详情的DTO对象。
     * @throws IOException 如果发生I/O错误。
     * @throws InterruptedException 如果线程在等待时被中断。
     */
    public PayPalOrderResponseDTO getOrderDetails(String orderId) throws IOException, InterruptedException {
        String accessToken = getAccessToken(); // 获取Access Token

        // 构建API请求URL
        String requestUrl = BASE_URL + ORDER_DETAILS_PATH.replace("{id}", orderId);

        // 创建HTTP请求
        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create(requestUrl))
                .header("Authorization", "Bearer " + accessToken)
                .GET()
                .build();

        // 发送请求并获取响应
        HttpResponse response = httpClient.send(request, HttpResponse.BodyHandlers.ofString());

        // 检查响应状态码
        if (response.statusCode() != 200) {
            System.err.println("Error fetching order details: " + response.body());
            throw new IOException("Failed to fetch order details. Status code: " + response.statusCode());
        }

        // 解析JSON响应到DTO对象
        return objectMapper.readValue(response.body(), PayPalOrderResponseDTO.class);
    }

    // 假设的getAccessToken方法,需要您根据实际认证流程实现
    private String getAccessToken() {
        // 在实际应用中,这里会调用PayPal的OAuth2 /v1/oauth2/token 端点获取
        // 为简化示例,此处返回一个占位符
        return "YOUR_PAYPAL_ACCESS_TOKEN";
    }

    // ... PayPalOrderResponseDTO 及相关嵌套DTO的定义将在下一节给出
}

2.3 处理API响应与提取Payer信息

PayPal订单详情API的响应是一个包含丰富数据的JSON对象。其中,付款人信息位于payer字段下。

Video Summarization
Video Summarization

一款可以自动将长视频制作成短片的桌面软件

下载

响应DTO结构示例 (Java Record 类型):

// PayPalOrderResponseDTO.java
public record PayPalOrderResponseDTO(
    @JsonProperty("create_time") String creationTime,
    @JsonProperty("update_time") String updateTime,
    String id,
    @JsonProperty("purchase_units") List payPalPurchaseUnits,
    List links,
    @JsonProperty("payment_source") PayPalPaymentSource paymentSource,
    PayPalOrderIntent intent,
    @JsonProperty("payer") PayPalPayer payPalPayer, // 付款人信息
    PayPalOrderStatus status
) {}

// PayPalPayer.java
public record PayPalPayer(
    @JsonProperty("email_address") String emailAddress,
    @JsonProperty("payer_id") String payerId, // 注意:这里会返回Payer ID
    PayPalName name,
    PayPalPhone phone,
    @JsonProperty("birth_date") String birthDate,
    PayPalAddress address
) {}

// PayPalName.java
public record PayPalName(
    @JsonProperty("given_name") String givenName,
    String surname
) {}

// 其他辅助DTO,根据实际需要定义
// PayPalPurchaseUnit.java
public record PayPalPurchaseUnit(
    String referenceId,
    @JsonProperty("shipping") PayPalShipping shipping,
    @JsonProperty("payments") PayPalPayments payments
) {}

// PayPalShipping.java
public record PayPalShipping(
    @JsonProperty("name") PayPalName name,
    @JsonProperty("address") PayPalAddress address
) {}

// PayPalAddress.java
public record PayPalAddress(
    @JsonProperty("address_line_1") String addressLine1,
    @JsonProperty("admin_area_2") String adminArea2,
    @JsonProperty("admin_area_1") String adminArea1,
    @JsonProperty("postal_code") String postalCode,
    @JsonProperty("country_code") String countryCode
) {}

// PayPalPayments.java (可能包含授权或捕获信息)
public record PayPalPayments(
    List authorizations,
    List captures
) {}

// PayPalAuthorization.java / PayPalCapture.java 等根据实际响应结构定义
// ... (为简洁起见,此处省略了所有嵌套DTO的完整定义,但实际应用中应完整映射)

通过上述PayPalOrderResponseDTO,您可以轻松访问payPalPayer字段,进而获取emailAddress、givenName、surname、payerId等付款人详细信息。

示例:提取付款人信息

public void processOrderDetails(String orderId) {
    try {
        PayPalOrderResponseDTO orderDetails = getOrderDetails(orderId);

        // 获取付款人信息
        PayPalPayer payer = orderDetails.payPalPayer();
        if (payer != null) {
            System.out.println("Payer Email: " + payer.emailAddress());
            if (payer.name() != null) {
                System.out.println("Payer Name: " + payer.name().givenName() + " " + payer.name().surname());
            }
            System.out.println("Payer ID (from order details): " + payer.payerId());
            // 更多付款人信息,如地址、电话等
        }

        // 获取其他交易详情
        System.out.println("Order ID: " + orderDetails.id());
        System.out.println("Order Status: " + orderDetails.status());
        // 遍历 purchase_units 获取商品或金额详情
        if (orderDetails.payPalPurchaseUnits() != null && !orderDetails.payPalPurchaseUnits().isEmpty()) {
            orderDetails.payPalPurchaseUnits().forEach(unit -> {
                // 处理每个购买单位的详情
            });
        }

    } catch (IOException | InterruptedException e) {
        System.err.println("Error processing order: " + e.getMessage());
        // 适当的错误处理
    }
}

3. 注意事项与最佳实践

  • 订单ID的来源: 确保您在支付发起阶段(例如,调用/v2/checkout/orders创建订单时)正确地捕获并存储了PayPal返回的order_id。这个order_id是后续查询订单详情的关键。
  • 安全管理Access Token: Access Token是敏感凭证,应妥善保管。避免将其硬编码在代码中,并确保在服务器端安全地获取和刷新。
  • 错误处理: 在实际应用中,务必对API请求的响应进行错误处理。检查HTTP状态码,并解析PayPal返回的错误信息,以便诊断和解决问题。
  • 幂等性: 如果您需要多次尝试获取订单详情,确保您的系统能够处理幂等性。虽然GET请求通常是幂等的,但在某些操作(如捕获支付)中,需要特别注意。
  • 沙箱环境测试: 在部署到生产环境之前,务必在PayPal的沙箱环境中充分测试您的集成。
  • 跨语言适用性: 尽管示例代码是Java,但这种通过订单ID调用PayPal订单详情API的逻辑适用于任何支持HTTP请求和JSON解析的编程语言(如Python, Node.js, PHP, C#等)。核心在于构建正确的URL、设置认证头和解析JSON响应。

总结

当PayPal仅返回PayerID而您需要完整的交易和付款人详情时,正确的做法是利用您在支付流程初期获得的order_id(或payment_id),调用PayPal的订单详情API(/v2/checkout/orders/{id})。通过此API,您可以获取一个包含所有必要信息的JSON响应,其中包括付款人的电子邮件地址、姓名等。遵循本文提供的指导和示例,您可以有效地集成PayPal API,并安全、准确地获取所需的交易数据。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

418

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

535

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

311

2023.10.13

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

77

2025.09.10

登录token无效
登录token无效

登录token无效解决方法:1、检查token的有效期限,如果token已经过期,需要重新获取一个新的token;2、检查token的签名,如果签名不正确,需要重新获取一个新的token;3、检查密钥的正确性,如果密钥不正确,需要重新获取一个新的token;4、使用HTTPS协议传输token,建议使用HTTPS协议进行传输 ;5、使用双因素认证,双因素认证可以提高账户的安全性。

6145

2023.09.14

登录token无效怎么办
登录token无效怎么办

登录token无效的解决办法有检查Token是否过期、检查Token是否正确、检查Token是否被篡改、检查Token是否与用户匹配、清除缓存或Cookie、检查网络连接和服务器状态、重新登录或请求新的Token、联系技术支持或开发人员等。本专题为大家提供token相关的文章、下载、课程内容,供大家免费下载体验。

816

2023.09.14

token怎么获取
token怎么获取

获取token值的方法:1、小程序调用“wx.login()”获取 临时登录凭证code,并回传到开发者服务器;2、开发者服务器以code换取,用户唯一标识openid和会话密钥“session_key”。想了解更详细的内容,可以阅读本专题下面的文章。

1065

2023.12.21

token什么意思
token什么意思

token是一种用于表示用户权限、记录交易信息、支付虚拟货币的数字货币。可以用来在特定的网络上进行交易,用来购买或出售特定的虚拟货币,也可以用来支付特定的服务费用。想了解更多token什么意思的相关内容可以访问本专题下面的文章。

1345

2024.03.01

Python 自然语言处理(NLP)基础与实战
Python 自然语言处理(NLP)基础与实战

本专题系统讲解 Python 在自然语言处理(NLP)领域的基础方法与实战应用,涵盖文本预处理(分词、去停用词)、词性标注、命名实体识别、关键词提取、情感分析,以及常用 NLP 库(NLTK、spaCy)的核心用法。通过真实文本案例,帮助学习者掌握 使用 Python 进行文本分析与语言数据处理的完整流程,适用于内容分析、舆情监测与智能文本应用场景。

22

2026.01.27

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
PHP课程
PHP课程

共137课时 | 9.8万人学习

JavaScript ES5基础线上课程教学
JavaScript ES5基础线上课程教学

共6课时 | 11.2万人学习

PHP新手语法线上课程教学
PHP新手语法线上课程教学

共13课时 | 0.9万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号