Update Client's Payment Methods
Details:
This API Call allows you to preview and/or update a client's payments Methods.that means, that you are required to pre-run the "Lock" function to the desired client record only!
API Function Call Name:
Update_Entity_Banking_and_Credit_Cards_JsonFunction Details:
* Method = Post, Json* Parameters Location: Body -> Form-Data
* Hyper Tables Involved: "hyp_Entity_Banking_and_Credit_Cards"
Function Input:
This API call review and update all the fields in the client's payment methods records from "hyp_Entity_Banking_and_Credit_Cards" table.To retrieve the entire list of fields approved for updating VIA this API Call - Post this function with the parameters: "ApiToken" & "json = help" as shown.
To update a Client's Payment Method record post the requested fields along with the mandatory fields:
| Field | Description |
|---|---|
| ApiToken | Mandatory access token |
| PaymentMethod | Mandatory - Primary Record Key |
Postman Example:
* IMPORTANT:
After the update has been completed - Do Not forget to release the client's record VIA "Release_Client_json" Function.
Response Code Examples:
The response code hereby was copied from the "postman" Application.Error Code in case of missing mandatory fields (ApiToken):
without them an Error Code: 003 will be returned.
{
"ResponseCode": "003",
"ResponseMsgEng": "API function does not exists."
}
"ResponseCode": "003",
"ResponseMsgEng": "API function does not exists."
}
Successful Update Response:
{
"ResponseCode": "000",
"ResponseMsgEng": "Success"
}
"ResponseCode": "000",
"ResponseMsgEng": "Success"
}
Click Here to view all possible Response Codes list.