Submit attachment

2023-07-12 02:31

POST: /amsin/api/v1/business/account/submitAttachment

This API is called to submit the attachment required by the submitTradeOrder API.

Structure

A message consists of a header and body. The following sections are focused on the body structure. For the header structure, see:

Request body parameters

Field	Data type	Required	Description
attachmentId	String	Yes	Attachment identity More information about this field: This field is only for request identification, not for idempotent control. Maximum length: 64 characters
attachmentType	String	Yes	Attachment type Value reference: AttachmentType
attachmentContent	String	Yes	Attachment's content. Maximum: 7MB. Format: PNG, JPG, JPEG, PDF. More information about this field: Base64 encoding is required. Maximum length: 9786710 characters
fileName	String	Yes	The original file name of the submitted attachment. Example: file.pdf. More information about this field: Maximum length: 128 characters
bizOrderId	String	Yes	Business order number Fill in the order number in the Zyla order association scenario. More information about this field: Maximum length: 64 characters
bizType	String	Yes	Business type of order synchronization Values: WF_B2B_ORDER_SYNC: attachment of transfer order WF_B2B_COLLECTION_ORDER_SYNC: attachment of collection order

Response parameters

Field	Data type	Required	Description
result	Result object	Yes	Result of API calling
attachmentInfo	AttachmentInfo object	No	Details of submitted attachment

Result code

result.resultCode

resultCode	resultStatus	resultMessage	Further action
SUCCESS	S	Success
PROCESS_FAIL	F	A general business failure occurred. Do Not retry.	Contact Zyla technical support for human intervention.
PARAM_ILLEGAL	F	Illegal parameters exist. For example, a non-numeric input, or an invalid date.	Refer to the API documentation and check if the request header or parameters is valid.
INVALID_SIGNATURE	F	The signature is invalid.	Check if the request's signature is valid.
REPEAT_REQ_INCONSISTENT	F	Repeated requests are inconsistent.	Repeated requests are inconsistent. Ensure all the request parameters are identical.
UNKNOWN_EXCEPTION	U	API failed due to an unknown reason.	Server error. Retry it later. Contact Zyla technical support if the issue remains.
FILE_SIZE_EXCEED_LIMIT	F	The file size has exceeded the limit.	Limit the file size to the allowable range.
CONTRACT_CHECK_FAIL	F	The contract check has failed.	Check the contract status then retry.
FUND_ORDER_NOT_EXIST	F	The fund order does not exist.	The fund order does not exist. Contact Zyla technical support.

Sample code

Request

copy
{
  "attachmentType":"ID_CARD_BACK_SIDE",
  "attachmentId":"*****",
  "fileName":"****.pdf",
  "bizType":"WF_B2B_ORDER_SYNC",
  "bizOrderId": "*****",
  "attachmentContent":"*****"
}

Response

copy
{
  "result": {
    "resultStatus": "S",
    "resultCode": "SUCCESS",
    "resultMessage": "success."
  },
  "attachmentInfo": {
    "fileName":"****.pdf",
    "fileKey":"*****"
  }
}