Payment methods

创建支付方式以及客户信息，并作关联操作

创建支付方式接口

创建支付方式接口

post

/V2022-03/payment_methods

Header parameters

gateway-nostring(16)required

网关号

request-idstring(64)required

请求id，30分钟之内唯一

request-timestring(16)required

时间戳，以毫秒（ms）为单位，请求误差不能超过10分钟

sign-infostring(255)required

验签字段，具体加签方式请参阅数据签名过程章节

Body

billingDetailobjectrequired

账单地址信息

cardobjectrequired

卡号信息

customerIdstring(100)

客户ID； 将客户与创建的支付方式进行绑定； 商户可以通过接口/customers发起post创建； 最大长度为100； 如：cus_1420997690607206400

Example: cus_1420997690607206400

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'http://{paymentApiUrl}/V2022-03/payment_methods' \
  --header 'gateway-no: null' \
  --header 'request-id: null' \
  --header 'request-time: null' \
  --header 'sign-info: null' \
  --header 'Content-Type: application/json' \
  --data '{
    "billingDetail": {
      "Address": {
        "city": "Maryland",
        "country": "US",
        "line1": "west street",
        "postalCode": "21133",
        "state": "MD"
      },
      "email": "[e-mail]",
      "firstName": "asia",
      "lastName": "bill",
      "phone": 13212344321
    },
    "card": {
      "cardExpireMonth": null,
      "cardExpireYear": null,
      "cardNo": null,
      "cardSecurityCode": null
    },
    "customerId": "cus_1420997690607206400"
  }'

200

200

{
  "code": "success",
  "message": "message response",
  "data": {
    "billingDetail": {
      "Address": {
        "city": "Maryland",
        "country": "US",
        "line1": "west street",
        "postalCode": "21133",
        "state": "MD"
      },
      "email": "[e-mail]",
      "firstName": "asia",
      "lastName": "bill",
      "phone": 13212344321
    },
    "card": {
      "brand": 2222,
      "last4": 1111
    },
    "customerPaymentMethodId": "pm_1420997693836820480"
  }
}

OK

创建支付方式接口请求报文示例

createPaymentMethod.sh

curl --request POST \
  --url https://{paymentApiUrl}/V2022-03/payment_methods \
  --header 'Content-Type: application/json' \
  --header 'request-id: 58675' \
  --header 'request-time: 1651888520935' \
  --header 'gateway-no: 12345001' \
  --header 'sign-info: 787966BF2479A1BE8E1886CD18E6919447FAF4F357E7056188D4F035661B822B' \
  --data '{
    "billingDetail": {
        "address": {
            "city": "NEWARK VALLEY",
            "country": "US",
            "line1": "4348  Calico Drive",
            "postalCode": "13811",
            "state": "NY"
        },
        "email": "[e-mail]",
        "firstName": "Di Mo",
        "lastName": "Shi",
        "phone": "509-675-8948"
    },
    "card": {
        "cardNo": "5333302221254276",
        "cardExpireMonth": "12",
        "cardExpireYear": "2025",
        "cardSecurityCode": "123"
    },
    "customerId": "cus_1526760517237616640"
}'

更新PaymentMethod的信息

更新PaymentMethod的信息

post

/V2022-03/payment_methods/update

Header parameters

gateway-nostring(16)required

网关号

request-idstring(64)required

请求id，30分钟之内唯一

request-timestring(16)required

时间戳，以毫秒（ms）为单位，请求误差不能超过10分钟

sign-infostring(255)required

验签字段，具体加签方式请参阅数据签名过程章节

Body

billingDetailobjectrequired

账单地址信息

cardobjectrequired

卡号信息

customerPaymentMethodIdstring(100)required

卡支付ID， 商户可以通过接口/payment_methods发起post创建，必填项； 如：pm_1420997693836820480

Example: pm_1420997693836820480

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'http://{paymentApiUrl}/V2022-03/payment_methods/update' \
  --header 'gateway-no: null' \
  --header 'request-id: null' \
  --header 'request-time: null' \
  --header 'sign-info: null' \
  --header 'Content-Type: application/json' \
  --data '{
    "billingDetail": {
      "Address": {
        "city": "Maryland",
        "country": "US",
        "line1": "west street",
        "postalCode": "21133",
        "state": "MD"
      },
      "email": "[e-mail]",
      "firstName": "asia",
      "lastName": "bill",
      "phone": 13212344321
    },
    "card": {
      "cardExpireMonth": null,
      "cardExpireYear": null,
      "cardNo": null,
      "cardSecurityCode": null
    },
    "customerPaymentMethodId": "pm_1420997693836820480"
  }'

200

200

{
  "code": "success",
  "message": "message response",
  "data": {
    "billingDetail": {
      "Address": {
        "city": "Maryland",
        "country": "US",
        "line1": "west street",
        "postalCode": "21133",
        "state": "MD"
      },
      "email": "[e-mail]",
      "firstName": "asia",
      "lastName": "bill",
      "phone": 13212344321
    },
    "card": {
      "brand": 2222,
      "last4": 1111
    },
    "customerPaymentMethodId": "pm_1420997693836820480"
  }
}

OK

更新支付方式接口请求报文示例

updatePaymentMethod.sh

curl --request POST \
  --url https://{paymentApiUrl}/V2022-03/payment_methods/update \
  --header 'Content-Type: application/json' \
  --header 'request-id: 58675' \
  --header 'request-time: 1651888520935' \
  --header 'gateway-no: 12345001' \
  --header 'sign-info: 787966BF2479A1BE8E1886CD18E6919447FAF4F357E7056188D4F035661B822B' \
  --data '{
    "billingDetail": {
        "address": {
            "city": "NEWARK VALLEY",
            "country": "US",
            "line1": "4349  Calico Drive",
            "postalCode": "13811",
            "state": "NY"
        },
        "email": "[e-mail]",
        "firstName": "Di Ma",
        "lastName": "Shi",
        "phone": "509-675-8948"
    },
    "customerPaymentMethodId": "pm_1526760521989763072"
}'

获取支付方式接口请求报文示例

curl --request GET \
  --url https://{paymentApiUrl}/V2022-03/payment_methods/pm_1526760521989763072 \
  --header 'Content-Type: application/json' \
  --header 'request-id: 58675' \
  --header 'request-time: 1651888520935' \
  --header 'gateway-no: 12345001' \
  --header 'sign-info: 787966BF2479A1BE8E1886CD18E6919447FAF4F357E7056188D4F035661B822B' \

获取支付方式接口

获取支付方式接口

get

/V2022-03/payment_methods/{customerPaymentMethodId}

Path parameters

customerPaymentMethodIdstring(100)required

卡支付ID，最大长度100，如：pm_1420997693836820480

Header parameters

gateway-nostring(16)required

网关号

request-idstring(64)required

请求id，30分钟之内唯一

request-timestring(16)required

时间戳，以毫秒（ms）为单位，请求误差不能超过10分钟

sign-infostring(255)required

验签字段，具体加签方式请参阅数据签名过程章节

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'http://{paymentApiUrl}/V2022-03/payment_methods/{customerPaymentMethodId}' \
  --header 'gateway-no: null' \
  --header 'request-id: null' \
  --header 'request-time: null' \
  --header 'sign-info: null'

200

200

{
  "code": "success",
  "message": "message response",
  "data": {
    "billingDetail": {
      "Address": {
        "city": "Maryland",
        "country": "US",
        "line1": "west street",
        "postalCode": "21133",
        "state": "MD"
      },
      "email": "[e-mail]",
      "firstName": "asia",
      "lastName": "bill",
      "phone": 13212344321
    },
    "card": {
      "brand": 2222,
      "last4": 1111
    },
    "customerPaymentMethodId": "pm_1420997693836820480"
  }
}

OK

获取支付方式接口请求报文示例

getPaymentMethod

curl --request GET \
  --url https://{paymentApiUrl}/V2022-03/payment_methods/pm_1526760521989763072 \
  --header 'Content-Type: application/json' \
  --header 'request-id: 58675' \
  --header 'request-time: 1651888520935' \
  --header 'gateway-no: 12345001' \
  --header 'sign-info: 787966BF2479A1BE8E1886CD18E6919447FAF4F357E7056188D4F035661B822B' \

根据客户获取所有支付方式接口

根据客户获取所有支付方式接口

get

/V2022-03/payment_methods/list/{customerId}

Path parameters

customerIdstring(100)required

客户id，最大长度100，如：cus_1420997690607206400

Header parameters

gateway-nostring(16)required

网关号

request-idstring(64)required

请求id，30分钟之内唯一

request-timestring(16)required

时间戳，以毫秒（ms）为单位，请求误差不能超过10分钟

sign-infostring(255)required

验签字段，具体加签方式请参阅数据签名过程章节

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'http://{paymentApiUrl}/V2022-03/payment_methods/list/{customerId}' \
  --header 'gateway-no: null' \
  --header 'request-id: null' \
  --header 'request-time: null' \
  --header 'sign-info: null'

200

200

{
  "code": "success",
  "message": "message response",
  "data": [
    {
      "billingDetail": {
        "Address": {
          "city": "Maryland",
          "country": "US",
          "line1": "west street",
          "postalCode": "21133",
          "state": "MD"
        },
        "email": "[e-mail]",
        "firstName": "asia",
        "lastName": "bill",
        "phone": 13212344321
      },
      "card": {
        "brand": 2222,
        "last4": 1111
      },
      "customerPaymentMethodId": "pm_1420997693836820480"
    }
  ]
}

OK

根据客户获取所有支付方式接口请求报文示例

getPaymentMethodListByCustomerId.sh

curl --request GET \
  --url https://{paymentApiUrl}/V2022-03/payment_methods/list/cus_1526760517237616640 \
  --header 'Content-Type: application/json' \
  --header 'request-id: 58675' \
  --header 'request-time: 1651888520935' \
  --header 'gateway-no: 12345001' \
  --header 'sign-info: 787966BF2479A1BE8E1886CD18E6919447FAF4F357E7056188D4F035661B822B' \

客户附加支付方式接口

客户附加支付方式接口

get

/V2022-03/payment_methods/{customerPaymentMethodId}//{customerId}/attach

Path parameters

customerIdstring(100)required

客户id，最大长度100，如：cus_1420997690607206400

customerPaymentMethodIdstring(100)required

卡支付ID，最大长度100，如：pm_1420997693836820480

Header parameters

gateway-nostring(16)required

网关号

request-idstring(64)required

请求id，30分钟之内唯一

request-timestring(16)required

时间戳，以毫秒（ms）为单位，请求误差不能超过10分钟

sign-infostring(255)required

验签字段，具体加签方式请参阅数据签名过程章节

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'http://{paymentApiUrl}/V2022-03/payment_methods/{customerPaymentMethodId}/{customerId}/attach' \
  --header 'gateway-no: null' \
  --header 'request-id: null' \
  --header 'request-time: null' \
  --header 'sign-info: null'

200

200

{
  "code": "success",
  "message": "message response",
  "data": {
    "billingDetail": {
      "Address": {
        "city": "Maryland",
        "country": "US",
        "line1": "west street",
        "postalCode": "21133",
        "state": "MD"
      },
      "email": "[e-mail]",
      "firstName": "asia",
      "lastName": "bill",
      "phone": 13212344321
    },
    "card": {
      "brand": 2222,
      "last4": 1111
    },
    "customerPaymentMethodId": "pm_1420997693836820480"
  }
}

OK

客户附加支付方式接口请求报文示例

curl --request GET \
  --url https://{paymentApiUrl}/V2022-03/payment_methods/pm_1526760521989763072/cus_1526760517237616640/attach \
  --header 'Content-Type: application/json' \
  --header 'request-id: 58675' \
  --header 'request-time: 1651888520935' \
  --header 'gateway-no: 12345001' \
  --header 'sign-info: 787966BF2479A1BE8E1886CD18E6919447FAF4F357E7056188D4F035661B822B' \

解绑支付方式接口

解绑支付方式接口

get

/V2022-03/payment_methods/{customerPaymentMethodId}/detach

Path parameters

customerPaymentMethodIdstring(100)required

卡支付ID，最大长度100，如：pm_1420997693836820480

Header parameters

gateway-nostring(16)required

网关号

request-idstring(64)required

请求id，30分钟之内唯一

request-timestring(16)required

时间戳，以毫秒（ms）为单位，请求误差不能超过10分钟

sign-infostring(255)required

验签字段，具体加签方式请参阅数据签名过程章节

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'http://{paymentApiUrl}/V2022-03/payment_methods/{customerPaymentMethodId}/detach' \
  --header 'gateway-no: null' \
  --header 'request-id: null' \
  --header 'request-time: null' \
  --header 'sign-info: null'

200

200

{
  "code": "success",
  "message": "message response",
  "data": {
    "billingDetail": {
      "Address": {
        "city": "Maryland",
        "country": "US",
        "line1": "west street",
        "postalCode": "21133",
        "state": "MD"
      },
      "email": "[e-mail]",
      "firstName": "asia",
      "lastName": "bill",
      "phone": 13212344321
    },
    "card": {
      "brand": 2222,
      "last4": 1111
    },
    "customerPaymentMethodId": "pm_1420997693836820480"
  }
}

OK

解绑支付方式接口请求报文示例

curl --request GET \
  --url https://{paymentApiUrl}/V2022-03/payment_methods/pm_1526760521989763072/detach \
  --header 'Content-Type: application/json' \
  --header 'request-id: 58675' \
  --header 'request-time: 1651888520935' \
  --header 'gateway-no: 12345001' \
  --header 'sign-info: 787966BF2479A1BE8E1886CD18E6919447FAF4F357E7056188D4F035661B822B' \

以上接口，【根据客户获取所有支付方式】【解绑支付方式】返回结构差异外，其他均返回如下结构（由于数据字段并无差别所以不再展示）

结果对象属性描述

property name	type	description
code	String	返回码
message	String	返回信息
data	Object	数据对象
customerPaymentMethodId	String	支付方式id； 如：pm_1671231231232
card	Object	对象
last4	String	卡后四位
brand	String	卡组织； 如：Visa
billingDetail	Object	对象
email	String	邮箱
firstName	String	firstName
lastName	String	lastName
phone	String	电话
address	Object	对象
city	String	城市
country	String	国家代码，两位字母的ISO国家代码
line1	String	地址1，该地址优先使用
line2	String	地址2
postalCode	String	邮编
state	String	州；两位字母的ISO州代码