Charge: Capture

This API allows capture within 7 days after successful authorization

EndPoint

POST /credit-card/:authorizationId/capture

Header Params

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

Request Params

Query Parameter

Parameters	Requirement	Data type	Description	Note
authorizationId	required	String	ID of authorization request result

Body

Parameters	Requirement	Data type	Description	Note
amount	required	String	Amount to be captured. Can be up to amount of authorization but not greater than authorized amount.	Min: 1000
currency	required	String	Payment currency. Should be a 3-letter code following the ISO-4217 standard	Support VND

Example Request

{
    "amount": 1000000,
    "currency": "VND"
}

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 Charge: Create API

Error

HTTP Status Code != 200