Submit attachmentSignature required
Call this API and submit the required attachments to WorldFirst in the following scenarios:
- when materials (such as contracts, customs forms, etc.) are needed for B2B Partners to submit trade orders and associate them with fund orders (i.e. by calling the submitTradeOrder API).
- when materials (such as invoices) are needed for Partners to apply for a grant (i.e. by calling the applyCreditGrant 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 parameters
attachmentId String REQUIRED
Attachment identity
More information about this field:
- This field is only for request identification, not for idempotent control.
- Maximum length: 64 characters
attachmentType String REQUIRED
Attachment type
Value reference: AttachmentType
attachmentContent String REQUIRED
Attachment's content. Maximum: 7MB
Supported file formats: PNG, JPG, JPEG, PDF, ZIP.
More information about this field:
- Base64 encoding is required.
- Maximum length: 9786710 characters
fileName String REQUIRED
The original file name of the submitted attachment.
Example: file.pdf
More information:
- Maximum length: 128 characters
bizOrderId String REQUIRED
Business order number
Fill in the order number in the WorldFirst order association scenario.
More information:
- Maximum length: 64 characters
bizType String REQUIRED
Business type of order synchronization.
Values:
WF_B2B_ORDER_SYNC: attachment of transfer orderWF_B2B_COLLECTION_ORDER_SYNC: attachment of collection order
Response parameters
result Result REQUIRED
Result of API calling
attachmentInfo AttachmentInfo
Details of submitted attachment
Request
Response
Result/Error codes
| Code | Value | Message | Further action |
|---|---|---|---|
| SUCCESS | S | Success | |
| PROCESS_FAIL | F | A general business failure occurred. Do Not retry. | Contact WorldFirst 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 WorldFirst 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. |