Charge: Get
EndPoint
GET
/credit-card/charge/:creditCardRefId
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
URL Parameter
Tham số | Yêu cầu | Kiểu dữ liệu | Mô tả | Lưu ý |
---|---|---|---|---|
creditCardRefId | required | String | Transaction ID được tạo bảo AppotaPay khi charge thành công, hoặc Reference ID được gửi trong yêu cầu từ merchant |
Query Parameter
Tham số | Yêu cầu | Kiểu dữ liệu | Mô tả | Lưu ý |
---|---|---|---|---|
referenceType | optional | String | - APPOTAPAY_REFERENCE_ID nếu sử dụng mã giao dịch được tạo bởi AppotaPay, trả trong phần phản hồi khi charge thành công (giá trị mặc định) - MERCHANT_REFERENCE_ID nếu sử dụng mã tham chiếu merchant gửi trong yêu cầu charge |
Response Params
{
"id": "01HQHRS9P9J5YPCJ09D94VW84F",
"authenticationId": "01HQHRPNYW78CQJK7CAW1SJP9F",
"merchantRefId": "hi8xGfznb",
"status": "CAPTURED",
"authorizedAmount": 1000000,
"capturedAmount": 1000000,
"currency": "VND",
"approvalCode": "831000",
"eci": "02",
"reconciliationId": "AP241446381046",
"bankReconciliationId": "7089196646896845103954",
"tokenId": "01hqhrp3yhff7z7bvtq6whwz8t",
"card": {
"number": "520000XXXXXX2151",
"expirationMonth": "12",
"expirationYear": "29",
"cardBrand": "MASTERCARD",
"cardType": "CREDIT",
"countryCode": "VI"
},
"chargeType": "BY_MULTIPLE_TOKEN",
"createdAt": "2024-02-26T10:54:22+07:00",
"updatedAt": "2024-02-26T10:56:04+07:00"
}
Thành công
Http Status Code
200
-OK
Response giống với API Charge: Create
Thất bại
HTTP Status Code !=
200