Remittance Proof Document Generation Interface

Description

Merchants can use this interface to generate remittance a proof document for successful orders, and the interface will provide the file path for the generated document on SFTP. The merchant can then download the document by connecting to Geoswift SFTP using their credentials(Please contact technical support team to apply for your SFTP account). The proof document for each request will be stored on SFTP for only 30 days and automatically cleared after expiration. Once cleared, the merchant can use this interface again to generate a new proof document when needed.

Interface Endpoint

https://apis.geoswift.com/remittance/voucher/create

Name Type& Max Description Requirement
merchantId varchar(9) The unique identity of the merchant in Geoswift system. Merchant can log in the merchant operation and management system to check M
orderRequestId varchar(50) The "requestId" previously generated by merchants through "Order Submit Interface"; Remark: only the successful orders with its corresponding "requestId" will be accepted by Geoswift system M
partnerId varchar(9) The unique identifier of the secondary merchant under the main merchant in the Geoswift system.
Note: this parameter can be omitted if the initiating merchant is the main merchant.
C
hmac - The result of parameter signature,generated by the merchant.For the method of obtaining hmac,please reference to "Geoswift encryption and decryption process specification" M

Sample

{   "hmac":"isnV9hbvCRAeDNPHhktXYwxyt4niXHmE+QLmZjYl4F5PfFT1l4L3r5GiVTDru8fBtCxlx5z0VOlxB 7oeTGUdzYV6ar5Mb8fv3tv9RLhlEPIb3l0w/FAMTP/RTG50qSDcj7OX91RWMYnFV/Av7Sn0NMiThUPLFLyee VhgvtCxTFTqv55bmh2uSyKOuHNkZQBmiFENw4lXxcHcLoVDv3ZRvrOM2QK9UfksWJR71ZDpAmhckzH2SwOq1 kPv22RaLSmnXOMZ9NiyGpuCmfwcNBJLJxlj0NO+lqTIPGMNVhjoCFwI0F+MN4svvU6cpqn0wz3CTlI1lVkp0 zgcS+e6oGhOJA==",   "merchantId":"G90008001",   "orderRequestId":"1680230108112" }

Response Parameter Fields

Name Description
merchantId The same as the request parameter
orderRequestId The "requestId" previously generated by merchants through "Order Submit Interface"
filePath The file path of the applied proof documents in Geoswift SFTP
status SUCCESS
ERROR
partnerId The same as the request parameter
hmac The result of parameter signature,generated by Geoswift.For the signature verification process,please reference to "Geoswift encryption and decryption process specification"

Sample

{     "filePath":"/report//remittance/receipt/20230331/1680230108112_20230331.pdf", "hmac":"e6O3Bg7znofoinvNGB4X6LflHrVZE2oKO48Bg4rpWm6FXX9l21fNYSMGs91m291xtGcMGkcubpMiic5s oZ0YMMgqSii8EqxG6q+9+1Jwf2h4TtdMscOoSAwcIA1Bs1w0KAaWCoYB2JB5t1gf1j+UUbpZrZH2es67KM/xLp9T 73eg7lm5UJsyo7COPuD39HZgZ0cTRh6dlg5IdwJGx/C1Kc5VBrhjkp6Kt6P+tHdTxCDGz69TkucL2jiyOkezcz/p SBvuWxg2AwE5p1Iscq3W2uhwItWYC60MQY5MjGgpxgs2Z6No0ZTsoYFdLSD9ab1WY1K8qfVyF+cZLLnwpBzCjg==",     "merchantId":"G90008001",     "orderRequestId":"1680230108112",     "status":"SUCCESS" }