Charge: Get

You can user the API to view charge transaction detail

EndPoint

GET /credit-card/charge/:creditCardRefId

Header Params

Header Params

Param	Required	Type	Description	Note
X-APPOTAPAY-AUTH	required	String	How to generate JWT_TOKEN
Content-Type	required	String	Value: application/json
X-Request-ID	optional	String	UUIDv4 format. Request ID to check when a problem occurs	max:42
Language	optional	String	The value vi or en corresponding to the payment link will be Vietnamese or English, (default: vi)	in:vi,en
X-Account-Ref-ID	optional	String	Iidentifier of the sub account provided by AppotaPay. Mandatory be passed over when processing payment for transactions of owner-type sub account

{
    "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 Parameter

Parameters	Requirement	Data type	Description
creditCardRefId	required	String	Transaction ID is returned by AppotaPay when charge responds successfully Or Reference ID is sent in the request by merchant

Query Parameter

Parameters	Requirement	Data type	Description
referenceType	optional	String	- APPOTAPAY_REFERENCE_ID Transaction ID returned by AppotaPay which can be retrieved from the charge response to retrieve the transaction detail (default value) - MERCHANT_REFERENCE_ID Reference ID submitted by the merchant during charge / authorization request to retrieve the transaction detail

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"
}

Success

Http Status Code 200 - OK

The response is the same with API Charge: Create

Error

HTTP Status Code != 200