Nhảy tới nội dung
Phiên bản: Lastest

Token Delete

Xoá token đã tạo, thông tin token đã lưu trữ và liên kết với AppotaPay sẽ được xoá.

EndPoint​

DELETE /credit-card/token/:tokenId

Header Params​

Tham sốYêu cầuKiểu dữ liệuMô tảLưu ý
X-APPOTAPAY-AUTHrequiredString Cách tạo JWT_TOKEN
Content-TyperequiredStringGiá trị: application/json
X-Request-IDoptionalStringĐịnh dạng UUIDv4. Request ID để kiểm tra yêu cầu khi xảy ra sự cốmax:42
LanguageoptionalStringGiá trị vi hoặc en tương ứng với link thanh toán sẽ là tiếng việt hoặc tiếng anh, (mặc định: vi)

in:vi,en

X-Account-Ref-IDoptionalString

Mã định danh của tài khoản Sub account do AppotaPay cung cấp.

Bắt buộc truyền khi thanh toán giao dịch của Sub account loại owner

{
    "X-APPOTAPAY-AUTH": "JWT_TOKEN",
    "Content-Type": "application/json",
    "X-Request-ID": "Your_Unique_id",
    "Language": "vi",
    "X-Account-Ref-ID": "9723f73b-9295-4acb-884b-ab6310c2e653"
}

Request Params​

URL Parameters​

Tham sốYêu cầuKiểu dữ liệuMô tảLưu ý
tokenIdrequiredStringToken ID mà bạn muốn xoáMin:1 Max: 32

URL Query​

Tham sốYêu cầuKiểu dữ liệuMô tảLưu ý
merchantRefIdrequiredStringMã tham chiếu cho yêu cầu của merchantMin:1 Max: 40

Example Request​

{
    "merchantRefId": "9IzaassK2"
}

Response Params​

{
    "tokenId": "01hqhr4qqnk66d7tg3pk5md08c",
    "merchantRefId": "9IzaassK2",
    "isDeleted": true
}

Thành công​

Http Status Code 200 - OK

Tham sốKiểu dữ liệuMô tảLưu ý
tokenIdStringToken ID yêu cầu xoá
merchantRefIdStringMã tham chiếu cho yêu cầu của merchant
isDeletedStringKết quả xoá token:
true: Token xoá thành công.
false: Token xoá thất bại, lý do có thể do token đang được xử lý thanh toán hoặc lỗi, có thể thử lại sau

Thất bại​

HTTP Status Code != 200

Ví dụ Code​

curl -X DELETE "https://gateway.dev.appotapay.com/credit-card/token/01hqhr4qqnk66d7tg3pk5md08c?merchantRefId=9IzaassK2" \
  -H "X-APPOTAPAY-AUTH: JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -H "X-Request-ID: Your_Unique_id" \
  -H "Language: vi" \
  -H "X-Account-Ref-ID: 9723f73b-9295-4acb-884b-ab6310c2e653"

Request​

REQUEST

Development server
Giá trị tương ứng với payment link có thể là tiếng Việt hoặc tiếng Anh (mặc định: vi)