AliPay SDK for Golang

https://pkg.go.dev/github.com/smartwalle/alipay/v3
Admin
AliPay SDK for Golang is a Go library providing complete payment integration with Alibaba's AliPay...
Tokens:47,844
Snippets:301
Trust Score:9.6
Update:3 months ago
Show doc for...
Tokens:
Raw
### Install Alipay SDK with Go Modules

Source: https://pkg.go.dev/github.com/smartwalle/alipay/v3

Use this command to get the Alipay SDK if your project is using Go modules.

```bash
go get github.com/smartwalle/alipay/v3

```

--------------------------------

### Create Wap Payment Example

Source: https://pkg.go.dev/github.com/smartwalle/alipay/v3

A practical example demonstrating how to create a WAP payment using the Alipay SDK.

```APIDOC
## Create Wap Payment Example

A practical example demonstrating how to create a WAP payment using the Alipay SDK.
```go
var privateKey = "xxx" // 必须，上一步中使用 RSA签名验签工具 生成的私钥
var client, err = alipay.New(appId, privateKey, false)
if err != nil {
fmt.Println(err)
return
}

// 加载应用公钥证书
if err = client.LoadAppCertPublicKeyFromFile("appCertPublicKey_2017011104995404.crt"); err != nil {
// 错误处理
}

// 加载支付宝根证书
if err = client.LoadAliPayRootCertFromFile("alipayRootCert.crt"); err != nil {
// 错误处理
}

// 加载支付宝公钥证书
if err = client.LoadAlipayCertPublicKeyFromFile("alipayCertPublicKey_RSA2.crt"); err != nil {
// 错误处理
}

// 加载内容密钥，可选
if err = client.SetEncryptKey("FtVd5SgrsUzYQRAPBmejHQ=="); err != nil {
// 错误处理
}

var p = alipay.TradeWapPay{}
p.NotifyURL = "http://xxx"
p.ReturnURL = "http://xxx"
p.Subject = "标题"
p.OutTradeNo = "传递一个唯一单号"
p.TotalAmount = "10.00"
p.ProductCode = "QUICK_WAP_WAY"

var url, err = client.TradeWapPay(p)
if err != nil {
fmt.Println(err)
}

// 这个 payURL 即是用于打开支付宝支付页面的 URL，可将输出的内容复制，到浏览器中访问该 URL 即可打开支付页面。
var payURL = url.String()
fmt.Println(payURL)
```
```

--------------------------------

### Install Alipay SDK without Go Modules

Source: https://pkg.go.dev/github.com/smartwalle/alipay/v3

Use this command to get the Alipay SDK if your project is not using Go modules.

```bash
go get github.com/smartwalle/alipay

```

--------------------------------

### Import Alipay SDK in Go Project

Source: https://pkg.go.dev/github.com/smartwalle/alipay/v3

Import the Alipay SDK into your Go project after installation.

```go
import github.com/smartwalle/alipay/v3

```

--------------------------------

### UserCertifyOpenInitialize

Source: https://pkg.go.dev/github.com/smartwalle/alipay/v3

Initializes the user certification process. This sets up the necessary parameters for starting a certification flow.

```APIDOC
## UserCertifyOpenInitialize

### Description
Initializes the user certification process. This sets up the necessary parameters for starting a certification flow.

### Method
func (c *Client) UserCertifyOpenInitialize(ctx context.Context, param UserCertifyOpenInitialize) (result *UserCertifyOpenInitializeRsp, err error)

### Parameters
- **ctx** (context.Context) - The context for the request.
- **param** (UserCertifyOpenInitialize) - The parameters for initializing the certification.
```

--------------------------------

### Define ItemInstallmentInfoDTO Structure

Source: https://pkg.go.dev/github.com/smartwalle/alipay/v3

Defines the structure for item installment information, including the total number of installments and optional maximum or per-period prices.

```go
type ItemInstallmentInfoDTO struct {
	PeriodNum      int     `json:"period_num"`                 // 总分期数，必选
	PeriodMaxPrice *string `json:"period_max_price,omitempty"` // 每期最大金额，可选
	PeriodPrice    *string `json:"period_price,omitempty"`     // 每期金额，可选
}
```

--------------------------------

### UserCertifyOpenCertify

Source: https://pkg.go.dev/github.com/smartwalle/alipay/v3

Identity Authentication Start Authentication API. This method initiates the identity authentication process.

```APIDOC
## UserCertifyOpenCertify

### Description
Identity Authentication Start Authentication API. This method initiates the identity authentication process.

### Method
POST (Assumed, based on typical API patterns for authentication initiation)

### Endpoint
/v3/alipay/user/certify/open/certify

### Parameters
#### Request Body
- **param** (UserCertifyOpenCertify) - Required - Identity authentication parameters.

### Response
#### Success Response (200)
- **result** (*url.URL) - The URL object to redirect for authentication.
- **err** (error) - An error object if the operation failed.
```

--------------------------------

### UserCertifyOpenCertify

Source: https://pkg.go.dev/github.com/smartwalle/alipay/v3

Starts the identity authentication process. It requires a `certify_id` which is generated after initializing the open authentication interface.

```APIDOC
## UserCertifyOpenCertify

### Description
This structure is used to start the identity authentication process. It requires a `certify_id` that is generated after calling the open authentication initialization interface.

### Fields
- **AppAuthToken** (string) - Optional. Used for user authorization.
- **CertifyId** (string) - Required. The unique identifier for this authentication operation, generated by the open authentication initialization interface.
```

--------------------------------

### Get AccountAuth Parameters

Source: https://pkg.go.dev/github.com/smartwalle/alipay/v3

Returns the parameters for the AccountAuth type.

```go
func (account AccountAuth) Params() map[string]string

```

--------------------------------

### Get AgreementExecutionPlanModify Parameters

Source: https://pkg.go.dev/github.com/smartwalle/alipay/v3

Returns the parameters for the AgreementExecutionPlanModify type.

```go
func (ag AgreementExecutionPlanModify) Params() map[string]string

```

--------------------------------

### FaceCertifyInitialize

Source: https://pkg.go.dev/github.com/smartwalle/alipay/v3

Initializes a face certification process. This API starts the real-name verification using facial recognition.

```APIDOC
## FaceCertifyInitialize

### Description
Initializes a face certification process. This API starts the real-name verification using facial recognition.

### Method
```go
func (c *Client) FaceCertifyInitialize(ctx context.Context, param FaceCertifyInitialize) (result *FaceCertifyInitializeRsp, err error)
```

### Parameters
- **ctx** (context.Context) - Required - The context for the request.
- **param** (FaceCertifyInitialize) - Required - The parameters for initializing face certification.
```

--------------------------------

### FaceVerificationInitialize

Source: https://pkg.go.dev/github.com/smartwalle/alipay/v3

Initializes a face verification process. This API starts a verification flow using facial recognition.

```APIDOC
## FaceVerificationInitialize

### Description
Initializes a face verification process. This API starts a verification flow using facial recognition.

### Method
```go
func (c *Client) FaceVerificationInitialize(ctx context.Context, param FaceVerificationInitialize) (result *VerificationInitializeRsp, err error)
```

### Parameters
- **ctx** (context.Context) - Required - The context for the request.
- **param** (FaceVerificationInitialize) - Required - The parameters for initializing face verification.
```

--------------------------------

### Define MiniGoodsDetailInfoDTO Structure

Source: https://pkg.go.dev/github.com/smartwalle/alipay/v3

Defines the structure for mini program goods detail information, including name, quantity, price, IDs, discounts, and optional installment, rent, date, ticket, and activity information.

```go
type MiniGoodsDetailInfoDTO struct {
	GoodsName           string                  `json:"goods_name"`                // 商品名称，必选
	ItemCnt             string                  `json:"item_cnt"`                  // 商品数量，必选
	SalePrice           string                  `json:"sale_price"`                // 商品单价，必选
	GoodsID             string                  `json:"goods_id"`                  // 商品的编号，必选
	OutItemID           string                  `json:"out_item_id"`               // 商户商品ID，条件必选
	OutSkuID            string                  `json:"out_sku_id"`                // 商户商品sku_id，条件必选
	SaleRealPrice       string                  `json:"sale_real_price"`           // 商品实际单价，条件必选
	ItemDiscount        string                  `json:"item_discount"`             // 商家商品优惠金额，条件必选
	ImageMaterialID     string                  `json:"image_material_id"`         // 商家商品素材ID，条件必选
	ItemInstallmentInfo *ItemInstallmentInfoDTO `json:"item_installment_info"`     // 商品分期信息，条件必选
	RentInfo            *RentInfoDTO            `json:"rent_info,omitempty"`       // 租金信息，租赁商品特有,可选
	EffectiveDates      *EffectiveDatesDTO      `json:"effective_dates,omitempty"` // 价格日历,可选
	TicketInfo          *TicketInfoDTO          `json:"ticket_info,omitempty"`     // 演出票务信息,可选
	ActivityInfo        *ActivityInfoDTO        `json:"activity_info,omitempty"`   // 活动信息,可选
}
```

--------------------------------

### Initialize SDK with Past Sandbox Gateway

Source: https://pkg.go.dev/github.com/smartwalle/alipay/v3

Specify the old sandbox gateway URL during SDK initialization if needed. Otherwise, the SDK defaults to the new sandbox gateway.

```go
alipay.New(appId, privateKey, false, alipay.WithPastSandboxGateway())
```

--------------------------------

### Initialize Alipay Client

Source: https://pkg.go.dev/github.com/smartwalle/alipay/v3

Initialize the Alipay client with your App ID, private key, and production environment flag. Ensure the private key is correctly handled.

```go
var client, err = alipay.New(appID, privateKey, isProduction)

```

--------------------------------

### Alipay Client Initialization with HTTP Client

Source: https://pkg.go.dev/github.com/smartwalle/alipay/v3

Shows how to initialize the Alipay client with a custom HTTP client, including trace functionality using OpenTelemetry.

```APIDOC
## Initialize Alipay Client

### Description
Initializes the Alipay client with a custom HTTP client that includes OpenTelemetry for tracing.

### Code Example
```go
// HTTP client
httpClient := &http.Client{
    Timeout: 30 * time.Second,
    Transport: otelhttp.NewTransport(
        http.DefaultTransport,
        otelhttp.WithSpanNameFormatter(func(operation string, r *http.Request) string {
            return r.Method + " " + r.URL.Path
        }),
    ),
}

// Initialize Alipay client
client, err := alipay.New(appId, privateKey, false, alipay.WithHTTPClient(httpClient))
if err != nil {
    fmt.Println(err)
}
```
```

--------------------------------

### New Client Initialization

Source: https://pkg.go.dev/github.com/smartwalle/alipay/v3

Initializes the Alipay client with application ID, private key, and production environment flag. Optional configuration functions can be provided.

```APIDOC
## New

### Description
Initializes the Alipay client.

### Parameters
- **appId** (string) - Required - The Alipay application ID.
- **privateKey** (string) - Required - The application's private key.
- **production** (bool) - Required - Set to `true` for production environment, `false` for sandbox.
- **opts** ([]OptionFunc) - Optional - Configuration functions.
```

--------------------------------

### Get AgreementExecutionPlanModify API Name

Source: https://pkg.go.dev/github.com/smartwalle/alipay/v3

Returns the API name for the AgreementExecutionPlanModify type.

```go
func (ag AgreementExecutionPlanModify) APIName() string

```

--------------------------------

### Get AccountAuth API Name

Source: https://pkg.go.dev/github.com/smartwalle/alipay/v3

Returns the API name for the AccountAuth type.

```go
func (account AccountAuth) APIName() string

```

--------------------------------

### Alipay SDK Integration - Sandbox Environment

Source: https://pkg.go.dev/github.com/smartwalle/alipay/v3

Guidance on setting up and using the Alipay SDK with the sandbox environment, including gateway addresses.

```APIDOC
## Alipay SDK Integration - Sandbox Environment

Guidance on setting up and using the Alipay SDK with the sandbox environment, including gateway addresses.

### 沙箱环境网关地址
沙箱环境目前有两个网关地址：
  * 老地址: https://openapi.alipay.com/gateway.do
  * 新地址: https://openapi-sandbox.dl.alipaydev.com/gateway.do

本 SDK 目前默认使用的是 **【新地址】** ，如果需要使用老地址，只需要在初始化的时候通过 `alipay.WithPastSandboxGateway()` 指定即可。
```go
alipay.New(appId, privateKey, isProduction, alipay.WithPastSandboxGateway())
```
```

--------------------------------

### Configure HTTP Client for Tracing

Source: https://pkg.go.dev/github.com/smartwalle/alipay/v3

Shows how to initialize an Alipay client with a custom HTTP client that includes OpenTelemetry for distributed tracing. The span name formatter is customized to include the HTTP method and URL path.

```go
// HTTP客户端
httpClient := &http.Client{
    Timeout: 30 * time.Second,
    Transport: otelhttp.NewTransport(
        http.DefaultTransport,
        otelhttp.WithSpanNameFormatter(func(operation string, r *http.Request) string {
            return r.Method + " " + r.URL.Path
        }),
    ),
}

// 初始化支付宝客户端
client, err := alipay.New(appId, privateKey, false, alipay.WithHTTPClient(httpClient))
if err != nil {
    fmt.Println(err)
}
```

--------------------------------

### Client Initialization

Source: https://pkg.go.dev/github.com/smartwalle/alipay/v3

Initializes a new Alipay client with application ID, private key, and production mode. Optional configuration functions can be provided.

```APIDOC
## Client Initialization

### Description
Initializes a new Alipay client with application ID, private key, and production mode. Optional configuration functions can be provided.

### Function Signature
```go
func New(appId, privateKey string, production bool, opts ...OptionFunc) (client *Client, err error)
```

### Parameters
- **appId** (string) - Required - The application ID for Alipay.
- **privateKey** (string) - Required - The private key for authentication.
- **production** (bool) - Required - Specifies if the client is for production environment.
- **opts** (...OptionFunc) - Optional - Additional configuration options.

### Returns
- **client** (*Client) - The initialized Alipay client.
- **err** (error) - An error if initialization fails.
```

--------------------------------

### OpenMiniOrderCreate

Source: https://pkg.go.dev/github.com/smartwalle/alipay/v3

Create an order for a mini-program. Implements APIName and Params methods.

```APIDOC
## OpenMiniOrderCreate

### Description
Provides methods to get the API name and parameters for creating a mini-program order.

### Methods
- `APIName() string`: Returns the API name for creating a mini-program order.
- `Params() map[string]string`: Returns the parameters for creating a mini-program order.
```

--------------------------------

### Initialize Alipay Client

Source: https://pkg.go.dev/github.com/smartwalle/alipay/v3

Initializes the Alipay client with your application ID, private key, and production environment flag. The private key is crucial for signing requests.

```APIDOC
## Initialize Alipay Client

### Description
Initializes the Alipay client with your application ID, private key, and production environment flag. The private key is crucial for signing requests.

### Method
`alipay.New(appID, privateKey, isProduction)`

### Parameters
- **appID** (string) - Your Alipay application ID.
- **privateKey** (string) - Your application's private key used for signing.
- **isProduction** (bool) - Set to `true` for the production environment, `false` for the sandbox environment.

### Request Example
```go
var client, err = alipay.New("YOUR_APP_ID", "YOUR_PRIVATE_KEY", true)
```
```

--------------------------------

### SignValues

Source: https://pkg.go.dev/github.com/smartwalle/alipay/v3

Signs URL values using the configured signing method. This is commonly used for signing parameters in GET requests or form data.

```APIDOC
## SignValues

### Description
Signs URL values using the configured signing method. This is commonly used for signing parameters in GET requests or form data.

### Method Signature
```go
func (c *Client) SignValues(values url.Values, opts ...nsign.SignOption) ([]byte, error)
```

### Added in version
v3.2.26
```

--------------------------------

### LoadAliPayRootCertFromFile

Source: https://pkg.go.dev/github.com/smartwalle/alipay/v3

Loads the Alipay root certificate from a file.

```APIDOC
## LoadAliPayRootCertFromFile

### Description
Loads the Alipay root certificate from a file.

### Method
(Not specified in source)

### Endpoint
(Not specified in source)

### Parameters
#### Path Parameters
(None specified)

#### Query Parameters
(None specified)

#### Request Body
- **filename** (string) - Required - The path to the root certificate file.

### Request Example
(Not specified in source)

### Response
#### Success Response (200)
- **error** (error) - Returns an error if the loading fails.

#### Response Example
(Not specified in source)
```

--------------------------------

### LoadAliPayRootCertFromFile

Source: https://pkg.go.dev/github.com/smartwalle/alipay/v3

Loads the Alipay root certificate from a file.

```APIDOC
## LoadAliPayRootCertFromFile

### Description
Loads the Alipay root certificate from a file.

### Method
POST

### Endpoint
/v3/alipay/root/cert/load/file

### Parameters
#### Request Body
- **filename** (string) - Required - The path to the certificate file.
```

--------------------------------

### Client Initialization with Signer

Source: https://pkg.go.dev/github.com/smartwalle/alipay/v3

Initializes a new Alipay client using a provided signer, application ID, and production mode. Optional configuration functions can be provided.

```APIDOC
## Client Initialization with Signer

### Description
Initializes a new Alipay client using a provided signer, application ID, and production mode. Optional configuration functions can be provided.

### Function Signature
```go
func NewWithSigner(appId string, signer nsign.Signer, production bool, opts ...OptionFunc) (client *Client, err error)
```

### Parameters
- **appId** (string) - Required - The application ID for Alipay.
- **signer** (nsign.Signer) - Required - The signer object for authentication.
- **production** (bool) - Required - Specifies if the client is for production environment.
- **opts** (...OptionFunc) - Optional - Additional configuration options.

### Returns
- **client** (*Client) - The initialized Alipay client.
- **err** (error) - An error if initialization fails.
```

--------------------------------

### UserCertifyOpenInitialize

Source: https://pkg.go.dev/github.com/smartwalle/alipay/v3

Initializes the user certification process for open platforms. This is a crucial step for verifying user identities through various methods supported by Alipay.

```APIDOC
## POST /alipay.user.certify.open.initialize

### Description
Initializes the user certification process, allowing users to undergo identity verification via Alipay's open platform. This endpoint is used to start a certification flow that can involve face recognition, document verification, or a combination of both.

### Method
POST

### Endpoint
/alipay.user.certify.open.initialize

### Parameters
#### Request Body
- **outer_order_no** (string) - Required - A unique identifier for the merchant's request, 32 characters long, alphanumeric. Recommended format: prefix + timestamp + sequence.
- **biz_code** (CertifyBizCode) - Required - The certification scene code. Supported values depend on the merchant's agreement with Alipay. Examples: FACE, CERT_PHOTO, CERT_PHOTO_FACE, SMART_FACE.
- **identity_param** (IdentityParam) - Required - Parameters related to user identity verification.
- **merchant_config** (MerchantConfig) - Required - Merchant-specific configuration, including the return URL.
- **face_contrast_picture** (string) - Optional - Base64 encoded string of a custom image for face comparison.
```

--------------------------------

### FaceCertifyInitialize

Source: https://pkg.go.dev/github.com/smartwalle/alipay/v3

Initializes the face certification process with necessary parameters.

```APIDOC
## FaceCertifyInitialize

### Description
This structure is used to initialize the face certification process. It includes merchant-specific configurations and identity parameters for verification.

### Fields
- **AppAuthToken** (string) - Optional: Merchant's authorization token.
- **OuterOrderNo** (string) - Required: Unique identifier for the merchant's request (32 characters, alphanumeric).
- **BizCode** (CertifyBizCode) - Required: The scene code for H5 face recognition.
- **IdentityParam** (IdentityParam) - Required: Identity information to be verified.
- **MerchantConfig** (MerchantConfig) - Required: Merchant's custom configuration information.
```

--------------------------------

### UserCertifyOpenInitialize

Source: https://pkg.go.dev/github.com/smartwalle/alipay/v3

Identity Authentication Initialization Service API. This method initializes the identity authentication service.

```APIDOC
## UserCertifyOpenInitialize

### Description
Identity Authentication Initialization Service API. This method initializes the identity authentication service.

### Method
POST (Assumed, based on typical API patterns for initialization)

### Endpoint
/v3/alipay/user/certify/open/initialize

### Parameters
#### Request Body
- **param** (UserCertifyOpenInitialize) - Required - Identity authentication initialization parameters.

### Response
#### Success Response (200)
- **result** (*UserCertifyOpenInitializeRsp) - The response object containing initialization details.
- **err** (error) - An error object if the operation failed.
```

--------------------------------

### WithSandboxGateway

Source: https://pkg.go.dev/github.com/smartwalle/alipay/v3

Configure the client to use the sandbox gateway.

```APIDOC
## WithSandboxGateway

### Description
Configure the client to use the sandbox gateway.

### Parameters
- **gateway** (string) - The sandbox gateway URL.
```

--------------------------------

### WithProductionGateway

Source: https://pkg.go.dev/github.com/smartwalle/alipay/v3

Configure the client to use the production gateway.

```APIDOC
## WithProductionGateway

### Description
Configure the client to use the production gateway.

### Parameters
- **gateway** (string) - The production gateway URL.
```

--------------------------------

### OpenMiniOrderCreate

Source: https://pkg.go.dev/github.com/smartwalle/alipay/v3

Create an order using the Mini Program transaction component.

```APIDOC
## OpenMiniOrderCreate

### Description
Create an order using the Mini Program transaction component.

### Endpoint
https://opendocs.alipay.com/mini/54f80876_alipay.open.mini.order.create

### Parameters
#### Path Parameters
- **app_auth_token** (string) - Optional - Application authorization token

#### Request Body
- **out_order_id** (string) - Required - Merchant order ID
- **title** (string) - Required - Order title
- **source_id** (string) - Required - Tracking ID
- **merchant_biz_type** (string) - Required - Order type
- **path** (string) - Required - Path to the order details page for the merchant's mini program
- **order_detail** (MiniOrderDetailDTO) - Required - Order information
- **seller_id** (string) - Required - Seller ID for the merchant's mini program
- **buyer_id** (string) - Optional - User ID
- **buyer_longin_id** (string) - Optional - User login ID
- **timeout_express** (string) - Optional - Order expiration time
- **promo_detail_info** (PromoDetailInfoDTO) - Optional - Marketing information
- **delivery_detail** (LogisticsInfoDTO) - Optional - Logistics information
- **default_receiving_address** (MiniReceiverAddressInfoDTO) - Optional - Default return address
```

--------------------------------

### Import Alipay SDK without Go Modules

Source: https://pkg.go.dev/github.com/smartwalle/alipay/v3

Import the Alipay SDK into your Go project if not using Go modules.

```go
import github.com/smartwalle/alipay

```

--------------------------------

### OptionFunc

Source: https://pkg.go.dev/github.com/smartwalle/alipay/v3

Configuration options for the SDK client. Includes functions for setting HTTP client, gateway, and time location.

```APIDOC
## OptionFunc

### Description
Represents functions that configure the Alipay SDK client.

### Functions
- `WithHTTPClient(client *http.Client) OptionFunc`: Sets a custom HTTP client.
- `WithNewSandboxGateway() OptionFunc`: Configures the client to use a new sandbox gateway.
- `WithPastSandboxGateway() OptionFunc`: Configures the client to use a past sandbox gateway.
- `WithProductionGateway(gateway string) OptionFunc`: Sets the production gateway URL.
- `WithSandboxGateway(gateway string) OptionFunc`: Sets the sandbox gateway URL.
- `WithTimeLocation(location *time.Location) OptionFunc`: Sets the time location for the client.
- `WithVerifier(aliCertSN string, verifier Verifier) OptionFunc`: Sets a verifier for security.
```

--------------------------------

### LoadAliPayRootCert

Source: https://pkg.go.dev/github.com/smartwalle/alipay/v3

Loads the Alipay root certificate.

```APIDOC
## LoadAliPayRootCert

### Description
Loads the Alipay root certificate.

### Method
(Not specified in source)

### Endpoint
(Not specified in source)

### Parameters
#### Path Parameters
(None specified)

#### Query Parameters
(None specified)

#### Request Body
- **s** (string) - Required - The root certificate content.

### Request Example
(Not specified in source)

### Response
#### Success Response (200)
- **error** (error) - Returns an error if the loading fails.

#### Response Example
(Not specified in source)
```

--------------------------------

### LoadAliPayRootCert

Source: https://pkg.go.dev/github.com/smartwalle/alipay/v3

Loads the Alipay root certificate.

```APIDOC
## LoadAliPayRootCert

### Description
Loads the Alipay root certificate.

### Method
POST

### Endpoint
/v3/alipay/root/cert/load

### Parameters
#### Request Body
- **s** (string) - Required - The certificate content.
```

--------------------------------

### FaceCertifyInitialize.APIName

Source: https://pkg.go.dev/github.com/smartwalle/alipay/v3

Returns the API name for FaceCertifyInitialize.

```APIDOC
## FaceCertifyInitialize.APIName

### Description
Returns the API name associated with the `FaceCertifyInitialize` structure.

### Method
`APIName()`

### Returns
- `string`: The name of the API.
```

--------------------------------

### WithHTTPClient

Source: https://pkg.go.dev/github.com/smartwalle/alipay/v3

Configure the client with a custom HTTP client.

```APIDOC
## WithHTTPClient

### Description
Configure the client with a custom HTTP client.

### Parameters
- **client** (*http.Client) - The custom HTTP client to use.
```

--------------------------------

### OpenMiniOrderCreate

Source: https://pkg.go.dev/github.com/smartwalle/alipay/v3

Creates a mini order for Open platform.

```APIDOC
## OpenMiniOrderCreate

### Description
Creates a mini order for Open platform.

### Method
(Implied POST or GET based on typical SDK usage, specific HTTP method not provided in source)

### Endpoint
(Not specified in source)

### Parameters
#### Path Parameters
(None specified)

#### Query Parameters
(None specified)

#### Request Body
- **param** (OpenMiniOrderCreate) - Required - The parameters for creating the mini order.

### Request Example
(Not specified in source)

### Response
#### Success Response (200)
- **result** (*OpenMiniOrderCreateResponse) - The response object containing the mini order details.

#### Response Example
(Not specified in source)
```

--------------------------------

### Alipay SDK Integration - Application Information Configuration

Source: https://pkg.go.dev/github.com/smartwalle/alipay/v3

Instructions on configuring application information, including key generation and signature methods.

```APIDOC
## Alipay SDK Integration - Application Information Configuration

Instructions on configuring application information, including key generation and signature methods.

本 SDK 中的签名方法默认为 **RSA2** ，采用支付宝提供的 RSA签名&验签工具 生成秘钥时，秘钥长度推荐 **2048** 。所以在支付宝管理后台请注意配置 **RSA2(SHA256)密钥** 。
生成秘钥对之后，将公钥提供给支付宝（通过支付宝后台上传）对我们请求的数据进行签名验证，我们的代码中将使用私钥对请求数据签名。
请参考 如何生成 RSA 密钥。
```

--------------------------------

### New Client Initialization with Custom Signer

Source: https://pkg.go.dev/github.com/smartwalle/alipay/v3

Creates an Alipay client using a custom signer, suitable for scenarios where the private key is managed by a third party.

```APIDOC
## NewWithSigner

### Description
Creates an Alipay client using a custom signer. This is useful when the private key is managed by a third party.

### Parameters
- **appId** (string) - Required - The Alipay application ID.
- **signer** (nsign.Signer) - Required - The custom signer, cannot be empty.
- **production** (bool) - Required - Set to `true` for production environment, `false` for sandbox.
- **opts** ([]OptionFunc) - Optional - Configuration functions.
```

--------------------------------

### WithNewSandboxGateway

Source: https://pkg.go.dev/github.com/smartwalle/alipay/v3

Configure the client to use the new sandbox gateway.

```APIDOC
## WithNewSandboxGateway

### Description
Configure the client to use the new sandbox gateway.
```

--------------------------------

### LoadAppCertPublicKeyFromFile

Source: https://pkg.go.dev/github.com/smartwalle/alipay/v3

从文件加载应用公钥证书. Loads the application certificate public key from a file.

```APIDOC
## LoadAppCertPublicKeyFromFile

### Description
Loads the application certificate public key from a file.

### Method
POST

### Endpoint
/v3/alipay/app/cert/public/key/load/file

### Parameters
#### Request Body
- **filename** (string) - Required - The path to the certificate file.
```

--------------------------------

### LoadAppCertPublicKeyFromFile

Source: https://pkg.go.dev/github.com/smartwalle/alipay/v3

Loads the app certificate public key from a file.

```APIDOC
## LoadAppCertPublicKeyFromFile

### Description
Loads the app certificate public key from a file.

### Method
(Not specified in source)

### Endpoint
(Not specified in source)

### Parameters
#### Path Parameters
(None specified)

#### Query Parameters
(None specified)

#### Request Body
- **filename** (string) - Required - The path to the app certificate public key file.

### Request Example
(Not specified in source)

### Response
#### Success Response (200)
- **error** (error) - Returns an error if the loading fails.

#### Response Example
(Not specified in source)
```

--------------------------------

### FaceCertifyInitialize.Params

Source: https://pkg.go.dev/github.com/smartwalle/alipay/v3

Retrieves the parameters for FaceCertifyInitialize.

```APIDOC
## FaceCertifyInitialize.Params

### Description
Retrieves the parameters required for the `FaceCertifyInitialize` operation.

### Method
`Params()`

### Returns
- `map[string]string`: A map containing the API parameters.
```

--------------------------------

### Client.FaceCertifyInitialize

Source: https://pkg.go.dev/github.com/smartwalle/alipay/v3

Initializes Web Face Recognition. Added in v3.2.21.

```APIDOC
## Client.FaceCertifyInitialize

### Description
Initializes Web Face Recognition.

### Method
func (c *Client) FaceCertifyInitialize(ctx context.Context, param FaceCertifyInitialize) (result *FaceCertifyInitializeRsp, err error)

### Parameters
- **ctx** (context.Context) - Description not available
- **param** (FaceCertifyInitialize) - Description not available
```

--------------------------------

### Define ShopInfoDTO Struct

Source: https://pkg.go.dev/github.com/smartwalle/alipay/v3

Defines the structure for shop information. Includes name, address, and optional merchant or Alipay shop IDs.

```go
type ShopInfoDTO struct {
	Name           string `json:"name"`                       // 门店名称，必选
	Address        string `json:"address"`                    // 门店地址，必选
	MerchantShopID string `json:"merchant_shop_id,omitempty"` // 商家侧门店id，可选
	AlipayShopID   string `json:"alipay_shop_id,omitempty"`   // 蚂蚁侧门店id，可选
}
```

--------------------------------

### LoadAppPublicCertFromFile

Source: https://pkg.go.dev/github.com/smartwalle/alipay/v3

Deprecated: use LoadAppCertPublicKeyFromFile instead. Loads the application public certificate from a file.

```APIDOC
## LoadAppPublicCertFromFile

### Description
Loads the application public certificate from a file. Deprecated: use LoadAppCertPublicKeyFromFile instead.

### Method
POST

### Endpoint
/v3/alipay/app/public/cert/load/file

### Parameters
#### Request Body
- **filename** (string) - Required - The path to the certificate file.
```

--------------------------------

### Client.FaceVerificationInitialize

Source: https://pkg.go.dev/github.com/smartwalle/alipay/v3

Initializes Face Recognition. Added in v3.2.23.

```APIDOC
## Client.FaceVerificationInitialize

### Description
Initializes Face Recognition.

### Method
func (c *Client) FaceVerificationInitialize(ctx context.Context, param FaceVerificationInitialize) (result *VerificationInitializeRsp, err error)

### Parameters
- **ctx** (context.Context) - Description not available
- **param** (FaceVerificationInitialize) - Description not available
```

--------------------------------

### WithPastSandboxGateway

Source: https://pkg.go.dev/github.com/smartwalle/alipay/v3

Configure the client to use the past sandbox gateway.

```APIDOC
## WithPastSandboxGateway

### Description
Configure the client to use the past sandbox gateway.
```

--------------------------------

### OpenMiniOrderCreate Struct Definition

Source: https://pkg.go.dev/github.com/smartwalle/alipay/v3

Defines the structure for creating a mini program order. Requires OutOrderID, Title, SourceID, MerchantBizType, Path, OrderDetail, and SellerID.

```go
type OpenMiniOrderCreate struct {
	AuxParam
	AppAuthToken            string                      `json:"-"`                                   // 可选
	OutOrderID              string                      `json:"out_order_id"`                        // 商户订单号，必选
	Title                   string                      `json:"title"`                               // 订单标题，必选
	SourceID                string                      `json:"source_id"`                           // 追踪ID，必选
	MerchantBizType         string                      `json:"merchant_biz_type"`                   // 订单类型，必选
	Path                    string                      `json:"path"`                                // 商家小程序对应的订单详情页路径地址，必选
	OrderDetail             MiniOrderDetailDTO          `json:"order_detail"`                        // 订单信息，必选
	SellerID                string                      `json:"seller_id"`                           // 商家小程序对应的卖家ID，必选
	BuyerID                 string                      `json:"buyer_id"`                            // 用户ID，
	BuyerLonginID           string                      `json:"buyer_longin_id"`                     // 用户登录ID，可选
	TimeoutExpress          string                      `json:"timeout_express"`                     // 订单过期时间，可选
	PromoDetailInfo         *PromoDetailInfoDTO         `json:"promo_detail_info"`                   // 营销信息，可选
	DeliveryDetail          *LogisticsInfoDTO           `json:"delivery_detail"`                     // 物流信息，可选
	DefaultReceivingAddress *MiniReceiverAddressInfoDTO `json:"default_receiving_address,omitempty"` // 默认退货地址，可选
}
```

--------------------------------

### LoadAlipayCertPublicKeyFromFile

Source: https://pkg.go.dev/github.com/smartwalle/alipay/v3

Loads the Alipay certificate public key from a file.

```APIDOC
## LoadAlipayCertPublicKeyFromFile

### Description
Loads the Alipay certificate public key from a file.

### Method
(Not specified in source)

### Endpoint
(Not specified in source)

### Parameters
#### Path Parameters
(None specified)

#### Query Parameters
(None specified)

#### Request Body
- **filename** (string) - Required - The path to the certificate public key file.

### Request Example
(Not specified in source)

### Response
#### Success Response (200)
- **error** (error) - Returns an error if the loading fails.

#### Response Example
(Not specified in source)
```

--------------------------------

### LoadAppCertPublicKey

Source: https://pkg.go.dev/github.com/smartwalle/alipay/v3

加载应用公钥证书. Loads the application certificate public key.

```APIDOC
## LoadAppCertPublicKey

### Description
Loads the application certificate public key.

### Method
POST

### Endpoint
/v3/alipay/app/cert/public/key/load

### Parameters
#### Request Body
- **s** (string) - Required - The certificate content.
```

--------------------------------

### LoadAppCertPublicKey

Source: https://pkg.go.dev/github.com/smartwalle/alipay/v3

Loads the app certificate public key.

```APIDOC
## LoadAppCertPublicKey

### Description
Loads the app certificate public key.

### Method
(Not specified in source)

### Endpoint
(Not specified in source)

### Parameters
#### Path Parameters
(None specified)

#### Query Parameters
(None specified)

#### Request Body
- **s** (string) - Required - The app certificate public key content.

### Request Example
(Not specified in source)

### Response
#### Success Response (200)
- **error** (error) - Returns an error if the loading fails.

#### Response Example
(Not specified in source)
```

--------------------------------

### Client.CertDownload

Source: https://pkg.go.dev/github.com/smartwalle/alipay/v3

Downloads certificates for Alipay integration.

```APIDOC
## Client.CertDownload

### Description
Downloads certificates for Alipay integration.

### Method
func (c *Client) CertDownload(ctx context.Context, param CertDownload) (result *CertDownloadRsp, err error)

### Parameters
- **ctx** (context.Context) - Description not available
- **param** (CertDownload) - Description not available
```

--------------------------------

### Alipay File Upload

Source: https://pkg.go.dev/github.com/smartwalle/alipay/v3

Demonstrates how to use the `alipay.open.file.upload` interface for file uploads. This feature is specific to mini-programs and requires 'Search Direct Access' to be enabled.

```APIDOC
## POST alipay.open.file.upload

### Description
Uploads files using the Alipay file upload interface. This is a mini-program specific feature.

### Method
POST

### Endpoint
alipay.open.file.upload

### Parameters
#### Request Body
- **biz_code** (string) - Required - Business code, e.g., "content_creation".
- **file_content** (file) - Required - The file content to upload. Can be provided as a file path or an io.Reader.

### Request Example
```go
var p = alipay.NewPayload("alipay.open.file.upload")
p.Encrypt = false // File uploads do not support interface content encryption

// Set parameters
p.AddParam("biz_code", "content_creation")

// Add file
p.AddFile("file_content", "a.jpg", "path/a.jpg")
// Or
// p.AddObject("file_content", "a.jpg", io.Reader)

var result map[string]interface{}
var err = client.Request(p, &result)
```

### Response
#### Success Response (200)
- **response** (map[string]interface{}) - The result of the file upload operation.
```

--------------------------------

### Load Public Key Certificates for Signature Verification

Source: https://pkg.go.dev/github.com/smartwalle/alipay/v3

Load application public key, Alipay root, and Alipay public key certificates when using the public key certificate mode for signature verification. Ensure correct file paths are provided.

```go
client.LoadAppCertPublicKeyFromFile("/路径/appCertPublicKey_2017011104995404.crt") // 加载应用公钥证书
client.LoadAliPayRootCertFromFile("/路径/alipayRootCert.crt")                // 加载支付宝根证书
client.LoadAlipayCertPublicKeyFromFile("/路径/alipayCertPublicKey_RSA2.crt") // 加载支付宝公钥证书

```

--------------------------------

### FaceCertifyInitializeRsp

Source: https://pkg.go.dev/github.com/smartwalle/alipay/v3

Response structure for initializing face certification.

```APIDOC
## FaceCertifyInitializeRsp

### Description
Response structure for initializing face certification, containing the unique identifier for the operation.

### Fields
- **certify_id** (string) - Required - The unique identifier for this application operation, which merchants need to record for subsequent operations.
```

--------------------------------

### LoadAliPayPublicCertFromFile

Source: https://pkg.go.dev/github.com/smartwalle/alipay/v3

Deprecated: use LoadAlipayCertPublicKeyFromFile instead. Loads the Alipay public certificate from a file.

```APIDOC
## LoadAliPayPublicCertFromFile

### Description
Loads the Alipay public certificate from a file. Deprecated: use LoadAlipayCertPublicKeyFromFile instead.

### Method
POST

### Endpoint
/v3/alipay/public/cert/load/file

### Parameters
#### Request Body
- **filename** (string) - Required - The path to the certificate file.
```

--------------------------------

### Custom Request Handling

Source: https://pkg.go.dev/github.com/smartwalle/alipay/v3

Instructions on how to make custom requests for unimplemented interfaces using `alipay.Payload`.

```APIDOC
## Custom Request Handling

Instructions on how to make custom requests for unimplemented interfaces using `alipay.Payload`.

对于本库还未实现接口，可使用 `alipay.Payload` 结构体作为参数调用 `alipay.Client` 结构体的 `Request()` 方法。
```go
var p = alipay.NewPayload("这里是接口名称，如：alipay.trade.query")
// 添加公共请求参数，如：app_auth_token
p.AddParam("key", "value")
// 添加请求参数(业务相关)
p.AddBizField("key", "value")

// 应用场景一：需要向支付宝服务器发起网络请求，如交易查询接口（alipay.trade.query）
var result map[string]interface{}
// result 也可以为结构体，可参照 alipay.TradeQueryRsp
var err = client.Request(p, &result)
if err != nil {
...
}

// 应用场景二：只需要生成 URL，如网页支付（alipay.trade.page.pay）
var url, err = clietn.BuildURL(p)
...

// 应用场景三：只需要对参数进行签名，如 App 支付（alipay.trade.app.pay）
var s, err = client.EncodeParam(p)
...
```
```

--------------------------------

### OpenMiniOrderCreate

Source: https://pkg.go.dev/github.com/smartwalle/alipay/v3

小程序交易组件业务单创建. Creates a business order for the mini program transaction component.

```APIDOC
## OpenMiniOrderCreate

### Description
Creates a business order for the mini program transaction component.

### Method
POST

### Endpoint
/v3/alipay/open/mini/order/create

### Parameters
#### Request Body
- **param** (OpenMiniOrderCreate) - Required - The parameters for creating the mini program order.
```

--------------------------------

### LoadAliPayPublicCertFromFile

Source: https://pkg.go.dev/github.com/smartwalle/alipay/v3

Loads the Alipay public certificate from a file. Deprecated.

```APIDOC
## LoadAliPayPublicCertFromFile

### Description
Loads the Alipay public certificate from a file. This method is deprecated.

### Method
(Not specified in source)

### Endpoint
(Not specified in source)

### Parameters
#### Path Parameters
(None specified)

#### Query Parameters
(None specified)

#### Request Body
- **filename** (string) - Required - The path to the certificate file.

### Request Example
(Not specified in source)

### Response
#### Success Response (200)
- **error** (error) - Returns an error if the loading fails.

#### Response Example
(Not specified in source)
```

--------------------------------

### LoadAppPublicCert

Source: https://pkg.go.dev/github.com/smartwalle/alipay/v3

Deprecated: use LoadAppCertPublicKey instead. Loads the application public certificate.

```APIDOC
## LoadAppPublicCert

### Description
Loads the application public certificate. Deprecated: use LoadAppCertPublicKey instead.

### Method
POST

### Endpoint
/v3/alipay/app/public/cert/load

### Parameters
#### Request Body
- **s** (string) - Required - The certificate content.
```

--------------------------------

### FaceVerificationInitialize

Source: https://pkg.go.dev/github.com/smartwalle/alipay/v3

Parameters for initializing face verification.

```APIDOC
## FaceVerificationInitialize

### Description
Parameters for initializing face verification.

### Method
POST

### Endpoint
/v3/face/verification/initialize

### Parameters
#### Request Body
- **outer_order_no** (string) - Required - Merchant's unique request identifier, must be unique and 64 characters long (alphanumeric). Suggestion: Start with a merchant abbreviation, followed by a timestamp, and end with a random or sequential number.
- **biz_code** (string) - Required - Specific type of face recognition, currently only supports: DATA_DIGITAL_BIZ_CODE_FACE_VERIFICATION.
- **identity_type** (string) - Required - Verification type, fixed value: CERT_INFO.
- **cert_type** (string) - Required - Certificate type. Supported values: IDENTITY_CARD (ID card), RESIDENCE_HK_MC (Hong Kong/Macao Resident Identity Card), RESIDENCE_TAIWAN (Taiwan Resident Identity Card).
- **cert_name** (string) - Required - Real name.
- **cert_no** (string) - Required - Certificate number.
- **app_auth_token** (string) - Optional - App authorization token.
```

--------------------------------

### LoadAlipayCertPublicKeyFromFile

Source: https://pkg.go.dev/github.com/smartwalle/alipay/v3

从文件加载支付宝公钥证书. Loads the Alipay certificate public key from a file.

```APIDOC
## LoadAlipayCertPublicKeyFromFile

### Description
Loads the Alipay certificate public key from a file.

### Method
POST

### Endpoint
/v3/alipay/cert/public/key/load/file

### Parameters
#### Request Body
- **filename** (string) - Required - The path to the certificate file.
```

--------------------------------

### WithVerifier

Source: https://pkg.go.dev/github.com/smartwalle/alipay/v3

Create a custom verifier for scenarios where the Alipay public key is hosted by a third party.

```APIDOC
## WithVerifier

### Description
Create a custom verifier for scenarios where the Alipay public key is hosted by a third party and cannot be directly obtained.

### Parameters
- **aliCertSN** (string) - The Alipay certificate serial number.
- **verifier** (Verifier) - The custom verifier implementation.
```

--------------------------------

### TradeCreate

Source: https://pkg.go.dev/github.com/smartwalle/alipay/v3

Creates a unified order for payment. This is the initial step in the payment process, generating an order that can then be paid.

```APIDOC
## TradeCreate

### Description
Creates a unified order for payment. This is the initial step in the payment process, generating an order that can then be paid.

### Method Signature
```go
func (c *Client) TradeCreate(ctx context.Context, param TradeCreate) (result *TradeCreateRsp, err error)
```

### Related Documentation
- https://docs.open.alipay.com/api_1/alipay.trade.create/
```

--------------------------------

### TradeAppMergePay Params Method

Source: https://pkg.go.dev/github.com/smartwalle/alipay/v3

Returns the parameters for the TradeAppMergePay structure.

```go
func (t TradeAppMergePay) Params() map[string]string
```

--------------------------------

### Upload File with Custom Request

Source: https://pkg.go.dev/github.com/smartwalle/alipay/v3

Demonstrates how to use a custom request to call the alipay.open.file.upload API. This API is for mini-program applications and requires 'Search Direct Access' to be enabled. Note that interface content encryption is not supported for file uploads.

```go
var p = alipay.NewPayload("alipay.open.file.upload")
p.Encrypt = false // 文件上传不支持接口内容加密

// 设置参数
p.AddParam("biz_code", "content_creation")

// 添加文件
p.AddFile("file_content", "a.jpg", "path/a.jpg")
// 或者
p.AddObject("file_content", "a.jpg", io.Reader)

var result map[string]interface{}
var err = client.Request(p, &result)
```

--------------------------------

### SystemOauthToken

Source: https://pkg.go.dev/github.com/smartwalle/alipay/v3

Obtains a system OAuth token.

```APIDOC
## SystemOauthToken

### Description
Obtains a system OAuth token.

### Method
(Implied POST or GET based on typical SDK usage, specific HTTP method not provided in source)

### Endpoint
(Not specified in source)

### Parameters
#### Path Parameters
(None specified)

#### Query Parameters
(None specified)

#### Request Body
- **param** (SystemOauthToken) - Required - The parameters for obtaining the OAuth token.

### Request Example
(Not specified in source)

### Response
#### Success Response (200)
- **result** (*SystemOauthTokenRsp) - The response object containing the OAuth token details.

#### Response Example
(Not specified in source)
```

--------------------------------

### Define MiniOrderExtInfoDTO Structure

Source: https://pkg.go.dev/github.com/smartwalle/alipay/v3

Defines the structure for mini program order extended information, including door time, order string, trade type, trade number, and optional additional rebate base price and deduct sign scene.

```go
type MiniOrderExtInfoDTO struct {
	DoorTime                time.Time `json:"door_time,omitempty"`                  // 预约上门取件时间，可选
	OrderStr                string    `json:"order_str"`                            // 芝麻租赁授权签名，条件必选
	OrderTradeType          string    `json:"order_trade_type"`                     // 订单交易类型，条件必选
	TradeNo                 string    `json:"trade_no"`                             // 交易号，条件必选
	AdditionRebateBasePrice *string   `json:"addition_rebate_base_price,omitempty"` // 订单附加返佣金额基数，可选
	DeductSignScene         string    `json:"deduct_sign_scene,omitempty"`          // 代扣协议签约场景，可选
}
```
Tokens:
Raw