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

Token Create

EndPoint​

POST /credit-card/token

Header Params​

{
  Content-Type: "application/json",
  X-APPOTAPAY-AUTH: "your_auth_token",
  Language: "vi", // option vi | en, default vi
  X-Request-ID: "your_request_id" // optional - easy to debug request
}

Request Params​

Tham sốYêu cầuKiểu dữ liệuMô tảLưu ý
cardrequiredObjectThông tin thẻ
card.numberrequiredStringSố thẻ16 số
card.holderNamerequiredStringTên chủ thẻMin: 1 Max: 50 bao gồm: 0- 9, a-z, A-Z, khoảng trắng
card.expirationMonthrequiredStringTháng hết hạn của thẻ, bao gồm cả số 0 ở đầu (VD: 03)
card.expirationYearrequiredStringNăm hết hạn của thẻ (VD.: 25)
card.cvvrequiredString

Card verification number, hay CVV

Mã số bí mật của thẻ, gồm 3 hoặc 4 số
tokenTyperequiredString

Loại token - sử dụng 1 lần hoặc nhiều lần

SINGLE: token chỉ thanh toán 1 lần

MULTIPLE: token thanh toán được nhiều lần

merchantRefIdrequiredStringMã tham chiếu, định danh cho yêu cầu khởi tạo từ merchantMin: 1 Max: 40
customeroptionalObject

Thông tin khách hàng

Nếu có thông tin khách hàng, bạn cần truyền đầy đủ tất cả thông tin

customer.browseroptionalObjectThông tin trình duyệt customer
customer.browser.clientIpoptionalStringĐịa chỉ IP của thiết bị khách hàng thanh toánIPv4 Min: 7 Max: 45
customer.browser.userAgentoptionalString

User Agent của khách hàng. Thông tin được thu thập từ header được gửi từ thiết bị của khách hàng

Được sử dụng cho quản lý rủi ro

VD: Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) HeadlessChrome/92.0.4512.0 Safari/537.36

Max: 500
customer.browser.referreroptionalString

Địa chỉ trước đó được điều hướng đến trang thanh toán của merchant

Được sử dụng cho quản lý rủi ro

VD: AppotaPay - The leading online payment company in Vietnam

Min: 1 Max: 500
customer.browser.acceptLanguageoptionalString

Ngôn ngữ thiết bị của khách hàng

VD: vi-VN, en-US

Được sử dụng cho quản lý rủi ro

Min: 2 Max: 10
billingoptionalObject

Thông tin thanh toán của chủ thẻ đã đăng ký với tổ chức phát hành thẻ

Nếu truyền thông tin billing, bạn cần truyền đầy đủ tất cả thông tin và tương ứng với thông tin đã đăng ký với ngân hàng phát hành

billing.firstNameoptionalString

Tên của chủ thẻ

Hữu ích với frictionless 3DS 2.0

Min: 1 Max: 50
billing.lastNameoptionalStringHọ và tên đệm của chủ thẻ
Hữu ích với frictionless 3DS 2.0		Min: 1 Max: 50
billing.emailoptionalStringEmail khách hàng đã đăng ký với issuer
Hữu ích với frictionless 3DS 2.0		Min: 1 Max: 255
billing.phoneNumberoptionalStringSố điện thoại khách hàng đã đăng ký với issuer
Hữu ích với frictionless 3DS 2.0		Min: 8 Max: 20
billing.provinceoptionalStringTỉnh, tiểu bang, khu vực cư trú.
Nếu khách hàng thuộc tiểu bang của Mỹ, bắt buộc phải nhập mã tiểu bang (VD: nhập CA thay cho California)
Hữu ích với frictionless 3DS 2.0		Min: 1 Max: 100
billing.cityoptionalStringThành phố, thị trấn
Hữu ích với frictionless 3DS 2.0		Min: 1 Max: 100
billing.countryoptionalString2 ký tự trong bảng mã quốc gia theo chuẩn ISO 3166-2
Hữu ích với frictionless 3DS 2.0		Min: 2 Max: 2
billing.addressLine1optionalStringĐịa chỉ thanh toán thứ nhất mà khách đã đăng ký với issuer
Hữu ích với frictionless 3DS 2.0		Min: 1 Max: 100
billing.addressLine2optionalStringĐịa chỉ thanh toán thứ hai mà khách đã đăng ký với issuer
Hữu ích với frictionless 3DS 2.0		Min: 1 Max: 100
billing.postalCodeoptionalStringMã bưu điện
Hữu ích với frictionless 3DS 2.0		Min: 1 Max: 10

Example Request​

{
    "merchantRefId": "PdWghqjDT",
    "tokenType": "SINGLE",
    "card" : {
        "holderName": "HOANG NHUNG",
        "number": "4000000000000010",
        "expirationMonth": "12",
        "expirationYear": "29",
        "cvv": "123"
    },
    "customer" : {
        "browser": {
            "clientIp": "192.11.11.11",
            "userAgent": "ui",
            "referrer": "https://appotapay.com/",
            "acceptLanguage": "en-US"
        }
    },
    "billing" : {
        "firstName": "NHUNG",
        "lastName": "HOANG",
        "email": "nhunghoang@email.com",
        "phoneNumber": "02345686432",
        "alternatePhoneNumber": "02345686432",
        "province": "VP",
        "country": "MM",
        "city": "VT",
        "addressLine1": "81 Lang Ha",
        "addressLine2": "17 Mai Anh Tuan",
        "postalCode": "10000"
    }
}

Response Params​

{
    "tokenId": "01hqhr4qqnk66d7tg3pk5md08c",
    "merchantRefId": "PdWghqjDT",
    "card": {
        "number": "400000XXXXXX0010",
        "type": "CREDIT",
        "brand": "MASTERCARD",
        "country": "VN"
    },
    "billing": {
        "firstName": "NHUNG",
        "lastName": "HOANG",
        "email": "nhunghoang@email.com",
        "phoneNumber": "02345686432",
        "alternatePhoneNumber": "",
        "country": "MM",
        "province": "VP",
        "city": "VT",
        "addressLine1": "81 Lang Ha",
        "addressLine2": "17 Mai Anh Tuan",
        "postalCode": "10000"
    },
    "createdAt": "2024-02-26T10:43:08+07:00",
    "updatedAt": "2024-02-26T10:43:09+07:00"
}

Thành công​

Http Status Code 200 - OK

Tham sốKiểu dữ liệuMô tảLưu ý
tokenIdStringMã tokenMin:1 Max: 32
merchantRefIdStringMã tham chiếu, merchant gửi trong requestMin:1 Max: 40
cardObjectThông tin thẻ được lưu trữ trong token
card.numberString6 số đầu - 4 số cuối của thẻ (VD 123456xxxxx1234)Min:16 Max: 19
card.typeStringLoại thẻ, gồm:
CREDIT / DEBIT / PREPAID / UNKNOWN
card.brandStringThương hiệu thẻ, gồm:
VISA / MASTERCARD / JCB / AMEX
card.countryStringQuốc gia phát hành thẻ, bao gồm 2 chữ cái theo bảng mã ISO 3166-2 (VD: VN, US)
billingObjectTham số đã gửi ở trong request tạo token
createdAtStringThời gian khởi tạo giao dịch theo chuẩn RFC-3339, time zone UTC+7
updatedAtStringThời gian cập nhật giao dịch gần nhất theo chuẩn RFC-3339, time zone UTC+7

Thất bại​

HTTP Status Code != 200