API Update plan

Endpoint: /api/v1/plans/{planId}

Method: PATCH

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-APPOTAPAY-AUTH": "JWT_TOKEN",
    "Content-Type": "application/json",
    "X-Request-ID": "Your_Unique_id",
    "Language": "vi"
}

Request params

Param	Required	Type	Description	Note
customerId	Optional	String	Customer ID	min:1, max: 50
currency	Optional	String	Currency unit	in: VND
amount	Optional	Integer	Amount
paymentMethods	Optional	Array	Payment method list
paymentMethods.*.paymentMethodId	Optional	String	Payment method ID
paymentMethods.*.rank	Optional	Integer	Indicate the order which payments methods will be attempted for a payment cycle instance. Available values - 1 to 5	min: 1

Example Request

{
    "customerId": "01HRVK3A0G66QJB16W2R1G2HSJ",
    "currency": "VND",
    "amount": 405100,
    "paymentMethods": [
        {
            "paymentMethodId": "f19bbadb-3446-4558-84c2-3c36a6b9757a",
            "rank": 1
        }
    ]
}

Response data

Success

Http Status Code 200 - OK

Success responses will contain a single Plan object

Failure

HTTP Status Code != 200

Error response params

Param	Required	Type	Description
errorCode	required	Integer	Error code
message	required	String	Error message
errors	optional	Array	Detailed error description
errors.*.field	optional	String	Field data is corrupted
errors.*.reason	optional	String	Description of the data field in error

{
    "errorCode": 3005,
    "message": "Plan not exist"
}

Common error code table

Full error code, please check this error code list

Error code	Description
0	Success
1	Missing or Invalid Params
11	Partner is not found
13	Partner has been blocked
14	API Key is invalid
15	API Key is not activated or blocked
92	IP is not allowed to access
99	Undefined error, please contact AppotaPay for more detailed information
401	Unauthorized
500	Server error
3003	Customer not exist
3004	Payment method not exist
3005	Plan not exist
3006	Plan was inactive before
3012	Payment method is invalid
3046	The plan is pending, please check it later