alipay.marketing.card.delete

2020-10-16 18:57

Use this interface to delete membership cards.

#Request

#Service address

Environment	HTTPS request URL
Production environment	https://openapi.alipay.com/gateway.do

#Request parameters

Parameter

Description

Basic parameter

app_id

String (32) Required

The unique ID that is assigned by Alipay to identify an app

Example:2014072300007148

method

String (128) Required

The interface name

Example:alipay.marketing.card.delete

format

String (40)

Only JSON is supported.

Example:JSON

charset

String (10) Required

The charset with which the request data are encoded. UTF-8, GBK, and GB2312 are supported.

Example:UTF-8

sign_type

String (10) Required

The signature algorithm used by the merchant to generate the pre-sign string. RSA and RSA2 are supported. RSA2 is preferred.

Example:RSA2

sign

String (344) Required

The sign value. See Signature for details.

Example:2118ac8fad6bc1d9e88a6cd017c18d37

timestamp

String (19) Required

The time when the request is sent. The format is yyyy-MM-dd HH:mm:ss.

Example:2014-07-24 03:07:50

version

String (3) Required

The interface version. The value is fixed as 1.0.

Example:1.0

biz_content

Required

Collection of request parameters. The maximum length is not limited. Except for basic parameters, all other request parameters must be passed to this parameter.

Business parameter

out_serial_no

String (32) Required

The unique serial number that is assigned by the merchant to identify a card deletion request

Example:201606270000001

target_card_no

String (32) Required

The membership card number that is assigned by Alipay, identical to biz_card_no in the response of alipay.marketing.card.open.

Example:000001

target_card_no_type

String (32) Required

The type of the card number, with a value of BIZ_CARD to indicate a card number that is assigned by Alipay.

Example:BIZ_CARD

reason_code

String (32) Required

The reason to delete the membership card. Possible values are:

USER_UNBUND: the user unbound the membership card. For this case, the membership card can be bound again.
CANCEL: the account is cancelled. For this case, the membership card cannot be bound again.
PRESENT: the membership card is given to someone else. For this case, the membership card can be bound again.

Example:USER_UNBUND

ext_info

String (1024)

Extended information, in the JSON format. This field can be used for passing specific business information when the merchant and Alipay agree on how to use this field. The following keys are supported:

new_card_no: the new card number

donee_user_id: the user ID of the donee

{"new_card_no":"12345"," donee_user_id":"2088102130652460"}

#Response

Parameter

Description

Basic parameter

code

String Required

Gateway return code, which indicates whether the request is accepted by Alipay gateway.

Example:40004

msg

String Required

Description of the gateway return code

Example:Business Failed

sub_code

String

Processing result of the request

Example:ACQ.TRADE_HAS_SUCCESS

sub_msg

String

Description of the processing result of the request

Example:Payment for the transaction is completed.

sign

String Required

The signature value. See Signature for details.

Example:DZXh8eeTuAHoYE3w1J+POiPhfDxOYBfUNn1lkeT/V7P4zJdyojWEa6IZs6Hz0yDW5Cp/viufUb5I0/V5WENS3OYR8zRedqo6D+fUTdLHdc+EFyCkiQhBxIzgngPdPdfp1PIS7BdhhzrsZHbRqb7o4k3Dxc+AAnFauu4V6Zdwczo=

Business parameter

biz_serial_no

String (32) Required

The unique serial number that is assigned by Alipay to identify a card deletion request

Example:2016062700001

#Error codes

Returned result	Description	Solution
INVALID_PARAMETER	Incorrect parameters	Check the problem according to the message.
SYSTEM_ERROR	Alipay system error	Try again.
CARD_NOT_EXIT	The membership card does not exist.	Check the information about the membership card.
NO_CARD_TYPE	The card type is not defined.	Use the correct card type.
CARD_IS_DELETED_ALREADY	The membership card has already been deleted.	No action is needed because the membership card has already been deleted successfully.

#Sample

#Request sample

Java

copy

AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
AlipayMarketingCardDeleteRequest request = new AlipayMarketingCardDeleteRequest();
request.setBizContent("{" +
"\"out_serial_no\":\"2016062700001\"," +
"\"target_card_no\":\"0000001\"," +
"\"target_card_no_type\":\"BIZ_CARD\"," +
"\"reason_code\":\"USER_UNBUND\"," +
"\"ext_info\":\"{\\\"new_card_no\\\":\\\"12345\\\",\\\" donee_user_id\\\":\\\"2088102130652460\\\"}\"" +
"  }");
AlipayMarketingCardDeleteResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("The calling is successful.");
} else {
System.out.println("The calling is failed.");
}

.NET

copy

IAopClient client = new DefaultAopClient("https://openapi.alipay.com/gateway.do", "app_id", "merchant_private_key", "json", "1.0", "RSA2", "alipay_public_key", "GBK", false);
AlipayMarketingCardDeleteRequest  request= new AlipayMarketingCardDeleteRequest() ;
request.BizContent="{" +
"\"out_serial_no\":\"2016062700001\"," +
"\"target_card_no\":\"0000001\"," +
"\"target_card_no_type\":\"BIZ_CARD\"," +
"\"reason_code\":\"USER_UNBUND\"," +
"\"ext_info\":\"{\\\"new_card_no\\\":\\\"12345\\\",\\\" donee_user_id\\\":\\\"2088102130652460\\\"}\"" +
"  }";
AlipayMarketingCardDeleteResponse response=client.execute(request);
Console.WriteLine(response.Body);

PHP

copy

$aop = new AopClient ();
$aop->gatewayUrl = 'https://openapi.alipay.com/gateway.do';
$aop->appId = 'your app_id';
$aop->rsaPrivateKey = 'Please fill in the developer's private key in a line of string, removing the head, tail, and carriage return';
$aop->alipayrsaPublicKey='Please fill in Alipay public key in a line of string';
$aop->apiVersion = '1.0';
$aop->signType = 'RSA2';
$aop->postCharset='GBK';
$aop->format='json';
$request = new AlipayMarketingCardDeleteRequest ();
$request->setBizContent("{" .
"\"out_serial_no\":\"2016062700001\"," .
"\"target_card_no\":\"0000001\"," .
"\"target_card_no_type\":\"BIZ_CARD\"," .
"\"reason_code\":\"USER_UNBUND\"," .
"\"ext_info\":\"{\\\"new_card_no\\\":\\\"12345\\\",\\\" donee_user_id\\\":\\\"2088102130652460\\\"}\"" .
"  }");
$result = $aop->execute ( $request); 

$responseNode = str_replace(".", "_", $request->getApiMethodName()) . "_response";
$resultCode = $result->$responseNode->code;
if(!empty($resultCode)&&$resultCode == 10000){
echo "Success";
} else {
echo "Fail";
}

HTTP request source code

copy

https://openapi.alipay.com/gateway.do?timestamp=2013-01-01 08:08:08&method=alipay.marketing.card.delete&app_id=15638&sign_type=RSA2&sign=ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE&version=1.0&charset=GBK&biz_content=
  {
"out_serial_no":"2016062700001",
"target_card_no":"0000001",
"target_card_no_type":"BIZ_CARD",
"reason_code":"USER_UNBUND",
"ext_info":"{\"new_card_no\":\"12345\",\" donee_user_id\":\"2088102130652460\"}"
  }

#Response sample

JSON

copy

{
    "alipay_marketing_card_delete_response": {
        "code": "10000",
        "msg": "Success",
        "biz_serial_no": "2016062700001"
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

XML

copy

<alipay_marketing_card_delete_response>
<code>10000</code>
<msg>Success</msg>  <biz_serial_no>2016062700001</biz_serial_no>
</alipay_marketing_card_delete_response>

#Exception sample

JSON

copy

{
    "alipay_marketing_card_delete_response": {
        "code": "20000",
        "msg": "Service Currently Unavailable",
        "sub_code": "isp.unknow-error",
        "sub_msg": "The system is busy."
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}