Embedded Checkout 2.0 Credit Card Binding API Documentation

Credit Card Binding / Delete Bind Credit Card

Scenario

Provide merchants with the functionality to delete bound credit cards. This API allows merchants to specify and remove a particular credit card that has been previously bound.

API Urls

  • Stage: https://ecpg-stage.ecpay.com.tw/Merchant/DeleteMemberBindCard
  • Production: https://ecpg.ecpay.com.tw/Merchant/DeleteMemberBindCard

Message format

  • Content Type：application/json
  • HTTP Method：POST

Request (Json format)

MerchantID String(10)
Required

For platform merchants, the value please populate with the Platform merchant’s MerchantID.

RqHeader Object
Required

Request header

Timestamp Number
Required

Unix timestamp

❗ Special note:

  • ECPay will verify the timestamp.If ECPay receives the request is more 10 minutes late than the timestamp, the transaction will be failed.
  • Merchants are suggested to synchronize the time of a computer on client- or server-side to another server or nearest reference time source.
  • For more details can be seen here; another online tool can be found here.

Data String
Required

Payload of JSON that has been encrypted.

Request Example (Json format)​

{
    "MerchantID": "3002607",
    "RqHeader": {
        "Timestamp": 1234567890
    },
    "Data": "enter your data"
}

Message payload of Data (Json format)

❗ Special note: Please urlencode the JSON string firstly and then do AES encryption.

PlatformID String(10)
 

Platform ID

  • This is used by platform merchants and will be provided by ECPay.
  • For platform merchants, please populate with [MerchantID].
  • For general merchants, please set as null.

MerchantID String(10)
Required

Merchant ID

BindCardPayToken String(64) 
 Required

Binding Credit Card Code

MerchantMemberID String(60) 
 Required

Membership Number

Data Example:(Json format)​

{
    "MerchantID": "3002607",
    "BindCardID": "abc1234456abc"
}

Response (Json format)

MerchantID String(10)
 

Merchant ID

RpHeader Object

Timestamp Number
 

Unix timestamp

TransCode Int
 

Response codes to indicate whether the payload is successfully accepted.

  • 1: Payload (i.e. MerchantID, RqHeader, and Data) is successfully accepted by ECPay.
  • Others: failed.

TransMsg String(200)
 

Response message to indicate whether the payload is successfully accepted.

Data String

Payload of JSON that has been encrypted.

Response Example (Json format)

{
    "MerchantID": "3002607",
    "RpHeader": {
        "Timestamp": 1234564848
    },
    "TransCode": 1,
    "TransMsg": "Success",
    "Data": "…"
}

Message payload of Data (Json format)

RtnCode Int

Response codes to indicate whether the API is successfully executed or not.

  • 1: API is successfully executed.
  • Others: failed.
  • For more details please see error codes.

RtnMsg String(200)

Response messages.

Response Example (Json format)

{
    "RtnCode": 1,
    "RtnMsg": "Success"
}

Copyright © Green World FinTech Service Co., Ltd. All rights reserved.

綠界官方網站