{"items":[{"type":"link","label":"PayKKa-collection-openplatform","link":"/collection/apis/openapi","routeSlug":"/collection/apis/openapi","content":{"contentType":"overview","meta":{"name":"PayKKa-collection-openplatform"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"openapi.json","url":"/_bundle/collection/apis/@v2/openapi.json?download"},{"kind":"download","label":"openapi.yaml","url":"/_bundle/collection/apis/@v2/openapi.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"cURL","lang":"curl"},{"key":"python","title":"Python","lang":"Python"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"java","title":"Java","lang":"Java"},{"key":"apachehttpclint","title":"ApacheHttpClint","lang":"Java8+Apache"},{"key":"go","title":"Go","lang":"Go"},{"key":"js","title":"JS","lang":"JavaScript"},{"key":"csharp","title":"C#","lang":"C#"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://api.paykka.com"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"PayKKa-collection-openplatform (1.0.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":"Open platform APIs for merchant onboarding (v2). See appendices for country codes, industries, and file upload flows."}],"sectionId":"/collection/apis/openapi"}],"sectionId":"/collection/apis/openapi"}]}]}},{"type":"group","label":"Merchant Onboarding","link":"/collection/apis/openapi/merchant-onboarding","routeSlug":"/collection/apis/openapi/merchant-onboarding","items":[{"label":"Merchant Onboarding Application","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/collection/apis/openapi/merchant-onboarding/apply_1","routeSlug":"/collection/apis/openapi/merchant-onboarding/apply_1","metadata":{"seo":{"title":"Merchant Onboarding Application","description":"CreateMerchantInformation Special instructions: This API does not pass the Request header ParameterX-Merch-Id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"apply_1","name":"Merchant Onboarding Application","deprecated":false,"isWebhook":false,"pointer":"/paths/~1api~1v2~1merch~1onboard~1apply/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Merchant Onboarding Application","isWebhook":false,"deprecated":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"CreateMerchantInformation Special instructions: This API does not pass the Request header ParameterX-Merch-Id"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Merch-Id","in":"header","schemaId":"schema_141","description":"","example":"M24061911365700670"}],"pointer":"/paths/~1api~1v2~1merch~1onboard~1apply/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_142","exampleIds":["paths/~1api~1v2~1merch~1onboard~1apply/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_142","exampleIds":["paths/~1api~1v2~1merch~1onboard~1apply/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1api~1v2~1merch~1onboard~1apply/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v2/merch/onboard/apply","servers":[{"url":"https://api.paykka.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Merch-Id","in":"header","example":"M24061911365700670","schemaId":"schema_141"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_142","exampleIds":["paths/~1api~1v2~1merch~1onboard~1apply/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","404","429","500"],"pointer":"/api/v2/merch/onboard/apply","href":"merchant-onboarding/apply_1","openApiOperationId":"apply_1","summary":"Merchant Onboarding Application"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.paykka.com"}],"schemaId":"schema_142","exampleIds":["paths/~1api~1v2~1merch~1onboard~1apply/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_142","exampleIds":["paths/~1api~1v2~1merch~1onboard~1apply/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/IdentityVerifyAddRes"}},"schemaId":"components/schemas/IdentityVerifyAddRes","headers":{}},{"code":"400","description":"Bad Request","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}},{"code":"401","description":"Unauthorized","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}},{"code":"404","description":"Not Found","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}},{"code":"429","description":"Too Many Requests","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}},{"code":"500","description":"Internal Server Error","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}}],"pointer":"/paths/~1api~1v2~1merch~1onboard~1apply/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/IdentityVerifyAddRes","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/IdentityVerifyAddRes"}}},{"code":"400","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}},{"code":"401","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}},{"code":"404","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}},{"code":"429","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}},{"code":"500","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/merchant-onboarding/apply_1"}],"panels":[]}]},"httpPath":"/api/v2/merch/onboard/apply"},{"label":"Merchant Information Update","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/collection/apis/openapi/merchant-onboarding/update_1","routeSlug":"/collection/apis/openapi/merchant-onboarding/update_1","metadata":{"seo":{"title":"Merchant Information Update","description":"MerchantInformationUpdate Special instructions: This API does not pass the Request header ParameterX-Merch-Id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"update_1","name":"Merchant Information Update","deprecated":false,"isWebhook":false,"pointer":"/paths/~1api~1v2~1merch~1onboard~1update/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Merchant Information Update","isWebhook":false,"deprecated":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"MerchantInformationUpdate Special instructions: This API does not pass the Request header ParameterX-Merch-Id"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Merch-Id","in":"header","schemaId":"schema_141","description":"","example":"M24061911365700670"}],"pointer":"/paths/~1api~1v2~1merch~1onboard~1update/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_142","exampleIds":["paths/~1api~1v2~1merch~1onboard~1update/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_142","exampleIds":["paths/~1api~1v2~1merch~1onboard~1update/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1api~1v2~1merch~1onboard~1update/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v2/merch/onboard/update","servers":[{"url":"https://api.paykka.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Merch-Id","in":"header","example":"M24061911365700670","schemaId":"schema_141"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_142","exampleIds":["paths/~1api~1v2~1merch~1onboard~1update/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","404","429","500"],"pointer":"/api/v2/merch/onboard/update","href":"merchant-onboarding/update_1","openApiOperationId":"update_1","summary":"Merchant Information Update"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.paykka.com"}],"schemaId":"schema_142","exampleIds":["paths/~1api~1v2~1merch~1onboard~1update/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_142","exampleIds":["paths/~1api~1v2~1merch~1onboard~1update/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/IdentityVerifyAddRes"}},"schemaId":"components/schemas/IdentityVerifyAddRes","headers":{}},{"code":"400","description":"Bad Request","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}},{"code":"401","description":"Unauthorized","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}},{"code":"404","description":"Not Found","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}},{"code":"429","description":"Too Many Requests","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}},{"code":"500","description":"Internal Server Error","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}}],"pointer":"/paths/~1api~1v2~1merch~1onboard~1update/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/IdentityVerifyAddRes","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/IdentityVerifyAddRes"}}},{"code":"400","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}},{"code":"401","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}},{"code":"404","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}},{"code":"429","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}},{"code":"500","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/merchant-onboarding/update_1"}],"panels":[]}]},"httpPath":"/api/v2/merch/onboard/update"},{"label":"Query Merchant Onboarding Result","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/collection/apis/openapi/merchant-onboarding/inquiry_2","routeSlug":"/collection/apis/openapi/merchant-onboarding/inquiry_2","metadata":{"seo":{"title":"Query Merchant Onboarding Result","description":"MerchantOnboardingResultQuery Special instructions: This API does not pass the Request header ParameterX-Merch-Id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"inquiry_2","name":"Query Merchant Onboarding Result","deprecated":false,"isWebhook":false,"pointer":"/paths/~1api~1v2~1merch~1onboard~1inquiry/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Query Merchant Onboarding Result","isWebhook":false,"deprecated":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"MerchantOnboardingResultQuery Special instructions: This API does not pass the Request header ParameterX-Merch-Id"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Merch-Id","in":"header","schemaId":"schema_141","description":"","example":"M24061911365700670"}],"pointer":"/paths/~1api~1v2~1merch~1onboard~1inquiry/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/MerchOnboardInquiryReq","exampleIds":["paths/~1api~1v2~1merch~1onboard~1inquiry/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/MerchOnboardInquiryReq","exampleIds":["paths/~1api~1v2~1merch~1onboard~1inquiry/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1api~1v2~1merch~1onboard~1inquiry/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v2/merch/onboard/inquiry","servers":[{"url":"https://api.paykka.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Merch-Id","in":"header","example":"M24061911365700670","schemaId":"schema_141"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/MerchOnboardInquiryReq","exampleIds":["paths/~1api~1v2~1merch~1onboard~1inquiry/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","404","429","500"],"pointer":"/api/v2/merch/onboard/inquiry","href":"merchant-onboarding/inquiry_2","openApiOperationId":"inquiry_2","summary":"Query Merchant Onboarding Result"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.paykka.com"}],"schemaId":"components/schemas/MerchOnboardInquiryReq","exampleIds":["paths/~1api~1v2~1merch~1onboard~1inquiry/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/MerchOnboardInquiryReq","exampleIds":["paths/~1api~1v2~1merch~1onboard~1inquiry/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_144"}},"schemaId":"schema_144","headers":{}},{"code":"400","description":"Bad Request","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}},{"code":"401","description":"Unauthorized","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}},{"code":"404","description":"Not Found","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}},{"code":"429","description":"Too Many Requests","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}},{"code":"500","description":"Internal Server Error","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}}],"pointer":"/paths/~1api~1v2~1merch~1onboard~1inquiry/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_144","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_144"}}},{"code":"400","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}},{"code":"401","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}},{"code":"404","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}},{"code":"429","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}},{"code":"500","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/merchant-onboarding/inquiry_2"}],"panels":[]}]},"httpPath":"/api/v2/merch/onboard/inquiry"},{"label":"Merchant Onboarding Result (Notification)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/collection/apis/openapi/merchant-onboarding/notification_2","routeSlug":"/collection/apis/openapi/merchant-onboarding/notification_2","metadata":{"seo":{"title":"Merchant Onboarding Result (Notification)","description":"Merchant onboarding result notification"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"notification_2","name":"Merchant Onboarding Result (Notification)","deprecated":false,"isWebhook":false,"pointer":"/paths/~1api~1v2~1merch~1onboard~1notify/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Merchant Onboarding Result (Notification)","isWebhook":false,"deprecated":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Merchant onboarding result notification"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Merch-Id","in":"header","schemaId":"schema_141","description":"","example":"M24061911365700670"}],"pointer":"/paths/~1api~1v2~1merch~1onboard~1notify/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_145","exampleIds":["paths/~1api~1v2~1merch~1onboard~1notify/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_145","exampleIds":["paths/~1api~1v2~1merch~1onboard~1notify/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1api~1v2~1merch~1onboard~1notify/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v2/merch/onboard/notify","servers":[{"url":"https://api.paykka.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Merch-Id","in":"header","example":"M24061911365700670","schemaId":"schema_141"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_145","exampleIds":["paths/~1api~1v2~1merch~1onboard~1notify/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","404","429","500"],"pointer":"/api/v2/merch/onboard/notify","href":"merchant-onboarding/notification_2","openApiOperationId":"notification_2","summary":"Merchant Onboarding Result (Notification)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.paykka.com"}],"schemaId":"schema_145","exampleIds":["paths/~1api~1v2~1merch~1onboard~1notify/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_145","exampleIds":["paths/~1api~1v2~1merch~1onboard~1notify/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_146"}},"schemaId":"schema_146","headers":{}},{"code":"400","description":"Bad Request","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}},{"code":"401","description":"Unauthorized","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}},{"code":"404","description":"Not Found","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}},{"code":"429","description":"Too Many Requests","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}},{"code":"500","description":"Internal Server Error","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}}],"pointer":"/paths/~1api~1v2~1merch~1onboard~1notify/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_146","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_146"}}},{"code":"400","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}},{"code":"401","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}},{"code":"404","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}},{"code":"429","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}},{"code":"500","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/merchant-onboarding/notification_2"}],"panels":[]}]},"httpPath":"/api/v2/merch/onboard/notify"}],"content":{"contentType":"group","meta":{"name":"Merchant Onboarding"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Merchant Onboarding","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v2/merch/onboard/apply","summary":"Merchant Onboarding Application","prefix":{"name":"post","color":"post"},"badges":[],"link":"/merchant-onboarding/apply_1","deprecated":false},{"title":"/api/v2/merch/onboard/update","summary":"Merchant Information Update","prefix":{"name":"post","color":"post"},"badges":[],"link":"/merchant-onboarding/update_1","deprecated":false},{"title":"/api/v2/merch/onboard/inquiry","summary":"Query Merchant Onboarding Result","prefix":{"name":"post","color":"post"},"badges":[],"link":"/merchant-onboarding/inquiry_2","deprecated":false},{"title":"/api/v2/merch/onboard/notify","summary":"Merchant Onboarding Result (Notification)","prefix":{"name":"post","color":"post"},"badges":[],"link":"/merchant-onboarding/notification_2","deprecated":false}]}]}]}]}},{"type":"group","label":"Collection Account","link":"/collection/apis/openapi/collection-account","routeSlug":"/collection/apis/openapi/collection-account","items":[{"label":"Apply for Collection Account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/collection/apis/openapi/collection-account/apply","routeSlug":"/collection/apis/openapi/collection-account/apply","metadata":{"seo":{"title":"Apply for Collection Account","description":"Collection account application"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"apply","name":"Apply for Collection Account","deprecated":false,"isWebhook":false,"pointer":"/paths/~1api~1v2~1merch~1va~1apply/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Apply for Collection Account","isWebhook":false,"deprecated":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Collection account application"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Merch-Id","in":"header","schemaId":"schema_141","description":"","example":"M24061911365700670"}],"pointer":"/paths/~1api~1v2~1merch~1va~1apply/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/MerchVaCreateV2Req","exampleIds":["paths/~1api~1v2~1merch~1va~1apply/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/MerchVaCreateV2Req","exampleIds":["paths/~1api~1v2~1merch~1va~1apply/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1api~1v2~1merch~1va~1apply/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v2/merch/va/apply","servers":[{"url":"https://api.paykka.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Merch-Id","in":"header","example":"M24061911365700670","schemaId":"schema_141"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/MerchVaCreateV2Req","exampleIds":["paths/~1api~1v2~1merch~1va~1apply/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","404","429","500"],"pointer":"/api/v2/merch/va/apply","href":"collection-account/apply","openApiOperationId":"apply","summary":"Apply for Collection Account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.paykka.com"}],"schemaId":"components/schemas/MerchVaCreateV2Req","exampleIds":["paths/~1api~1v2~1merch~1va~1apply/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/MerchVaCreateV2Req","exampleIds":["paths/~1api~1v2~1merch~1va~1apply/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_147"}},"schemaId":"schema_147","headers":{}},{"code":"400","description":"Bad Request","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}},{"code":"401","description":"Unauthorized","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}},{"code":"404","description":"Not Found","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}},{"code":"429","description":"Too Many Requests","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}},{"code":"500","description":"Internal Server Error","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}}],"pointer":"/paths/~1api~1v2~1merch~1va~1apply/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_147","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_147"}}},{"code":"400","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}},{"code":"401","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}},{"code":"404","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}},{"code":"429","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}},{"code":"500","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/collection-account/apply"}],"panels":[]}]},"httpPath":"/api/v2/merch/va/apply"},{"label":"Query Collection Account Application Result","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/collection/apis/openapi/collection-account/inquiry","routeSlug":"/collection/apis/openapi/collection-account/inquiry","metadata":{"seo":{"title":"Query Collection Account Application Result","description":"Query collection account application result"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"inquiry","name":"Query Collection Account Application Result","deprecated":false,"isWebhook":false,"pointer":"/paths/~1api~1v2~1merch~1va~1inquiry/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Query Collection Account Application Result","isWebhook":false,"deprecated":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Query collection account application result"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Merch-Id","in":"header","schemaId":"schema_141","description":"","example":"M24061911365700670"}],"pointer":"/paths/~1api~1v2~1merch~1va~1inquiry/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/MerchOnboardInquiryReq","exampleIds":["paths/~1api~1v2~1merch~1va~1inquiry/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/MerchOnboardInquiryReq","exampleIds":["paths/~1api~1v2~1merch~1va~1inquiry/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1api~1v2~1merch~1va~1inquiry/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v2/merch/va/inquiry","servers":[{"url":"https://api.paykka.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Merch-Id","in":"header","example":"M24061911365700670","schemaId":"schema_141"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/MerchOnboardInquiryReq","exampleIds":["paths/~1api~1v2~1merch~1va~1inquiry/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","404","429","500"],"pointer":"/api/v2/merch/va/inquiry","href":"collection-account/inquiry","openApiOperationId":"inquiry","summary":"Query Collection Account Application Result"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.paykka.com"}],"schemaId":"components/schemas/MerchOnboardInquiryReq","exampleIds":["paths/~1api~1v2~1merch~1va~1inquiry/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/MerchOnboardInquiryReq","exampleIds":["paths/~1api~1v2~1merch~1va~1inquiry/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_147"}},"schemaId":"schema_147","headers":{}},{"code":"400","description":"Bad Request","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}},{"code":"401","description":"Unauthorized","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}},{"code":"404","description":"Not Found","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}},{"code":"429","description":"Too Many Requests","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}},{"code":"500","description":"Internal Server Error","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}}],"pointer":"/paths/~1api~1v2~1merch~1va~1inquiry/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_147","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_147"}}},{"code":"400","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}},{"code":"401","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}},{"code":"404","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}},{"code":"429","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}},{"code":"500","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/collection-account/inquiry"}],"panels":[]}]},"httpPath":"/api/v2/merch/va/inquiry"},{"label":"Collection Account Application Result (Notification)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/collection/apis/openapi/collection-account/notification","routeSlug":"/collection/apis/openapi/collection-account/notification","metadata":{"seo":{"title":"Collection Account Application Result (Notification)","description":"Collection account application result notification"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"notification","name":"Collection Account Application Result (Notification)","deprecated":false,"isWebhook":false,"pointer":"/paths/~1api~1v2~1merch~1va~1notify/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Collection Account Application Result (Notification)","isWebhook":false,"deprecated":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Collection account application result notification"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Merch-Id","in":"header","schemaId":"schema_141","description":"","example":"M24061911365700670"}],"pointer":"/paths/~1api~1v2~1merch~1va~1notify/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_148","exampleIds":["paths/~1api~1v2~1merch~1va~1notify/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_148","exampleIds":["paths/~1api~1v2~1merch~1va~1notify/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1api~1v2~1merch~1va~1notify/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v2/merch/va/notify","servers":[{"url":"https://api.paykka.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Merch-Id","in":"header","example":"M24061911365700670","schemaId":"schema_141"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_148","exampleIds":["paths/~1api~1v2~1merch~1va~1notify/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","404","429","500"],"pointer":"/api/v2/merch/va/notify","href":"collection-account/notification","openApiOperationId":"notification","summary":"Collection Account Application Result (Notification)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.paykka.com"}],"schemaId":"schema_148","exampleIds":["paths/~1api~1v2~1merch~1va~1notify/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_148","exampleIds":["paths/~1api~1v2~1merch~1va~1notify/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_146"}},"schemaId":"schema_146","headers":{}},{"code":"400","description":"Bad Request","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}},{"code":"401","description":"Unauthorized","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}},{"code":"404","description":"Not Found","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}},{"code":"429","description":"Too Many Requests","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}},{"code":"500","description":"Internal Server Error","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}}],"pointer":"/paths/~1api~1v2~1merch~1va~1notify/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_146","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_146"}}},{"code":"400","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}},{"code":"401","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}},{"code":"404","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}},{"code":"429","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}},{"code":"500","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/collection-account/notification"}],"panels":[]}]},"httpPath":"/api/v2/merch/va/notify"}],"content":{"contentType":"group","meta":{"name":"Collection Account"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Collection Account","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v2/merch/va/apply","summary":"Apply for Collection Account","prefix":{"name":"post","color":"post"},"badges":[],"link":"/collection-account/apply","deprecated":false},{"title":"/api/v2/merch/va/inquiry","summary":"Query Collection Account Application Result","prefix":{"name":"post","color":"post"},"badges":[],"link":"/collection-account/inquiry","deprecated":false},{"title":"/api/v2/merch/va/notify","summary":"Collection Account Application Result (Notification)","prefix":{"name":"post","color":"post"},"badges":[],"link":"/collection-account/notification","deprecated":false}]}]}]}]}},{"type":"group","label":"Incoming Remittance","link":"/collection/apis/openapi/incoming-remittance","routeSlug":"/collection/apis/openapi/incoming-remittance","items":[{"label":"Incoming Remittance (Notification)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/collection/apis/openapi/incoming-remittance/notification_incoming_remittance","routeSlug":"/collection/apis/openapi/incoming-remittance/notification_incoming_remittance","metadata":{"seo":{"title":"Incoming Remittance (Notification)","description":"type=INCOMING_REMITTANCE"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"notification_incoming_remittance","name":"Incoming Remittance (Notification)","deprecated":false,"isWebhook":false,"pointer":"/paths/~1api~1v2~1remittance~1notify/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Incoming Remittance (Notification)","isWebhook":false,"deprecated":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type=INCOMING_REMITTANCE"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Merch-Id","in":"header","schemaId":"schema_141","description":"","example":"M24061911365700670"}],"pointer":"/paths/~1api~1v2~1remittance~1notify/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_149","exampleIds":["paths/~1api~1v2~1remittance~1notify/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_149","exampleIds":["paths/~1api~1v2~1remittance~1notify/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1api~1v2~1remittance~1notify/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v2/remittance/notify","servers":[{"url":"https://api.paykka.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Merch-Id","in":"header","example":"M24061911365700670","schemaId":"schema_141"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_149","exampleIds":["paths/~1api~1v2~1remittance~1notify/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","404","429","500"],"pointer":"/api/v2/remittance/notify","href":"incoming-remittance/notification_incoming_remittance","openApiOperationId":"notification_incoming_remittance","summary":"Incoming Remittance (Notification)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.paykka.com"}],"schemaId":"schema_149","exampleIds":["paths/~1api~1v2~1remittance~1notify/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_149","exampleIds":["paths/~1api~1v2~1remittance~1notify/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_146"}},"schemaId":"schema_146","headers":{}},{"code":"400","description":"Bad Request","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}},{"code":"401","description":"Unauthorized","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}},{"code":"404","description":"Not Found","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}},{"code":"429","description":"Too Many Requests","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}},{"code":"500","description":"Internal Server Error","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}}],"pointer":"/paths/~1api~1v2~1remittance~1notify/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_146","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_146"}}},{"code":"400","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}},{"code":"401","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}},{"code":"404","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}},{"code":"429","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}},{"code":"500","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/incoming-remittance/notification_incoming_remittance"}],"panels":[]}]},"httpPath":"/api/v2/remittance/notify"}],"content":{"contentType":"group","meta":{"name":"Incoming Remittance"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Incoming Remittance","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v2/remittance/notify","summary":"Incoming Remittance (Notification)","prefix":{"name":"post","color":"post"},"badges":[],"link":"/incoming-remittance/notification_incoming_remittance","deprecated":false}]}]}]}]}},{"type":"group","label":"Orders","link":"/collection/apis/openapi/orders","routeSlug":"/collection/apis/openapi/orders","items":[{"label":"Create Order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/collection/apis/openapi/orders/create_1","routeSlug":"/collection/apis/openapi/orders/create_1","metadata":{"seo":{"title":"Create Order","description":"Create Order"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create_1","name":"Create Order","deprecated":false,"isWebhook":false,"pointer":"/paths/~1api~1v2~1merch~1contract~1create/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Order","isWebhook":false,"deprecated":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Merch-Id","in":"header","schemaId":"schema_141","description":"","example":"M24061911365700670"}],"pointer":"/paths/~1api~1v2~1merch~1contract~1create/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_150","exampleIds":["paths/~1api~1v2~1merch~1contract~1create/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_150","exampleIds":["paths/~1api~1v2~1merch~1contract~1create/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1api~1v2~1merch~1contract~1create/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v2/merch/contract/create","servers":[{"url":"https://api.paykka.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Merch-Id","in":"header","example":"M24061911365700670","schemaId":"schema_141"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_150","exampleIds":["paths/~1api~1v2~1merch~1contract~1create/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","404","429","500"],"pointer":"/api/v2/merch/contract/create","href":"orders/create_1","openApiOperationId":"create_1","summary":"Create Order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.paykka.com"}],"schemaId":"schema_150","exampleIds":["paths/~1api~1v2~1merch~1contract~1create/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_150","exampleIds":["paths/~1api~1v2~1merch~1contract~1create/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/ContractOrderCreateRes"}},"schemaId":"components/schemas/ContractOrderCreateRes","headers":{}},{"code":"400","description":"Bad Request","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}},{"code":"401","description":"Unauthorized","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}},{"code":"404","description":"Not Found","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}},{"code":"429","description":"Too Many Requests","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}},{"code":"500","description":"Internal Server Error","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}}],"pointer":"/paths/~1api~1v2~1merch~1contract~1create/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ContractOrderCreateRes","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/ContractOrderCreateRes"}}},{"code":"400","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}},{"code":"401","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}},{"code":"404","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}},{"code":"429","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}},{"code":"500","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/create_1"}],"panels":[]}]},"httpPath":"/api/v2/merch/contract/create"},{"label":"Update Order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/collection/apis/openapi/orders/update_2","routeSlug":"/collection/apis/openapi/orders/update_2","metadata":{"seo":{"title":"Update Order","description":"request_id must match the one from order creation"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"update_2","name":"Update Order","deprecated":false,"isWebhook":false,"pointer":"/paths/~1api~1v2~1merch~1contract~1update/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Order","isWebhook":false,"deprecated":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"request_id must match the one from order creation"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Merch-Id","in":"header","schemaId":"schema_141","description":"","example":"M24061911365700670"}],"pointer":"/paths/~1api~1v2~1merch~1contract~1update/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_151","exampleIds":["paths/~1api~1v2~1merch~1contract~1update/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_151","exampleIds":["paths/~1api~1v2~1merch~1contract~1update/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1api~1v2~1merch~1contract~1update/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v2/merch/contract/update","servers":[{"url":"https://api.paykka.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Merch-Id","in":"header","example":"M24061911365700670","schemaId":"schema_141"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_151","exampleIds":["paths/~1api~1v2~1merch~1contract~1update/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","404","429","500"],"pointer":"/api/v2/merch/contract/update","href":"orders/update_2","openApiOperationId":"update_2","summary":"Update Order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.paykka.com"}],"schemaId":"schema_151","exampleIds":["paths/~1api~1v2~1merch~1contract~1update/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_151","exampleIds":["paths/~1api~1v2~1merch~1contract~1update/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/LogisticsSupplementRes"}},"schemaId":"components/schemas/LogisticsSupplementRes","headers":{}},{"code":"400","description":"Bad Request","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}},{"code":"401","description":"Unauthorized","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}},{"code":"404","description":"Not Found","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}},{"code":"429","description":"Too Many Requests","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}},{"code":"500","description":"Internal Server Error","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}}],"pointer":"/paths/~1api~1v2~1merch~1contract~1update/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/LogisticsSupplementRes","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/LogisticsSupplementRes"}}},{"code":"400","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}},{"code":"401","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}},{"code":"404","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}},{"code":"429","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}},{"code":"500","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/update_2"}],"panels":[]}]},"httpPath":"/api/v2/merch/contract/update"},{"label":"Query Order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/collection/apis/openapi/orders/inquiry_4","routeSlug":"/collection/apis/openapi/orders/inquiry_4","metadata":{"seo":{"title":"Query Order","description":"request_id must match the one from order creation"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"inquiry_4","name":"Query Order","deprecated":false,"isWebhook":false,"pointer":"/paths/~1api~1v2~1merch~1contract~1inquiry/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Query Order","isWebhook":false,"deprecated":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"request_id must match the one from order creation"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Merch-Id","in":"header","schemaId":"schema_141","description":"","example":"M24061911365700670"}],"pointer":"/paths/~1api~1v2~1merch~1contract~1inquiry/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/MerchOnboardInquiryReq","exampleIds":["paths/~1api~1v2~1merch~1contract~1inquiry/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/MerchOnboardInquiryReq","exampleIds":["paths/~1api~1v2~1merch~1contract~1inquiry/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1api~1v2~1merch~1contract~1inquiry/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v2/merch/contract/inquiry","servers":[{"url":"https://api.paykka.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Merch-Id","in":"header","example":"M24061911365700670","schemaId":"schema_141"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/MerchOnboardInquiryReq","exampleIds":["paths/~1api~1v2~1merch~1contract~1inquiry/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","404","429","500"],"pointer":"/api/v2/merch/contract/inquiry","href":"orders/inquiry_4","openApiOperationId":"inquiry_4","summary":"Query Order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.paykka.com"}],"schemaId":"components/schemas/MerchOnboardInquiryReq","exampleIds":["paths/~1api~1v2~1merch~1contract~1inquiry/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/MerchOnboardInquiryReq","exampleIds":["paths/~1api~1v2~1merch~1contract~1inquiry/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_152"}},"schemaId":"schema_152","headers":{}},{"code":"400","description":"Bad Request","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}},{"code":"401","description":"Unauthorized","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}},{"code":"404","description":"Not Found","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}},{"code":"429","description":"Too Many Requests","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}},{"code":"500","description":"Internal Server Error","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}}],"pointer":"/paths/~1api~1v2~1merch~1contract~1inquiry/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_152","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_152"}}},{"code":"400","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}},{"code":"401","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}},{"code":"404","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}},{"code":"429","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}},{"code":"500","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/inquiry_4"}],"panels":[]}]},"httpPath":"/api/v2/merch/contract/inquiry"},{"label":"Supplement Logistics (Shipping) Info","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/collection/apis/openapi/orders/supplement_1","routeSlug":"/collection/apis/openapi/orders/supplement_1","metadata":{"seo":{"title":"Supplement Logistics (Shipping) Info","description":"request_id must match the one from order creation"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"supplement_1","name":"Supplement Logistics (Shipping) Info","deprecated":false,"isWebhook":false,"pointer":"/paths/~1api~1v2~1merch~1contract~1logistics~1supplement/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Supplement Logistics (Shipping) Info","isWebhook":false,"deprecated":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"request_id must match the one from order creation"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Merch-Id","in":"header","schemaId":"schema_141","description":"","example":"M24061911365700670"}],"pointer":"/paths/~1api~1v2~1merch~1contract~1logistics~1supplement/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_153","exampleIds":["paths/~1api~1v2~1merch~1contract~1logistics~1supplement/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_153","exampleIds":["paths/~1api~1v2~1merch~1contract~1logistics~1supplement/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1api~1v2~1merch~1contract~1logistics~1supplement/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v2/merch/contract/logistics/supplement","servers":[{"url":"https://api.paykka.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Merch-Id","in":"header","example":"M24061911365700670","schemaId":"schema_141"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_153","exampleIds":["paths/~1api~1v2~1merch~1contract~1logistics~1supplement/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","404","429","500"],"pointer":"/api/v2/merch/contract/logistics/supplement","href":"orders/supplement_1","openApiOperationId":"supplement_1","summary":"Supplement Logistics (Shipping) Info"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.paykka.com"}],"schemaId":"schema_153","exampleIds":["paths/~1api~1v2~1merch~1contract~1logistics~1supplement/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_153","exampleIds":["paths/~1api~1v2~1merch~1contract~1logistics~1supplement/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/LogisticsSupplementRes"}},"schemaId":"components/schemas/LogisticsSupplementRes","headers":{}},{"code":"400","description":"Bad Request","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}},{"code":"401","description":"Unauthorized","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}},{"code":"404","description":"Not Found","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}},{"code":"429","description":"Too Many Requests","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}},{"code":"500","description":"Internal Server Error","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}}],"pointer":"/paths/~1api~1v2~1merch~1contract~1logistics~1supplement/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/LogisticsSupplementRes","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/LogisticsSupplementRes"}}},{"code":"400","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}},{"code":"401","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}},{"code":"404","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}},{"code":"429","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}},{"code":"500","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/supplement_1"}],"panels":[]}]},"httpPath":"/api/v2/merch/contract/logistics/supplement"}],"content":{"contentType":"group","meta":{"name":"Orders"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Orders","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v2/merch/contract/create","summary":"Create Order","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orders/create_1","deprecated":false},{"title":"/api/v2/merch/contract/update","summary":"Update Order","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orders/update_2","deprecated":false},{"title":"/api/v2/merch/contract/inquiry","summary":"Query Order","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orders/inquiry_4","deprecated":false},{"title":"/api/v2/merch/contract/logistics/supplement","summary":"Supplement Logistics (Shipping) Info","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orders/supplement_1","deprecated":false}]}]}]}]}},{"type":"group","label":"Settlement","link":"/collection/apis/openapi/settlement","routeSlug":"/collection/apis/openapi/settlement","items":[{"label":"Create Settlement Process","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/collection/apis/openapi/settlement/relate_1","routeSlug":"/collection/apis/openapi/settlement/relate_1","metadata":{"seo":{"title":"Create Settlement Process","description":"Application allowed when collection order status is [PENDING_RELATE|CHECK_REJECTED]"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"relate_1","name":"Create Settlement Process","deprecated":false,"isWebhook":false,"pointer":"/paths/~1api~1v2~1trade-settle~1apply/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Settlement Process","isWebhook":false,"deprecated":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application allowed when collection order status is [PENDING_RELATE|CHECK_REJECTED]"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Merch-Id","in":"header","schemaId":"schema_154","description":"","required":true,"example":""}],"pointer":"/paths/~1api~1v2~1trade-settle~1apply/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TradeSettleApplyReq","exampleIds":["paths/~1api~1v2~1trade-settle~1apply/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/TradeSettleApplyReq","exampleIds":["paths/~1api~1v2~1trade-settle~1apply/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1api~1v2~1trade-settle~1apply/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v2/trade-settle/apply","servers":[{"url":"https://api.paykka.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Merch-Id","in":"header","required":true,"example":"","schemaId":"schema_154"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/TradeSettleApplyReq","exampleIds":["paths/~1api~1v2~1trade-settle~1apply/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","404","429","500"],"pointer":"/api/v2/trade-settle/apply","href":"settlement/relate_1","openApiOperationId":"relate_1","summary":"Create Settlement Process"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.paykka.com"}],"schemaId":"components/schemas/TradeSettleApplyReq","exampleIds":["paths/~1api~1v2~1trade-settle~1apply/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TradeSettleApplyReq","exampleIds":["paths/~1api~1v2~1trade-settle~1apply/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/TradeSettleApplyRes"}},"schemaId":"components/schemas/TradeSettleApplyRes","headers":{}},{"code":"400","description":"Bad Request","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}},{"code":"401","description":"Unauthorized","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}},{"code":"404","description":"Not Found","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}},{"code":"429","description":"Too Many Requests","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}},{"code":"500","description":"Internal Server Error","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}}],"pointer":"/paths/~1api~1v2~1trade-settle~1apply/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TradeSettleApplyRes","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/TradeSettleApplyRes"}}},{"code":"400","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}},{"code":"401","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}},{"code":"404","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}},{"code":"429","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}},{"code":"500","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/settlement/relate_1"}],"panels":[]}]},"httpPath":"/api/v2/trade-settle/apply"},{"label":"Query Settlement Status","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/collection/apis/openapi/settlement/inquiry_6","routeSlug":"/collection/apis/openapi/settlement/inquiry_6","metadata":{"seo":{"title":"Query Settlement Status","description":"Query Settlement Status"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"inquiry_6","name":"Query Settlement Status","deprecated":false,"isWebhook":false,"pointer":"/paths/~1api~1v2~1trade-settle~1inquiry/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Query Settlement Status","isWebhook":false,"deprecated":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Merch-Id","in":"header","schemaId":"schema_154","description":"","required":true,"example":""}],"pointer":"/paths/~1api~1v2~1trade-settle~1inquiry/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TradeSettleInquiryReq","exampleIds":["paths/~1api~1v2~1trade-settle~1inquiry/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/TradeSettleInquiryReq","exampleIds":["paths/~1api~1v2~1trade-settle~1inquiry/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1api~1v2~1trade-settle~1inquiry/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v2/trade-settle/inquiry","servers":[{"url":"https://api.paykka.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Merch-Id","in":"header","required":true,"example":"","schemaId":"schema_154"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/TradeSettleInquiryReq","exampleIds":["paths/~1api~1v2~1trade-settle~1inquiry/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","404","429","500"],"pointer":"/api/v2/trade-settle/inquiry","href":"settlement/inquiry_6","openApiOperationId":"inquiry_6","summary":"Query Settlement Status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.paykka.com"}],"schemaId":"components/schemas/TradeSettleInquiryReq","exampleIds":["paths/~1api~1v2~1trade-settle~1inquiry/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TradeSettleInquiryReq","exampleIds":["paths/~1api~1v2~1trade-settle~1inquiry/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/TradeSettleInquiryRes"}},"schemaId":"components/schemas/TradeSettleInquiryRes","headers":{}},{"code":"400","description":"Bad Request","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}},{"code":"401","description":"Unauthorized","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}},{"code":"404","description":"Not Found","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}},{"code":"429","description":"Too Many Requests","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}},{"code":"500","description":"Internal Server Error","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}}],"pointer":"/paths/~1api~1v2~1trade-settle~1inquiry/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TradeSettleInquiryRes","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/TradeSettleInquiryRes"}}},{"code":"400","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}},{"code":"401","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}},{"code":"404","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}},{"code":"429","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}},{"code":"500","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/settlement/inquiry_6"}],"panels":[]}]},"httpPath":"/api/v2/trade-settle/inquiry"},{"label":"Settlement Result (Notification)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/collection/apis/openapi/settlement/notification_5","routeSlug":"/collection/apis/openapi/settlement/notification_5","metadata":{"seo":{"title":"Settlement Result (Notification)","description":"Settlement result notification"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"notification_5","name":"Settlement Result (Notification)","deprecated":false,"isWebhook":false,"pointer":"/paths/~1api~1v2~1trade-settle~1notify/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Settlement Result (Notification)","isWebhook":false,"deprecated":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Settlement result notification"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Merch-Id","in":"header","schemaId":"schema_141","description":"","example":"M24061911365700670"}],"pointer":"/paths/~1api~1v2~1trade-settle~1notify/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_155","exampleIds":["paths/~1api~1v2~1trade-settle~1notify/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_155","exampleIds":["paths/~1api~1v2~1trade-settle~1notify/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1api~1v2~1trade-settle~1notify/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v2/trade-settle/notify","servers":[{"url":"https://api.paykka.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Merch-Id","in":"header","example":"M24061911365700670","schemaId":"schema_141"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_155","exampleIds":["paths/~1api~1v2~1trade-settle~1notify/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","404","429","500"],"pointer":"/api/v2/trade-settle/notify","href":"settlement/notification_5","openApiOperationId":"notification_5","summary":"Settlement Result (Notification)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.paykka.com"}],"schemaId":"schema_155","exampleIds":["paths/~1api~1v2~1trade-settle~1notify/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_155","exampleIds":["paths/~1api~1v2~1trade-settle~1notify/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_146"}},"schemaId":"schema_146","headers":{}},{"code":"400","description":"Bad Request","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}},{"code":"401","description":"Unauthorized","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}},{"code":"404","description":"Not Found","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}},{"code":"429","description":"Too Many Requests","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}},{"code":"500","description":"Internal Server Error","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}}],"pointer":"/paths/~1api~1v2~1trade-settle~1notify/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_146","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_146"}}},{"code":"400","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}},{"code":"401","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}},{"code":"404","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}},{"code":"429","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}},{"code":"500","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/settlement/notification_5"}],"panels":[]}]},"httpPath":"/api/v2/trade-settle/notify"}],"content":{"contentType":"group","meta":{"name":"Settlement"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Settlement","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v2/trade-settle/apply","summary":"Create Settlement Process","prefix":{"name":"post","color":"post"},"badges":[],"link":"/settlement/relate_1","deprecated":false},{"title":"/api/v2/trade-settle/inquiry","summary":"Query Settlement Status","prefix":{"name":"post","color":"post"},"badges":[],"link":"/settlement/inquiry_6","deprecated":false},{"title":"/api/v2/trade-settle/notify","summary":"Settlement Result (Notification)","prefix":{"name":"post","color":"post"},"badges":[],"link":"/settlement/notification_5","deprecated":false}]}]}]}]}},{"type":"group","label":"Account Balance","link":"/collection/apis/openapi/account-balance","routeSlug":"/collection/apis/openapi/account-balance","items":[{"label":"Query Account Balance","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/collection/apis/openapi/account-balance/query","routeSlug":"/collection/apis/openapi/account-balance/query","metadata":{"seo":{"title":"Query Account Balance","description":"If currency is not specified, all currencies will be returned"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"query","name":"Query Account Balance","deprecated":false,"isWebhook":false,"pointer":"/paths/~1api~1v2~1merch~1balance/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Query Account Balance","isWebhook":false,"deprecated":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"If currency is not specified, all currencies will be returned"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Merch-Id","in":"header","schemaId":"schema_154","description":"","required":true,"example":""}],"pointer":"/paths/~1api~1v2~1merch~1balance/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_156","exampleIds":["paths/~1api~1v2~1merch~1balance/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_156","exampleIds":["paths/~1api~1v2~1merch~1balance/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1api~1v2~1merch~1balance/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v2/merch/balance","servers":[{"url":"https://api.paykka.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Merch-Id","in":"header","required":true,"example":"","schemaId":"schema_154"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_156","exampleIds":["paths/~1api~1v2~1merch~1balance/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","404","429","500"],"pointer":"/api/v2/merch/balance","href":"account-balance/query","openApiOperationId":"query","summary":"Query Account Balance"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.paykka.com"}],"schemaId":"schema_156","exampleIds":["paths/~1api~1v2~1merch~1balance/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_156","exampleIds":["paths/~1api~1v2~1merch~1balance/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/AccountBalanceRes"}},"schemaId":"components/schemas/AccountBalanceRes","headers":{}},{"code":"400","description":"Bad Request","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}},{"code":"401","description":"Unauthorized","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}},{"code":"404","description":"Not Found","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}},{"code":"429","description":"Too Many Requests","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}},{"code":"500","description":"Internal Server Error","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}}],"pointer":"/paths/~1api~1v2~1merch~1balance/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AccountBalanceRes","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/AccountBalanceRes"}}},{"code":"400","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}},{"code":"401","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}},{"code":"404","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}},{"code":"429","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}},{"code":"500","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account-balance/query"}],"panels":[]}]},"httpPath":"/api/v2/merch/balance"}],"content":{"contentType":"group","meta":{"name":"Account Balance"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Account Balance","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v2/merch/balance","summary":"Query Account Balance","prefix":{"name":"post","color":"post"},"badges":[],"link":"/account-balance/query","deprecated":false}]}]}]}]}},{"type":"group","label":"Payee","link":"/collection/apis/openapi/payee","routeSlug":"/collection/apis/openapi/payee","items":[{"label":"Create Payee","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/collection/apis/openapi/payee/create","routeSlug":"/collection/apis/openapi/payee/create","metadata":{"seo":{"title":"Create Payee","description":"Create payee information"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create","name":"Create Payee","deprecated":false,"isWebhook":false,"pointer":"/paths/~1api~1v2~1merch~1beneficiary~1create/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Payee","isWebhook":false,"deprecated":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create payee information"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Merch-Id","in":"header","schemaId":"schema_141","description":"","example":"M24061911365700670"}],"pointer":"/paths/~1api~1v2~1merch~1beneficiary~1create/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_157","exampleIds":["paths/~1api~1v2~1merch~1beneficiary~1create/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_157","exampleIds":["paths/~1api~1v2~1merch~1beneficiary~1create/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1api~1v2~1merch~1beneficiary~1create/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v2/merch/beneficiary/create","servers":[{"url":"https://api.paykka.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Merch-Id","in":"header","example":"M24061911365700670","schemaId":"schema_141"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_157","exampleIds":["paths/~1api~1v2~1merch~1beneficiary~1create/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","404","429","500"],"pointer":"/api/v2/merch/beneficiary/create","href":"payee/create","openApiOperationId":"create","summary":"Create Payee"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.paykka.com"}],"schemaId":"schema_157","exampleIds":["paths/~1api~1v2~1merch~1beneficiary~1create/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_157","exampleIds":["paths/~1api~1v2~1merch~1beneficiary~1create/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/PayeeRes"}},"schemaId":"components/schemas/PayeeRes","headers":{}},{"code":"400","description":"Bad Request","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}},{"code":"401","description":"Unauthorized","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}},{"code":"404","description":"Not Found","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}},{"code":"429","description":"Too Many Requests","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}},{"code":"500","description":"Internal Server Error","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}}],"pointer":"/paths/~1api~1v2~1merch~1beneficiary~1create/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PayeeRes","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/PayeeRes"}}},{"code":"400","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}},{"code":"401","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}},{"code":"404","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}},{"code":"429","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}},{"code":"500","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payee/create"}],"panels":[]}]},"httpPath":"/api/v2/merch/beneficiary/create"},{"label":"Modify Payee (for updating rejected payee info)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/collection/apis/openapi/payee/update","routeSlug":"/collection/apis/openapi/payee/update","metadata":{"seo":{"title":"Modify Payee (for updating rejected payee info)","description":"Modify payee information"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"update","name":"Modify Payee (for updating rejected payee info)","deprecated":false,"isWebhook":false,"pointer":"/paths/~1api~1v2~1merch~1beneficiary~1update/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Modify Payee (for updating rejected payee info)","isWebhook":false,"deprecated":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Modify payee information"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Merch-Id","in":"header","schemaId":"schema_141","description":"","example":"M24061911365700670"}],"pointer":"/paths/~1api~1v2~1merch~1beneficiary~1update/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_158","exampleIds":["paths/~1api~1v2~1merch~1beneficiary~1update/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_158","exampleIds":["paths/~1api~1v2~1merch~1beneficiary~1update/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1api~1v2~1merch~1beneficiary~1update/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v2/merch/beneficiary/update","servers":[{"url":"https://api.paykka.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Merch-Id","in":"header","example":"M24061911365700670","schemaId":"schema_141"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_158","exampleIds":["paths/~1api~1v2~1merch~1beneficiary~1update/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","404","429","500"],"pointer":"/api/v2/merch/beneficiary/update","href":"payee/update","openApiOperationId":"update","summary":"Modify Payee (for updating rejected payee info)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.paykka.com"}],"schemaId":"schema_158","exampleIds":["paths/~1api~1v2~1merch~1beneficiary~1update/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_158","exampleIds":["paths/~1api~1v2~1merch~1beneficiary~1update/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/PayeeRes"}},"schemaId":"components/schemas/PayeeRes","headers":{}},{"code":"400","description":"Bad Request","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}},{"code":"401","description":"Unauthorized","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}},{"code":"404","description":"Not Found","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}},{"code":"429","description":"Too Many Requests","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}},{"code":"500","description":"Internal Server Error","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}}],"pointer":"/paths/~1api~1v2~1merch~1beneficiary~1update/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PayeeRes","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/PayeeRes"}}},{"code":"400","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}},{"code":"401","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}},{"code":"404","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}},{"code":"429","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}},{"code":"500","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payee/update"}],"panels":[]}]},"httpPath":"/api/v2/merch/beneficiary/update"},{"label":"Query Payee Creation Result","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/collection/apis/openapi/payee/inquiry_1","routeSlug":"/collection/apis/openapi/payee/inquiry_1","metadata":{"seo":{"title":"Query Payee Creation Result","description":"Query payee status"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"inquiry_1","name":"Query Payee Creation Result","deprecated":false,"isWebhook":false,"pointer":"/paths/~1api~1v2~1merch~1beneficiary~1inquiry/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Query Payee Creation Result","isWebhook":false,"deprecated":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Query payee status"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Merch-Id","in":"header","schemaId":"schema_141","description":"","example":"M24061911365700670"}],"pointer":"/paths/~1api~1v2~1merch~1beneficiary~1inquiry/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PayeeInquiryV2Req","exampleIds":["paths/~1api~1v2~1merch~1beneficiary~1inquiry/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/PayeeInquiryV2Req","exampleIds":["paths/~1api~1v2~1merch~1beneficiary~1inquiry/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1api~1v2~1merch~1beneficiary~1inquiry/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v2/merch/beneficiary/inquiry","servers":[{"url":"https://api.paykka.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Merch-Id","in":"header","example":"M24061911365700670","schemaId":"schema_141"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/PayeeInquiryV2Req","exampleIds":["paths/~1api~1v2~1merch~1beneficiary~1inquiry/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","404","429","500"],"pointer":"/api/v2/merch/beneficiary/inquiry","href":"payee/inquiry_1","openApiOperationId":"inquiry_1","summary":"Query Payee Creation Result"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.paykka.com"}],"schemaId":"components/schemas/PayeeInquiryV2Req","exampleIds":["paths/~1api~1v2~1merch~1beneficiary~1inquiry/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PayeeInquiryV2Req","exampleIds":["paths/~1api~1v2~1merch~1beneficiary~1inquiry/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/PayeeRes"}},"schemaId":"components/schemas/PayeeRes","headers":{}},{"code":"400","description":"Bad Request","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}},{"code":"401","description":"Unauthorized","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}},{"code":"404","description":"Not Found","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}},{"code":"429","description":"Too Many Requests","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}},{"code":"500","description":"Internal Server Error","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}}],"pointer":"/paths/~1api~1v2~1merch~1beneficiary~1inquiry/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PayeeRes","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/PayeeRes"}}},{"code":"400","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}},{"code":"401","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}},{"code":"404","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}},{"code":"429","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}},{"code":"500","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payee/inquiry_1"}],"panels":[]}]},"httpPath":"/api/v2/merch/beneficiary/inquiry"},{"label":"Payee Creation Result (Notification)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/collection/apis/openapi/payee/notification_beneficiary","routeSlug":"/collection/apis/openapi/payee/notification_beneficiary","metadata":{"seo":{"title":"Payee Creation Result (Notification)","description":"Payee creation result notification"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"notification_beneficiary","name":"Payee Creation Result (Notification)","deprecated":false,"isWebhook":false,"pointer":"/paths/~1api~1v2~1merch~1beneficiary~1notify/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Payee Creation Result (Notification)","isWebhook":false,"deprecated":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Payee creation result notification"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Merch-Id","in":"header","schemaId":"schema_141","description":"","example":"M24061911365700670"}],"pointer":"/paths/~1api~1v2~1merch~1beneficiary~1notify/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_159","exampleIds":["paths/~1api~1v2~1merch~1beneficiary~1notify/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_159","exampleIds":["paths/~1api~1v2~1merch~1beneficiary~1notify/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1api~1v2~1merch~1beneficiary~1notify/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v2/merch/beneficiary/notify","servers":[{"url":"https://api.paykka.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Merch-Id","in":"header","example":"M24061911365700670","schemaId":"schema_141"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_159","exampleIds":["paths/~1api~1v2~1merch~1beneficiary~1notify/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","404","429","500"],"pointer":"/api/v2/merch/beneficiary/notify","href":"payee/notification_beneficiary","openApiOperationId":"notification_beneficiary","summary":"Payee Creation Result (Notification)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.paykka.com"}],"schemaId":"schema_159","exampleIds":["paths/~1api~1v2~1merch~1beneficiary~1notify/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_159","exampleIds":["paths/~1api~1v2~1merch~1beneficiary~1notify/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_146"}},"schemaId":"schema_146","headers":{}},{"code":"400","description":"Bad Request","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}},{"code":"401","description":"Unauthorized","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}},{"code":"404","description":"Not Found","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}},{"code":"429","description":"Too Many Requests","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}},{"code":"500","description":"Internal Server Error","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}}],"pointer":"/paths/~1api~1v2~1merch~1beneficiary~1notify/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_146","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_146"}}},{"code":"400","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}},{"code":"401","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}},{"code":"404","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}},{"code":"429","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}},{"code":"500","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payee/notification_beneficiary"}],"panels":[]}]},"httpPath":"/api/v2/merch/beneficiary/notify"}],"content":{"contentType":"group","meta":{"name":"Payee"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Payee","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v2/merch/beneficiary/create","summary":"Create Payee","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payee/create","deprecated":false},{"title":"/api/v2/merch/beneficiary/update","summary":"Modify Payee (for updating rejected payee info)","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payee/update","deprecated":false},{"title":"/api/v2/merch/beneficiary/inquiry","summary":"Query Payee Creation Result","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payee/inquiry_1","deprecated":false},{"title":"/api/v2/merch/beneficiary/notify","summary":"Payee Creation Result (Notification)","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payee/notification_beneficiary","deprecated":false}]}]}]}]}},{"type":"group","label":"Foreign Exchange","link":"/collection/apis/openapi/foreign-exchange","routeSlug":"/collection/apis/openapi/foreign-exchange","items":[{"label":"FX Pre-order (Quotation)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/collection/apis/openapi/foreign-exchange/fx_preorder","routeSlug":"/collection/apis/openapi/foreign-exchange/fx_preorder","metadata":{"seo":{"title":"FX Pre-order (Quotation)","description":"Only one of sell or buy amount may be specified"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"fx_preorder","name":"FX Pre-order (Quotation)","deprecated":false,"isWebhook":false,"pointer":"/paths/~1api~1v2~1fx~1conversion~1preorder/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"FX Pre-order (Quotation)","isWebhook":false,"deprecated":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Only one of sell or buy amount may be specified"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Merch-Id","in":"header","schemaId":"schema_141","description":"","example":"M24061911365700670"}],"pointer":"/paths/~1api~1v2~1fx~1conversion~1preorder/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_160"}},"schemaId":"schema_160","pointer":"/paths/~1api~1v2~1fx~1conversion~1preorder/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v2/fx/conversion/preorder","servers":[{"url":"https://api.paykka.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Merch-Id","in":"header","example":"M24061911365700670","schemaId":"schema_141"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_160"}},"responseCodes":["200"],"pointer":"/api/v2/fx/conversion/preorder","href":"foreign-exchange/fx_preorder","openApiOperationId":"fx_preorder","summary":"FX Pre-order (Quotation)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.paykka.com"}],"schemaId":"schema_160","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_160"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_161"}},"schemaId":"schema_161","headers":{}}],"pointer":"/paths/~1api~1v2~1fx~1conversion~1preorder/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_161","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_161"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/foreign-exchange/fx_preorder"}],"panels":[]}]},"httpPath":"/api/v2/fx/conversion/preorder"},{"label":"FX Confirmation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/collection/apis/openapi/foreign-exchange/fx_confirm","routeSlug":"/collection/apis/openapi/foreign-exchange/fx_confirm","metadata":{"seo":{"title":"FX Confirmation","description":"FX Confirmation"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"fx_confirm","name":"FX Confirmation","deprecated":false,"isWebhook":false,"pointer":"/paths/~1api~1v2~1fx~1conversion~1confirm/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"FX Confirmation","isWebhook":false,"deprecated":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Merch-Id","in":"header","schemaId":"schema_141","description":"","example":"M24061911365700670"}],"pointer":"/paths/~1api~1v2~1fx~1conversion~1confirm/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_162"}},"schemaId":"schema_162","pointer":"/paths/~1api~1v2~1fx~1conversion~1confirm/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v2/fx/conversion/confirm","servers":[{"url":"https://api.paykka.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Merch-Id","in":"header","example":"M24061911365700670","schemaId":"schema_141"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_162"}},"responseCodes":["200"],"pointer":"/api/v2/fx/conversion/confirm","href":"foreign-exchange/fx_confirm","openApiOperationId":"fx_confirm","summary":"FX Confirmation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.paykka.com"}],"schemaId":"schema_162","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_162"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_163"}},"schemaId":"schema_163","headers":{}}],"pointer":"/paths/~1api~1v2~1fx~1conversion~1confirm/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_163","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_163"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/foreign-exchange/fx_confirm"}],"panels":[]}]},"httpPath":"/api/v2/fx/conversion/confirm"},{"label":"Query FX Result","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/collection/apis/openapi/foreign-exchange/fx_inquiry","routeSlug":"/collection/apis/openapi/foreign-exchange/fx_inquiry","metadata":{"seo":{"title":"Query FX Result","description":"Query FX Result"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"fx_inquiry","name":"Query FX Result","deprecated":false,"isWebhook":false,"pointer":"/paths/~1api~1v2~1fx~1conversion~1inquiry/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Query FX Result","isWebhook":false,"deprecated":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Merch-Id","in":"header","schemaId":"schema_141","description":"","example":"M24061911365700670"}],"pointer":"/paths/~1api~1v2~1fx~1conversion~1inquiry/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_164"}},"schemaId":"schema_164","pointer":"/paths/~1api~1v2~1fx~1conversion~1inquiry/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v2/fx/conversion/inquiry","servers":[{"url":"https://api.paykka.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Merch-Id","in":"header","example":"M24061911365700670","schemaId":"schema_141"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_164"}},"responseCodes":["200"],"pointer":"/api/v2/fx/conversion/inquiry","href":"foreign-exchange/fx_inquiry","openApiOperationId":"fx_inquiry","summary":"Query FX Result"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.paykka.com"}],"schemaId":"schema_164","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_164"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_165"}},"schemaId":"schema_165","headers":{}}],"pointer":"/paths/~1api~1v2~1fx~1conversion~1inquiry/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_165","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_165"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/foreign-exchange/fx_inquiry"}],"panels":[]}]},"httpPath":"/api/v2/fx/conversion/inquiry"},{"label":"FX Result Notification","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/collection/apis/openapi/foreign-exchange/fx_notify","routeSlug":"/collection/apis/openapi/foreign-exchange/fx_notify","metadata":{"seo":{"title":"FX Result Notification","description":"FX Result Notification"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"fx_notify","name":"FX Result Notification","deprecated":false,"isWebhook":false,"pointer":"/paths/~1api~1v2~1fx~1conversion~1notify/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"FX Result Notification","isWebhook":false,"deprecated":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Merch-Id","in":"header","schemaId":"schema_141","description":"","example":"M24061911365700670"}],"pointer":"/paths/~1api~1v2~1fx~1conversion~1notify/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_166","exampleIds":["paths/~1api~1v2~1fx~1conversion~1notify/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_166","exampleIds":["paths/~1api~1v2~1fx~1conversion~1notify/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1api~1v2~1fx~1conversion~1notify/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v2/fx/conversion/notify","servers":[{"url":"https://api.paykka.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Merch-Id","in":"header","example":"M24061911365700670","schemaId":"schema_141"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_166","exampleIds":["paths/~1api~1v2~1fx~1conversion~1notify/post/requestBody/content/application~1json/example"]}},"responseCodes":["200"],"pointer":"/api/v2/fx/conversion/notify","href":"foreign-exchange/fx_notify","openApiOperationId":"fx_notify","summary":"FX Result Notification"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.paykka.com"}],"schemaId":"schema_166","exampleIds":["paths/~1api~1v2~1fx~1conversion~1notify/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_166","exampleIds":["paths/~1api~1v2~1fx~1conversion~1notify/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/octet-stream","mediaTypes":["application/octet-stream"],"mediaTypeContent":{"application/octet-stream":{"schemaId":"schema_165"}},"schemaId":"schema_165","headers":{}}],"pointer":"/paths/~1api~1v2~1fx~1conversion~1notify/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_165","mediaTypes":["application/octet-stream"],"mediaTypeContent":{"application/octet-stream":{"schemaId":"schema_165"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/foreign-exchange/fx_notify"}],"panels":[]}]},"httpPath":"/api/v2/fx/conversion/notify"}],"content":{"contentType":"group","meta":{"name":"Foreign Exchange"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Foreign Exchange","showPageActions":true},{"nodeType":"markdoc","content":"Foreign exchange related APIs"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v2/fx/conversion/preorder","summary":"FX Pre-order (Quotation)","prefix":{"name":"post","color":"post"},"badges":[],"link":"/foreign-exchange/fx_preorder","deprecated":false},{"title":"/api/v2/fx/conversion/confirm","summary":"FX Confirmation","prefix":{"name":"post","color":"post"},"badges":[],"link":"/foreign-exchange/fx_confirm","deprecated":false},{"title":"/api/v2/fx/conversion/inquiry","summary":"Query FX Result","prefix":{"name":"post","color":"post"},"badges":[],"link":"/foreign-exchange/fx_inquiry","deprecated":false},{"title":"/api/v2/fx/conversion/notify","summary":"FX Result Notification","prefix":{"name":"post","color":"post"},"badges":[],"link":"/foreign-exchange/fx_notify","deprecated":false}]}]}]}]}},{"type":"group","label":"Payment","link":"/collection/apis/openapi/payment","routeSlug":"/collection/apis/openapi/payment","items":[{"label":"Payment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/collection/apis/openapi/payment/inquiry_3","routeSlug":"/collection/apis/openapi/payment/inquiry_3","metadata":{"seo":{"title":"Payment","description":"Only same-currency payments are supported: the payment currency must match the payee currency"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"inquiry_3","name":"Payment","deprecated":false,"isWebhook":false,"pointer":"/paths/~1api~1v2~1merch~1pay~1apply/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Payment","isWebhook":false,"deprecated":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Only same-currency payments are supported: the payment currency must match the payee currency"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Merch-Id","in":"header","schemaId":"schema_141","description":"","example":"M24061911365700670"}],"pointer":"/paths/~1api~1v2~1merch~1pay~1apply/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_167","exampleIds":["paths/~1api~1v2~1merch~1pay~1apply/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_167","exampleIds":["paths/~1api~1v2~1merch~1pay~1apply/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1api~1v2~1merch~1pay~1apply/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v2/merch/pay/apply","servers":[{"url":"https://api.paykka.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Merch-Id","in":"header","example":"M24061911365700670","schemaId":"schema_141"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_167","exampleIds":["paths/~1api~1v2~1merch~1pay~1apply/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","404","429","500"],"pointer":"/api/v2/merch/pay/apply","href":"payment/inquiry_3","openApiOperationId":"inquiry_3","summary":"Payment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.paykka.com"}],"schemaId":"schema_167","exampleIds":["paths/~1api~1v2~1merch~1pay~1apply/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_167","exampleIds":["paths/~1api~1v2~1merch~1pay~1apply/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_168"}},"schemaId":"schema_168","headers":{}},{"code":"400","description":"Bad Request","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}},{"code":"401","description":"Unauthorized","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}},{"code":"404","description":"Not Found","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}},{"code":"429","description":"Too Many Requests","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}},{"code":"500","description":"Internal Server Error","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}}],"pointer":"/paths/~1api~1v2~1merch~1pay~1apply/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_168","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_168"}}},{"code":"400","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}},{"code":"401","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}},{"code":"404","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}},{"code":"429","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}},{"code":"500","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment/inquiry_3"}],"panels":[]}]},"httpPath":"/api/v2/merch/pay/apply"},{"label":"Query Payment Status","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/collection/apis/openapi/payment/status_inquiry","routeSlug":"/collection/apis/openapi/payment/status_inquiry","metadata":{"seo":{"title":"Query Payment Status","description":"Query payment/payout confirmation result status"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"status_inquiry","name":"Query Payment Status","deprecated":false,"isWebhook":false,"pointer":"/paths/~1api~1v2~1merch~1pay~1inquiry/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Query Payment Status","isWebhook":false,"deprecated":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Query payment/payout confirmation result status"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Merch-Id","in":"header","schemaId":"schema_141","description":"","example":"M24061911365700670"}],"pointer":"/paths/~1api~1v2~1merch~1pay~1inquiry/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/MerchOnboardInquiryReq","exampleIds":["paths/~1api~1v2~1merch~1pay~1inquiry/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/MerchOnboardInquiryReq","exampleIds":["paths/~1api~1v2~1merch~1pay~1inquiry/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1api~1v2~1merch~1pay~1inquiry/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v2/merch/pay/inquiry","servers":[{"url":"https://api.paykka.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Merch-Id","in":"header","example":"M24061911365700670","schemaId":"schema_141"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/MerchOnboardInquiryReq","exampleIds":["paths/~1api~1v2~1merch~1pay~1inquiry/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","404","429","500"],"pointer":"/api/v2/merch/pay/inquiry","href":"payment/status_inquiry","openApiOperationId":"status_inquiry","summary":"Query Payment Status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.paykka.com"}],"schemaId":"components/schemas/MerchOnboardInquiryReq","exampleIds":["paths/~1api~1v2~1merch~1pay~1inquiry/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/MerchOnboardInquiryReq","exampleIds":["paths/~1api~1v2~1merch~1pay~1inquiry/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_169"}},"schemaId":"schema_169","headers":{}},{"code":"400","description":"Bad Request","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}},{"code":"401","description":"Unauthorized","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}},{"code":"404","description":"Not Found","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}},{"code":"429","description":"Too Many Requests","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}},{"code":"500","description":"Internal Server Error","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}}],"pointer":"/paths/~1api~1v2~1merch~1pay~1inquiry/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_169","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_169"}}},{"code":"400","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}},{"code":"401","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}},{"code":"404","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}},{"code":"429","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}},{"code":"500","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment/status_inquiry"}],"panels":[]}]},"httpPath":"/api/v2/merch/pay/inquiry"},{"label":"Payment Result Notification","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/collection/apis/openapi/payment/status_payment","routeSlug":"/collection/apis/openapi/payment/status_payment","metadata":{"seo":{"title":"Payment Result Notification","description":"Payment result notification"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"status_payment","name":"Payment Result Notification","deprecated":false,"isWebhook":false,"pointer":"/paths/~1api~1v2~1merch~1pay~1notify/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Payment Result Notification","isWebhook":false,"deprecated":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Payment result notification"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Merch-Id","in":"header","schemaId":"schema_141","description":"","example":"M24061911365700670"}],"pointer":"/paths/~1api~1v2~1merch~1pay~1notify/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_170","exampleIds":["paths/~1api~1v2~1merch~1pay~1notify/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_170","exampleIds":["paths/~1api~1v2~1merch~1pay~1notify/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1api~1v2~1merch~1pay~1notify/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v2/merch/pay/notify","servers":[{"url":"https://api.paykka.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Merch-Id","in":"header","example":"M24061911365700670","schemaId":"schema_141"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_170","exampleIds":["paths/~1api~1v2~1merch~1pay~1notify/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","404","429","500"],"pointer":"/api/v2/merch/pay/notify","href":"payment/status_payment","openApiOperationId":"status_payment","summary":"Payment Result Notification"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.paykka.com"}],"schemaId":"schema_170","exampleIds":["paths/~1api~1v2~1merch~1pay~1notify/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_170","exampleIds":["paths/~1api~1v2~1merch~1pay~1notify/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/octet-stream","mediaTypes":["application/octet-stream"],"mediaTypeContent":{"application/octet-stream":{"schemaId":"schema_171"}},"schemaId":"schema_171","headers":{}},{"code":"400","description":"Bad Request","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}},{"code":"401","description":"Unauthorized","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}},{"code":"404","description":"Not Found","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}},{"code":"429","description":"Too Many Requests","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}},{"code":"500","description":"Internal Server Error","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}}],"pointer":"/paths/~1api~1v2~1merch~1pay~1notify/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_171","mediaTypes":["application/octet-stream"],"mediaTypeContent":{"application/octet-stream":{"schemaId":"schema_171"}}},{"code":"400","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}},{"code":"401","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}},{"code":"404","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}},{"code":"429","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}},{"code":"500","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment/status_payment"}],"panels":[]}]},"httpPath":"/api/v2/merch/pay/notify"}],"content":{"contentType":"group","meta":{"name":"Payment"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Payment","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v2/merch/pay/apply","summary":"Payment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment/inquiry_3","deprecated":false},{"title":"/api/v2/merch/pay/inquiry","summary":"Query Payment Status","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment/status_inquiry","deprecated":false},{"title":"/api/v2/merch/pay/notify","summary":"Payment Result Notification","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment/status_payment","deprecated":false}]}]}]}]}},{"type":"group","label":"File Service","link":"/collection/apis/openapi/file-service","routeSlug":"/collection/apis/openapi/file-service","items":[{"label":"File Upload","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/collection/apis/openapi/file-service/upload","routeSlug":"/collection/apis/openapi/file-service/upload","metadata":{"seo":{"title":"File Upload","description":"File Upload"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"upload","name":"File Upload","deprecated":false,"isWebhook":false,"pointer":"/paths/~1api~1file~1upload/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"File Upload","isWebhook":false,"deprecated":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Merch-Id","in":"header","schemaId":"schema_141","description":"","example":"M24061911365700670"}],"pointer":"/paths/~1api~1file~1upload/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_172","exampleIds":["paths/~1api~1file~1upload/post/requestBody/content/multipart~1form-data/example"]}},"schemaId":"schema_172","exampleIds":["paths/~1api~1file~1upload/post/requestBody/content/multipart~1form-data/example"],"pointer":"/paths/~1api~1file~1upload/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/file/upload","servers":[{"url":"https://api.paykka.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Merch-Id","in":"header","example":"M24061911365700670","schemaId":"schema_141"}],"cookie":[]},"security":[],"requestBody":{"multipart/form-data":{"schemaId":"schema_172","exampleIds":["paths/~1api~1file~1upload/post/requestBody/content/multipart~1form-data/example"]}},"responseCodes":["200","400","401","404","429","500"],"pointer":"/api/file/upload","href":"file-service/upload","openApiOperationId":"upload","summary":"File Upload"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.paykka.com"}],"schemaId":"schema_172","exampleIds":["paths/~1api~1file~1upload/post/requestBody/content/multipart~1form-data/example"],"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_172","exampleIds":["paths/~1api~1file~1upload/post/requestBody/content/multipart~1form-data/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/FileUploadResult"}},"schemaId":"components/schemas/FileUploadResult","headers":{}},{"code":"400","description":"Bad Request","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}},{"code":"401","description":"Unauthorized","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}},{"code":"404","description":"Not Found","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}},{"code":"429","description":"Too Many Requests","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}},{"code":"500","description":"Internal Server Error","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}},"schemaId":"schema_143","headers":{}}],"pointer":"/paths/~1api~1file~1upload/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/FileUploadResult","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/FileUploadResult"}}},{"code":"400","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}},{"code":"401","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}},{"code":"404","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}},{"code":"429","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}},{"code":"500","schemaId":"schema_143","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_143"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/file-service/upload"}],"panels":[]}]},"httpPath":"/api/file/upload"}],"content":{"contentType":"group","meta":{"name":"File Service"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"File Service","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/file/upload","summary":"File Upload","prefix":{"name":"post","color":"post"},"badges":[],"link":"/file-service/upload","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/CustomDecInfo":{"id":"components/schemas/CustomDecInfo","kind":"json-schema","title":"CustomDecInfo","data":{"type":"object","properties":{"dec_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Declaration method: METHOD_1-Not reported at the customs or Not included in the customs statistics for e-commerce TransactionOrder METHOD_2-Declared for export at the customs according to the general trade method"},"children":[]}]}]}]},"dec_no":{"type":"string","description":"Customs declaration number (Max 32 characters)","minLength":0,"maxLength":32}},"required":["dec_method"]}},"components/schemas/FxPair":{"id":"components/schemas/FxPair","kind":"json-schema","title":"FxPair","data":{"type":"object","properties":{"sell_currency":{"type":"string","description":"Sell out Currency"},"buy_currency":{"type":"string","description":"Buy into Currency"},"sell_amount":{"type":"integer","description":"SellAmount(CurrencyMinimum Unit)"},"buy_amount":{"type":"integer","description":"BuyAmount(CurrencyMinimum Unit)"}},"required":["sell_currency","buy_currency","sell_amount","buy_amount"],"description":"currency pair"}},"components/schemas/AccountBalanceGetReq":{"id":"components/schemas/AccountBalanceGetReq","kind":"json-schema","title":"AccountBalanceGetReq","data":{"type":"object","properties":{"currency":{"type":"string","description":"Currency: EUR - Euro, USD - United States dollar, CNY - Chinese yuan, GBP - British pound, JPY - Japanese yen, AUD - Australian dollar, CAD - Canadian dollar, SGD - Singapore dollar, HKD - Hong Kong dollar, PHP - Philippine peso, THB - Thai baht, CNH - offshore Chinese yuan","enum":["EUR","USD","CNY","GBP","JPY","AUD","CAD","SGD","HKD","PHP","THB","CNH"]}}}},"components/schemas/AddressDto":{"id":"components/schemas/AddressDto","kind":"json-schema","title":"AddressDto","data":{"required":["province","city","address1","zipcode"],"type":"object","properties":{"province":{"type":"string","description":"Province/state, Mainland China Code(See attachment)"},"city":{"maxLength":50,"minLength":0,"type":"string","description":"City, Mainland China Code(See attachment)"},"zipcode":{"maxLength":20,"minLength":0,"type":"string","description":"post code"},"address1":{"maxLength":50,"minLength":0,"type":"string","description":"Address line 1"},"address2":{"type":"string","description":"Address line 2"}},"description":"AddressInformation"}},"components/schemas/Authentication":{"id":"components/schemas/Authentication","kind":"json-schema","title":"Authentication","data":{"type":"object","properties":{"authorized_agent":{"$ref":"#/components/schemas/AuthAgentStakeholder"}},"description":"CertificationInformation"}},"components/schemas/AvailableAmountQueryReq":{"id":"components/schemas/AvailableAmountQueryReq","kind":"json-schema","title":"AvailableAmountQueryReq","data":{"required":["amount","currency","type"],"type":"object","properties":{"amount":{"minimum":1,"type":"integer","description":"Amount: Amount needs to be enlarged 100 times, and no thousand separators and decimal points may appear. For example, if it is 1020.50 RMB, 102050 should be filled in.","format":"int64"},"currency":{"type":"string","description":"Currency: EUR - Euro, USD - United States dollar, CNY - Chinese yuan, GBP - British pound, JPY - Japanese yen, AUD - Australian dollar, CAD - Canadian dollar, SGD - Singapore dollar, HKD - Hong Kong dollar, PHP - Philippine peso, THB - Thai baht, CNH - offshore Chinese yuan","enum":["EUR","USD","CNY","GBP","JPY","AUD","CAD","SGD","HKD","PHP","THB","CNH"]},"type":{"type":"string","description":"Payment purpose PAY-payment, WITHDRAW-cash withdrawal","enum":["PAY","WITHDRAW"]}}}},"components/schemas/AvailableAmountQueryRes":{"id":"components/schemas/AvailableAmountQueryRes","kind":"json-schema","title":"AvailableAmountQueryRes","data":{"required":["amount","currency","max_available_amount","min_payment_amount","type"],"type":"object","properties":{"amount":{"type":"integer","description":"Amount (Return as is)","format":"int64"},"currency":{"type":"string","description":"Currency: EUR - Euro, USD - United States dollar, CNY - Chinese yuan, GBP - British pound, JPY - Japanese yen, AUD - Australian dollar, CAD - Canadian dollar, SGD - Singapore dollar, HKD - Hong Kong dollar, PHP - Philippine peso, THB - Thai baht, CNH - offshore Chinese yuan","enum":["EUR","USD","CNY","GBP","JPY","AUD","CAD","SGD","HKD","PHP","THB","CNH"]},"max_available_amount":{"type":"integer","description":"Maximum AvailablePaymentAmount, the upper limit entered by the client Available in LimitPaymentAmount (Amount is enlarged 100 times, and thousands separators and decimal points do not appear)","format":"int64"},"min_payment_amount":{"type":"integer","description":"Minimum PaymentAmount, the client is Available and enters the lower limit in LimitPaymentAmount (Amount is enlarged 100 times, and thousands separators and decimal points do not appear)","format":"int64"},"type":{"type":"string","description":"Payment purpose PAY-payment, WITHDRAW-cash withdrawal","enum":["PAY","WITHDRAW"]}}}},"components/schemas/BankAccInfo":{"id":"components/schemas/BankAccInfo","kind":"json-schema","title":"BankAccInfo","data":{"required":["acc_name","acc_type","country","currency"],"type":"object","properties":{"acc_holder_addr":{"maxLength":100,"minLength":0,"type":"string","description":"BankAccount holder Address(Optional)(Max 100 characters)"},"acc_name":{"maxLength":100,"minLength":1,"type":"string","description":"AccountName(Max 100 characters)"},"acc_no":{"maxLength":100,"minLength":1,"type":"string","description":"Bank account number, accNo and iban are only required to fill in one."},"acc_type":{"type":"string","description":"AccountType: PRIVATE-Personal Account, COMPANY-Enterprise Corporate","enum":["PRIVATE","COMPANY"]},"bank_addr":{"maxLength":100,"minLength":1,"type":"string","description":"Account OpeningBankDetailedAddress(overseas AccountRequired)(Max 100 characters)"},"bank_head_office":{"maxLength":100,"minLength":0,"type":"string","description":"Account OpeningBank Head Office Code (domestic AccountRequired) (Max 100 characters)"},"bank_name":{"maxLength":100,"minLength":1,"type":"string","description":"Account OpeningBankName(overseas AccountRequired)(Max 100 characters)"},"branch_bank":{"maxLength":100,"minLength":0,"type":"string","description":"Account OpeningBank Branch Code (Domestic Enterprise to Corporate AccountRequired) (Max 100 characters)"},"cert_no":{"maxLength":100,"minLength":0,"type":"string","description":"ID Document number (domestic personal AccountRequired) (Max 100 characters)"},"cert_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Collection Person ID DocumentType (Domestic Personal AccountRequired and ID_CARD): ID_CARD-ID Card PASSPORT-Passport (Domestic Account does not have this Type)"},"children":[]}]}]}],"enum":["ID_CARD","PASSPORT"]},"city":{"maxLength":10,"minLength":0,"type":"string","description":"City to which Account OpeningBank belongs (domestic Enterprise to corporate AccountRequired) (Max 10 characters)"},"country":{"type":"string","description":"Country code, Use ISO3166-2 standard 2-digit Country code, non-sanctioned Country (See appendix)"},"currency":{"type":"string","description":"Currency: EUR - Euro, USD - United States dollar, CNY - Chinese yuan, GBP - British pound, JPY - Japanese yen, AUD - Australian dollar, CAD - Canadian dollar, SGD - Singapore dollar, HKD - Hong Kong dollar, PHP - Philippine peso, THB - Thai baht, CNH - offshore Chinese yuan","enum":["EUR","USD","CNY","GBP","JPY","AUD","CAD","SGD","HKD","PHP","THB","CNH"]},"district":{"maxLength":10,"minLength":0,"type":"string","description":"Account OpeningBank area (domestic Enterprise to corporate AccountRequired) (Max 10 characters)"},"iban":{"maxLength":100,"minLength":1,"type":"string","description":"Except for the British pound and the euro in European countries, other countries are not required. Only one of accNo and iban is required."},"province":{"maxLength":10,"minLength":0,"type":"string","description":"Account OpeningBank belongs to Province (domestic Enterprise to public AccountRequired) (Max 10 characters)"},"routing_number":{"maxLength":100,"minLength":1,"type":"string","description":"Except for the United States (all Currencies) and Canadian dollars, OtherCountry and Region do not RequiredUpload this Field"},"swift":{"maxLength":11,"minLength":8,"type":"string","description":"Except for China's RMB, which does not require this Field, other Countries and Regions require Upload this Field."},"uni_social_credit":{"maxLength":100,"minLength":0,"type":"string","description":"Unified Social Credit Code (domestic corporate AccountRequired) (Max 100 characters)"}},"description":"BankAccountInformation"}},"components/schemas/CnLicense":{"id":"components/schemas/CnLicense","kind":"json-schema","title":"CnLicense","data":{"required":["busi_from","ent_name","ent_type","found_date","legal_rep_name","region","registered_capital","registered_currency","uni_social_credit"],"type":"object","properties":{"address_info":{"$ref":"#/components/schemas/AddressDto"},"attachment_file_ids":{"type":"array","description":"OtherAttachment","items":{"type":"integer","description":"OtherAttachment","format":"int32"}},"busi_end":{"type":"string","description":"Mainland Enterprise BusinessDate (only), and whether long-term are mutually exclusive Required, choose one of them, both pass the default long-term","format":"date"},"busi_from":{"type":"string","description":"Mainland Enterprise BusinessDate(start)","format":"date"},"ent_name":{"maxLength":128,"minLength":0,"type":"string","description":"EnterpriseName (length 128 characters)"},"ent_name_en":{"maxLength":100,"minLength":0,"type":"string","description":"Enterprise English Name (length 100 characters)"},"ent_type":{"type":"string","description":"EnterpriseType: PERSONAL-Individual Merchant, OTHER-Others, ENTERPRISE-Enterprise, GOV-Government and public institutions, SOCIAL-Social organizations, PN-Private non-Enterprise"},"found_date":{"type":"string","description":"Date established","format":"date"},"legal_rep_name":{"maxLength":128,"minLength":0,"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mainland Enterprise’s legal representative’s name"},"children":[]}]}]}]},"license_file_id":{"type":"integer","description":"Mainland Enterprise Business LicenseFile","format":"int32"},"long_term":{"type":"boolean","description":"Whether it is long-term, and EnterpriseBusiness cut-off Date are mutually exclusive, and both default to long-term."},"region":{"maxLength":2,"minLength":0,"type":"string","description":"2-digit English CountryCode, refer to Appendix-CountryRegion Code"},"registered_capital":{"type":"number","description":"Registered capital, standard currency unit - yuan, two decimal places"},"registered_currency":{"maxLength":3,"minLength":0,"type":"string","description":"Registered capital Currency symbol, Use ISO-4217 standard 3-digit Currency code"},"uni_social_credit":{"maxLength":18,"minLength":0,"type":"string","description":"Mainland Enterprise Unified Social Credit Code"}},"description":"Enterprise License Information (only for display)-Mainland"}},"components/schemas/ContactPersonInfo":{"id":"components/schemas/ContactPersonInfo","kind":"json-schema","title":"ContactPersonInfo","data":{"required":["email","phone","phone_prefix"],"type":"object","properties":{"phone_prefix":{"maxLength":5,"minLength":0,"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CountryRegion area code, such as: +86 or +852"},"children":[]}]}]}]},"phone":{"maxLength":64,"minLength":0,"type":"string","description":"ContactPhone (length 64 characters)"},"email":{"maxLength":64,"minLength":0,"type":"string","description":"ContactEmail(length 64 characters)"}},"description":"ContactInformation"}},"components/schemas/ContractOrderCreateReq":{"id":"components/schemas/ContractOrderCreateReq","kind":"json-schema","title":"ContractOrderCreateReq","data":{"required":["amount","buyer_country","buyer_name","c_rsc_id","contract_attachment_ids","contract_id","currency","goods_info","invoice_attachment_ids","is_exchange_settle","logistics_info","order_time"],"type":"object","properties":{"amount":{"type":"integer","description":"OrderAmount (Amount is magnified 100 times, without thousandths)","format":"int64"},"buyer_country":{"type":"string","description":"Buy country code, Use ISO3166-2 standard 2-digit country code (See appendix)"},"buyer_name":{"maxLength":128,"minLength":1,"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Buyer’s name (Max 128 characters)"},"children":[]}]}]}]},"c_rsc_id":{"maxLength":32,"minLength":0,"type":"string","description":"Client-side resource id, Unique in the requesting system (length 32 characters)"},"contract_attachment_ids":{"maxItems":10,"minItems":1,"type":"array","description":"ContractAttachmentid-UploadFileAPIReturn id (up to 10 Files)","items":{"type":"integer","description":"ContractAttachmentid-UploadFileAPIReturn id (up to 10 Files)","format":"int32"}},"contract_id":{"maxLength":32,"minLength":1,"type":"string","description":"ContractNumber(Max 32 characters)(can only be numbers and letters)(Unique under Merchant)"},"currency":{"type":"string","description":"Currency: EUR - Euro, USD - United States dollar, CNY - Chinese yuan, GBP - British pound, JPY - Japanese yen, AUD - Australian dollar, CAD - Canadian dollar, SGD - Singapore dollar, HKD - Hong Kong dollar, PHP - Philippine peso, THB - Thai baht, CNH - offshore Chinese yuan","enum":["EUR","USD","CNY","GBP","JPY","AUD","CAD","SGD","HKD","PHP","THB","CNH"]},"goods_info":{"$ref":"#/components/schemas/GoodsInfo"},"invoice_attachment_ids":{"maxItems":10,"minItems":1,"type":"array","description":"PI/CI/Invoice id-UploadFileAPIReturnid (up to 10 Files)","items":{"type":"integer","description":"PI/CI/Invoice id-UploadFileAPIReturnid (up to 10 Files)","format":"int32"}},"is_exchange_settle":{"type":"boolean","description":"Whether settlement of foreign exchange is Required"},"logistics_info":{"$ref":"#/components/schemas/LogisticsInfo"},"order_time":{"type":"string","description":"OrderTime Format: yyyy-MM-dd","format":"date-time"},"other_attachment_ids":{"type":"array","description":"OtherAttachmentid-UploadFileAPIReturn id","items":{"type":"integer","description":"OtherAttachmentid-UploadFileAPIReturn id","format":"int32"}},"remark":{"maxLength":128,"minLength":0,"type":"string","description":"Remark (length 128 characters)"}}}},"components/schemas/ContractOrderGetReq":{"id":"components/schemas/ContractOrderGetReq","kind":"json-schema","title":"ContractOrderGetReq","data":{"required":["c_rsc_id"],"type":"object","properties":{"c_rsc_id":{"maxLength":32,"minLength":0,"type":"string","description":"Client-side resource id, Unique in the requesting system (length 32 characters)"}}}},"components/schemas/ContractOrderNotification":{"id":"components/schemas/ContractOrderNotification","kind":"json-schema","title":"ContractOrderNotification","data":{"required":["c_rsc_id","contract_order_id","merch_id","status"],"type":"object","properties":{"c_rsc_id":{"type":"string","description":"Client resource id"},"contract_order_id":{"type":"string","description":"ContractOrderNumber"},"merch_id":{"type":"string","description":"Merchantid"},"reason":{"type":"string","description":"ReviewRejectedReason"},"request_id":{"maxLength":32,"minLength":1,"type":"string","description":"New API client side resource id"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Open platform ContractOrderStatus PENDING-to be reviewed REJECT-Not approved PASS-Approved ALL_RELATED-collect all"},"children":[]}]}]}],"enum":["PENDING","REJECT","PASS","ALL_RELATED"]}},"description":"Notification message content"}},"components/schemas/ContractOrderUpdateReq":{"id":"components/schemas/ContractOrderUpdateReq","kind":"json-schema","title":"ContractOrderUpdateReq","data":{"required":["amount","buyer_country","buyer_name","c_rsc_id","contract_attachment_ids","contract_id","currency","goods_info","invoice_attachment_ids","is_exchange_settle","logistics_info","order_time"],"type":"object","properties":{"amount":{"type":"integer","description":"OrderAmount (Amount is magnified 100 times, without thousandths)","format":"int64"},"buyer_country":{"type":"string","description":"Buy country code, Use ISO3166-2 standard 2-digit country code (See appendix)"},"buyer_name":{"maxLength":128,"minLength":1,"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Buyer’s name (Max 128 characters)"},"children":[]}]}]}]},"c_rsc_id":{"maxLength":32,"minLength":0,"type":"string","description":"Client-side resource id, Unique in the requesting system (length 32 characters)"},"contract_attachment_ids":{"maxItems":10,"minItems":1,"type":"array","description":"ContractAttachmentid-UploadFileAPIReturn id (up to 10 Files)","items":{"type":"integer","description":"ContractAttachmentid-UploadFileAPIReturn id (up to 10 Files)","format":"int32"}},"contract_id":{"maxLength":32,"minLength":1,"type":"string","description":"ContractNumber(Max 32 characters)(can only be numbers and letters)(Unique under Merchant)"},"currency":{"type":"string","description":"Currency: EUR - Euro, USD - United States dollar, CNY - Chinese yuan, GBP - British pound, JPY - Japanese yen, AUD - Australian dollar, CAD - Canadian dollar, SGD - Singapore dollar, HKD - Hong Kong dollar, PHP - Philippine peso, THB - Thai baht, CNH - offshore Chinese yuan","enum":["EUR","USD","CNY","GBP","JPY","AUD","CAD","SGD","HKD","PHP","THB","CNH"]},"goods_info":{"$ref":"#/components/schemas/GoodsInfo"},"invoice_attachment_ids":{"maxItems":10,"minItems":1,"type":"array","description":"PI/CI/Invoice id-UploadFileAPIReturnid (up to 10 Files)","items":{"type":"integer","description":"PI/CI/Invoice id-UploadFileAPIReturnid (up to 10 Files)","format":"int32"}},"is_exchange_settle":{"type":"boolean","description":"Whether settlement of foreign exchange is Required"},"logistics_info":{"$ref":"#/components/schemas/LogisticsInfo"},"order_time":{"type":"string","description":"OrderTime Format: yyyy-MM-dd","format":"date-time"},"other_attachment_ids":{"type":"array","description":"OtherAttachmentid-UploadFileAPIReturn id","items":{"type":"integer","description":"OtherAttachmentid-UploadFileAPIReturn id","format":"int32"}},"remark":{"maxLength":128,"minLength":0,"type":"string","description":"Remark (length 128 characters)"}}}},"components/schemas/EntLicense":{"id":"components/schemas/EntLicense","kind":"json-schema","title":"EntLicense","data":{"required":["ent_name","found_date","region","registered_capital","registered_currency"],"type":"object","properties":{"region":{"maxLength":2,"minLength":0,"type":"string","description":"2-digit English CountryCode, refer to Appendix-CountryRegion Code"},"ent_name":{"maxLength":128,"minLength":0,"type":"string","description":"EnterpriseName (length 128 characters)"},"ent_name_en":{"type":"string","description":"Enterprise English Name (length 128 characters)","maxLength":128,"minLength":0},"found_date":{"type":"string","description":"Date established","format":"date"},"registered_currency":{"maxLength":3,"minLength":0,"type":"string","description":"Registered capital Currency symbol, Use ISO-4217 standard 3-digit Currency code"},"registered_capital":{"type":"number","description":"Registered capital, unit standard Currency, two decimal places, if there is no registered capital, fill in 0; if reigon is a mainland enterprise, it is yuan, if it is a Hong Kong enterprise, it is Hong Kong dollars, and if it is a global enterprise, it is US dollars."},"address":{"$ref":"#/components/schemas/AddressDto"},"legal_rep_name":{"maxLength":128,"minLength":0,"type":"string","description":"Region is Mainland Required - Mainland Enterprise name of legal representative"},"license_file_id":{"type":"integer","description":"region is Mainland Required-Mainland Enterprise Business LicenseFile","format":"int32"},"ent_type":{"type":"string","description":"region is mainland Required-EnterpriseType: PERSONAL-IndividualMerchant, ENTERPRISE-Enterprise"},"uni_social_credit":{"maxLength":18,"minLength":0,"type":"string","description":"region is Mainland Required-Mainland Enterprise Unified Social Credit Code"},"busi_from":{"type":"string","description":"region is Mainland Required-Mainland Enterprise BusinessDate (starting)","format":"date"},"busi_end":{"type":"string","description":"Region is Mainland China Optional-Mainland Enterprise BusinessDate (only), and whether long-term are mutually exclusive Required, choose one of them, both pass the default long-term","format":"date"},"long_term":{"type":"boolean","description":"region is mainland Optional - whether it is long-term, and EnterpriseBusiness cut-off Date are mutually exclusive, and both default to long-term"},"br_no":{"type":"string","description":"region is Hong Kong Required-global Enterprise registration certificate number"},"br_file_id":{"type":"integer","description":"Region is Hong Kong Required-Global Enterprise Company Registration Certificate","format":"int32"},"annual_return_file_id":{"type":"integer","description":"Region is Hong Kong Optional - Hong Kong Enterprise Annual Return (choose one from the corporate establishment form)","format":"int32"},"incorporation_form_file_id":{"type":"integer","description":"Region is Hong Kong Optional-Hong Kong Enterprise Incorporation Form (choose one of the annual return form)","format":"int32"},"br_expiry_date":{"type":"string","description":"region is Hong Kong Required-Hong Kong Enterprise Expiration Date: yyyy-MM-dd","format":"date"},"cr_issue_date":{"type":"string","description":"The region is Hong Kong Required-Hong Kong Enterprise Certificate Issue Date:yyyy-MM-dd","format":"date"},"company_article_file_id":{"type":"integer","description":"region is global EnterpriseRequired-Articles of Association File","format":"int32"},"cr_file_id":{"type":"integer","description":"Region is non-mainland Required-Hong Kong/Global Enterprise Company Registration Certificate","format":"int32"},"cr_no":{"type":"string","description":"Region is non-mainland Required-Hong Kong Enterprise Certificate Number/Global Enterprise Registration Certificate Number"},"share_structure_file_id":{"type":"integer","description":"region is Global EnterpriseRequired-Global Enterprise Equity Structure File","format":"int32"},"cr_expiry_date":{"type":"string","description":"Region is Global Required-Global Enterprise Expiration Date: yyyy-MM-dd","format":"date"},"other_file_ids":{"type":"array","description":"OtherAttachment","items":{"type":"integer","description":"OtherAttachment","format":"int32"}}},"description":"Enterprise LicenseInformation"}},"components/schemas/FileUploadResult":{"id":"components/schemas/FileUploadResult","kind":"json-schema","title":"FileUploadResult","data":{"required":["file_id"],"type":"object","properties":{"file_id":{"type":"integer","description":"FileIdentifier character, APIFileField transmits according to this value","format":"int32"}}}},"components/schemas/HkLicense":{"id":"components/schemas/HkLicense","kind":"json-schema","title":"HkLicense","data":{"required":["br_expiry_date","br_file_id","br_no","cr_file_id","cr_issue_date","cr_no","ent_name","ent_name_en","found_date","region","registered_capital","registered_currency"],"type":"object","properties":{"address_info":{"$ref":"#/components/schemas/AddressDto"},"annual_return_file_id":{"type":"integer","description":"Hong Kong Enterprise Annual Return (Choose one of the two forms)","format":"int32"},"attachment_file_ids":{"type":"array","description":"OtherAttachment","items":{"type":"integer","description":"OtherAttachment","format":"int32"}},"br_expiry_date":{"type":"string","description":"Hong Kong Enterprise Expiration Date:yyyy-MM-dd","format":"date"},"br_file_id":{"type":"integer","description":"Global Enterprise Company Registration Certificate","format":"int32"},"br_no":{"type":"string","description":"Global Enterprise Registration Certificate Number"},"company_article_file_id":{"type":"integer","description":"Articles of Association File","format":"int32"},"cr_file_id":{"type":"integer","description":"Hong Kong Enterprise Company Registration Certificate","format":"int32"},"cr_issue_date":{"type":"string","description":"Hong Kong Enterprise Certificate Issue Date:yyyy-MM-dd","format":"date"},"cr_no":{"type":"string","description":"Hong Kong Enterprise Certificate Number"},"ent_name":{"maxLength":128,"minLength":0,"type":"string","description":"EnterpriseName (length 128 characters)"},"ent_name_en":{"maxLength":100,"minLength":0,"type":"string","description":"Enterprise English Name (length 100 characters)"},"found_date":{"type":"string","description":"Date established","format":"date"},"incorporation_form_file_id":{"type":"integer","description":"Hong Kong Enterprise Incorporation Form (Choose one from the Annual Return Form)","format":"int32"},"region":{"maxLength":2,"minLength":0,"type":"string","description":"2-digit English CountryCode, refer to Appendix-CountryRegion Code"},"registered_capital":{"type":"number","description":"Registered capital, in Hong Kong dollars, two decimal places"},"registered_currency":{"maxLength":3,"minLength":0,"type":"string","description":"Registered capital Currency symbol, Use ISO-4217 standard 3-digit Currency code"},"share_structure_file_id":{"type":"integer","description":"Global Enterprise Equity Structure File","format":"int32"}},"description":"Enterprise License Information (only for display)-Hong Kong"}},"components/schemas/IdentityVerifyAddRes":{"id":"components/schemas/IdentityVerifyAddRes","kind":"json-schema","title":"IdentityVerifyAddRes","data":{"required":["authorize_link","merch_id"],"type":"object","properties":{"authorize_link":{"type":"string","description":"AuthorizationLink","minLength":0,"maxLength":256},"merch_id":{"type":"string","description":"Merchantid","minLength":1,"maxLength":20}}}},"components/schemas/IntlLicense":{"id":"components/schemas/IntlLicense","kind":"json-schema","title":"IntlLicense","data":{"required":["cr_expiry_date","cr_file_id","cr_no","ent_name","ent_name_en","found_date","region","registered_capital","registered_currency"],"type":"object","properties":{"address_info":{"$ref":"#/components/schemas/AddressDto"},"attachment_file_ids":{"type":"array","description":"OtherAttachment","items":{"type":"integer","description":"OtherAttachment","format":"int32"}},"company_article_file_id":{"type":"integer","description":"Articles of Association File","format":"int32"},"cr_expiry_date":{"type":"string","description":"Global Enterprise Expiration Date:yyyy-MM-dd","format":"date"},"cr_file_id":{"type":"integer","description":"Global Enterprise Enterprise Registration Certificate","format":"int32"},"cr_no":{"type":"string","description":"Global Enterprise Registration Certificate Number"},"ent_name":{"maxLength":128,"minLength":0,"type":"string","description":"EnterpriseName (length 128 characters)"},"ent_name_en":{"maxLength":100,"minLength":0,"type":"string","description":"Enterprise English Name (length 100 characters)"},"found_date":{"type":"string","description":"Date established","format":"date"},"region":{"maxLength":2,"minLength":0,"type":"string","description":"2-digit English CountryCode, refer to Appendix-CountryRegion Code"},"registered_capital":{"type":"number","description":"Registered capital in US dollars, two decimal places"},"registered_currency":{"maxLength":3,"minLength":0,"type":"string","description":"Registered capital Currency symbol, Use ISO-4217 standard 3-digit Currency code"},"share_structure_file_id":{"type":"integer","description":"Global Enterprise Equity Structure File","format":"int32"}},"description":"Enterprise License Information (just for display) - Global"}},"components/schemas/LogisticsSupplementReq":{"id":"components/schemas/LogisticsSupplementReq","kind":"json-schema","title":"LogisticsSupplementReq","data":{"required":["c_rsc_id","destination","logistics_company_name","outbound_id","ship_date","shipped_file_ids","transport_mode"],"type":"object","properties":{"c_rsc_id":{"maxLength":32,"minLength":0,"type":"string","description":"Client-side resource id, Unique in the requesting system (length 32 characters)"},"destination":{"type":"string","description":"destination"},"logistics_company_name":{"type":"string","description":"Logistics Company Name"},"outbound_id":{"type":"string","description":"Outbound Logistics tracking number"},"ship_date":{"type":"string","description":"ShippingDate","format":"date-time"},"shipped_file_ids":{"maxItems":10,"minItems":1,"type":"array","description":"Shipping VoucherFileIDList","items":{"type":"integer","description":"Shipping VoucherFileIDList","format":"int32"}},"transport_mode":{"type":"string","description":"Transportation method: AIR-Air SHIPPING-Sea EXPRESS-Express LAND-Land POST-Post OTHER-Other","enum":["AIR","SHIPPING","EXPRESS","LAND","POST","OTHER"]}}}},"components/schemas/MerchFeeRateDto":{"id":"components/schemas/MerchFeeRateDto","kind":"json-schema","title":"MerchFeeRateDto","data":{"type":"object","properties":{"charge_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Charging method: RATIO-ratio, FIXED-Amount, FIXED_RATIO-ratio+Amount"},"children":[]}]}]}],"enum":["RATIO","FIXED","FIXED_RATIO"]},"currency":{"type":"string","description":"Currency: EUR - Euro, USD - United States dollar, CNY - Chinese yuan, GBP - British pound, JPY - Japanese yen, AUD - Australian dollar, CAD - Canadian dollar, SGD - Singapore dollar, HKD - Hong Kong dollar, PHP - Philippine peso, THB - Thai baht, CNH - offshore Chinese yuan","enum":["EUR","USD","CNY","GBP","JPY","AUD","CAD","SGD","HKD","PHP","THB","CNH"]},"effective_time":{"type":"string","description":"Effective Time","format":"date-time"},"fee_currency":{"type":"string","description":"Currency: EUR - Euro, USD - United States dollar, CNY - Chinese yuan, GBP - British pound, JPY - Japanese yen, AUD - Australian dollar, CAD - Canadian dollar, SGD - Singapore dollar, HKD - Hong Kong dollar, PHP - Philippine peso, THB - Thai baht, CNH - offshore Chinese yuan","enum":["EUR","USD","CNY","GBP","JPY","AUD","CAD","SGD","HKD","PHP","THB","CNH"]},"fee_rate":{"type":"number","description":"Corresponding to Rate (percentage)"},"fee_rate_type":{"type":"string","description":"RateType: PAY-PaymentRate, WITHDRAW-Withdrawal Rate, RECV-First Rate","enum":["PAY","WITHDRAW","RECV"]},"fixed_amount":{"type":"integer","description":"Amount","format":"int64"},"max_fee":{"type":"integer","description":"Capped Fee","format":"int64"},"min_fee":{"type":"integer","description":"Guaranteed Fee","format":"int64"}},"description":"MerchantRateConfiguration, array"}},"components/schemas/MerchFeeRateRes":{"id":"components/schemas/MerchFeeRateRes","kind":"json-schema","title":"MerchFeeRateRes","data":{"type":"object","properties":{"merch_fee_rate_dtos":{"type":"array","description":"MerchantRateConfiguration, array","items":{"$ref":"#/components/schemas/MerchFeeRateDto"}}}}},"components/schemas/MerchOnboardApplyResultNotification":{"id":"components/schemas/MerchOnboardApplyResultNotification","kind":"json-schema","title":"MerchOnboardApplyResultNotification","data":{"required":["c_rsc_id","merch_id","status"],"type":"object","properties":{"c_rsc_id":{"type":"string","description":"Client resource id"},"merch_id":{"type":"string","description":"Merchantid"},"msg":{"type":"string","description":"ResultDescription"},"request_id":{"maxLength":32,"minLength":1,"type":"string","description":"Request number, Unique within the requesting system"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identity authentication Status: INIT-Initial WAIT-Pending Review PASS-ReviewApproved REFUSED-ReviewNot approved AUTH_FAIL-AuthorizationCancel"},"children":[]}]}]}],"enum":["INIT","WAIT","PASS","REFUSED","AUTH_FAIL"]}},"description":"Notification message content"}},"components/schemas/MerchOnboardInquiryReq":{"id":"components/schemas/MerchOnboardInquiryReq","kind":"json-schema","title":"MerchOnboardInquiryReq","data":{"required":["request_id"],"type":"object","properties":{"request_id":{"maxLength":32,"minLength":1,"type":"string","description":"Request number, Unique within the requesting system"}}}},"components/schemas/MerchPayeeNotification":{"id":"components/schemas/MerchPayeeNotification","kind":"json-schema","title":"MerchPayeeNotification","data":{"required":["c_rsc_id","merch_id","payee_id","status"],"type":"object","properties":{"c_rsc_id":{"type":"string","description":"Client resource id"},"merch_id":{"type":"string","description":"Merchantid"},"msg":{"type":"string","description":"Result description, not empty when Failed"},"payee_id":{"type":"string","description":"Collection person id"},"request_id":{"maxLength":32,"minLength":1,"type":"string","description":"New API client side resource id"},"status":{"type":"string","description":"PayerReviewStatus PENDING-Pending Review NORMAL-Normal REJECTED-ReviewNot approved DELETED-Delete","enum":["PENDING","NORMAL","REJECTED","DELETED"]}},"description":"Notification message content"}},"components/schemas/MerchVaCreateReq":{"id":"components/schemas/MerchVaCreateReq","kind":"json-schema","title":"MerchVaCreateReq","data":{"required":["account_type","area_code","c_rsc_id","remark_name"],"type":"object","properties":{"account_type":{"type":"string","description":"AccountType LOCAL-local, GLOBAL-global","enum":["LOCAL","GLOBAL"]},"area_code":{"type":"string","description":"CollectionCountry/Region, Use ISO3166-2 standard 2-digit Country/Region code (global Account currently only supports HK, local AccountSupport's CollectionCountrySee attachment)"},"c_rsc_id":{"maxLength":32,"minLength":0,"type":"string","description":"Client-side resource id, Unique in the requesting system (length 32 characters)"},"remark_name":{"maxLength":20,"minLength":0,"type":"string","description":"AccountRemark name (length 20 characters)"}}}},"components/schemas/MerchVaGetReq":{"id":"components/schemas/MerchVaGetReq","kind":"json-schema","title":"MerchVaGetReq","data":{"required":["c_rsc_id"],"type":"object","properties":{"c_rsc_id":{"maxLength":32,"minLength":0,"type":"string","description":"Client-side resource id, Unique in the requesting system (length 32 characters)"}}}},"components/schemas/NotificationDtoContractOrderNotification":{"id":"components/schemas/NotificationDtoContractOrderNotification","kind":"json-schema","title":"NotificationDtoContractOrderNotification","data":{"required":["data","type"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/ContractOrderNotification"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BusinessType: MERCH-Merchant, VA-Virtual Account, INCOMING_REMITTANCE-Import Remittance, CONTRACT_ORDER-ContractOrder, TRADE_SETTLE-SettlementCrediting, PAYEE-Collection, WD_ACCOUNT-Withdraw Account, CUR_EXCHANGE-FX, PAYMENT-Payment"},"children":[]}]}]}],"enum":["MERCH","VA","INCOMING_REMITTANCE","CONTRACT_ORDER","TRADE_SETTLE","PAYEE","WD_ACCOUNT","FOREX","PAYMENT"]}}}},"components/schemas/NotificationDtoMerchOnboardApplyResultNotification":{"id":"components/schemas/NotificationDtoMerchOnboardApplyResultNotification","kind":"json-schema","title":"NotificationDtoMerchOnboardApplyResultNotification","data":{"required":["data","type"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/MerchOnboardApplyResultNotification"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BusinessType: MERCH-Merchant, VA-Virtual Account, INCOMING_REMITTANCE-Import Remittance, CONTRACT_ORDER-ContractOrder, TRADE_SETTLE-SettlementCrediting, PAYEE-Collection, WD_ACCOUNT-Withdraw Account, CUR_EXCHANGE-FX, PAYMENT-Payment"},"children":[]}]}]}],"enum":["MERCH","VA","INCOMING_REMITTANCE","CONTRACT_ORDER","TRADE_SETTLE","PAYEE","WD_ACCOUNT","FOREX","PAYMENT"]}}}},"components/schemas/NotificationDtoMerchPayeeNotification":{"id":"components/schemas/NotificationDtoMerchPayeeNotification","kind":"json-schema","title":"NotificationDtoMerchPayeeNotification","data":{"required":["data","type"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/MerchPayeeNotification"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BusinessType: MERCH-Merchant, VA-Virtual Account, INCOMING_REMITTANCE-Import Remittance, CONTRACT_ORDER-ContractOrder, TRADE_SETTLE-SettlementCrediting, PAYEE-Collection, WD_ACCOUNT-Withdraw Account, CUR_EXCHANGE-FX, PAYMENT-Payment"},"children":[]}]}]}],"enum":["MERCH","VA","INCOMING_REMITTANCE","CONTRACT_ORDER","TRADE_SETTLE","PAYEE","WD_ACCOUNT","FOREX","PAYMENT"]}}}},"components/schemas/NotificationDtoWithdrawalAccountNotification":{"id":"components/schemas/NotificationDtoWithdrawalAccountNotification","kind":"json-schema","title":"NotificationDtoWithdrawalAccountNotification","data":{"required":["data","type"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/WithdrawalAccountNotification"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BusinessType: MERCH-Merchant, VA-Virtual Account, INCOMING_REMITTANCE-Import Remittance, CONTRACT_ORDER-ContractOrder, TRADE_SETTLE-SettlementCrediting, PAYEE-Collection, WD_ACCOUNT-Withdraw Account, CUR_EXCHANGE-FX, PAYMENT-Payment"},"children":[]}]}]}],"enum":["MERCH","VA","INCOMING_REMITTANCE","CONTRACT_ORDER","TRADE_SETTLE","PAYEE","WD_ACCOUNT","FOREX","PAYMENT"]}}}},"components/schemas/OpenPlatformCommonReq":{"id":"components/schemas/OpenPlatformCommonReq","kind":"json-schema","title":"OpenPlatformCommonReq","data":{"required":["c_rsc_id"],"type":"object","properties":{"c_rsc_id":{"maxLength":32,"minLength":0,"type":"string","description":"Client-side resource id, Unique in the requesting system (length 32 characters)"}}}},"components/schemas/PayeeCreateReq":{"id":"components/schemas/PayeeCreateReq","kind":"json-schema","title":"PayeeCreateReq","data":{"required":["bank_acc_info","c_rsc_id","payee_info"],"type":"object","properties":{"attachment_ids":{"maxItems":7,"minItems":0,"type":"array","description":"AttachmentFileid up to 7","items":{"type":"integer","description":"AttachmentFileid up to 7","format":"int32"}},"bank_acc_info":{"$ref":"#/components/schemas/BankAccInfo"},"c_rsc_id":{"maxLength":32,"minLength":0,"type":"string","description":"Client-side resource id, Unique in the requesting system (length 32 characters)"},"contract_file_path_id":{"type":"integer","description":"ContractFile-UploadFileAPIReturn id (Contract/PI/LogisticsFile must pass one)","format":"int32"},"logistics_file_path_id":{"type":"integer","description":"LogisticsFile-UploadFileAPIReturn id (Contract/PI/LogisticsFile must pass one)","format":"int32"},"payee_info":{"$ref":"#/components/schemas/PayeeInfo"},"pi_file_path_id":{"type":"integer","description":"PIFileid-UploadFileAPIReturn id (Contract/PI/LogisticsFile must pass one)","format":"int32"}}}},"components/schemas/PayeeGetReq":{"id":"components/schemas/PayeeGetReq","kind":"json-schema","title":"PayeeGetReq","data":{"required":["c_rsc_id"],"type":"object","properties":{"c_rsc_id":{"maxLength":32,"minLength":0,"type":"string","description":"Client-side resource id, Unique in the requesting system (length 32 characters)"}}}},"components/schemas/PayeeGetRes":{"id":"components/schemas/PayeeGetRes","kind":"json-schema","title":"PayeeGetRes","data":{"required":["payee_id","status"],"type":"object","properties":{"msg":{"type":"string","description":"Result description, not empty when Failed"},"payee_id":{"type":"string","description":"Collection person id, only Return after CreateSuccessful and ReviewApproved; ApprovedSpecifyCollection person id can be used during Payment InitiatePayment"},"status":{"type":"string","description":"PayerReviewStatus PENDING-Pending Review NORMAL-Normal REJECTED-ReviewNot approved DELETED-Delete","enum":["PENDING","NORMAL","REJECTED","DELETED"]}}}},"components/schemas/PayeeInfo":{"id":"components/schemas/PayeeInfo","kind":"json-schema","title":"PayeeInfo","data":{"required":["country","payee_type"],"type":"object","properties":{"country":{"type":"string","description":"Country code, Use ISO3166-2 standard 2-digit Country code, non-sanctioned Country (See appendix)"},"email":{"maxLength":100,"minLength":0,"type":"string","description":"ContactEmail(Max 100 characters)"},"name":{"maxLength":100,"minLength":0,"type":"string","description":"Contact name(Max 100 characters)"},"nick_name":{"maxLength":100,"minLength":0,"type":"string","description":"Nickname(Max 100 characters)"},"payee_first_name":{"maxLength":100,"minLength":1,"type":"string","description":"Collection person first name (Overseas Collection person Required) (Max 100 characters)"},"payee_last_name":{"maxLength":100,"minLength":1,"type":"string","description":"Collection person last name (Overseas Collection person Required) (Max 100 characters)"},"payee_name":{"maxLength":100,"minLength":1,"type":"string","description":"Collection person's name (domestic Collection person Required) (Max 100 characters)"},"payee_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CollectionType PFG-payment LWF-Logistics warehousing fee ASF-advertising service fee TSF-technical service fee CSF-consulting service fee OTHER-Other Data dictionary:PAYEE_TYPE"},"children":[]}]}]}],"enum":["PFG","LWF","ASF","TSF","CSF","OTHER"]},"payee_type_desc":{"maxLength":100,"minLength":0,"type":"string","description":"CollectionType description, Required for OtherCollectionType (Max 100 characters)"},"phone":{"pattern":"^1[3-9]\\d{9}$","type":"string","description":"ContactPhone (up to 11 digits)"},"website":{"maxLength":100,"minLength":0,"type":"string","description":"Website(Max 100 characters)"}},"description":"CollectionPeopleInformation"}},"components/schemas/PayeeUpdateReq":{"id":"components/schemas/PayeeUpdateReq","kind":"json-schema","title":"PayeeUpdateReq","data":{"required":["bank_acc_info","c_rsc_id","payee_info"],"type":"object","properties":{"attachment_ids":{"maxItems":7,"minItems":0,"type":"array","description":"AttachmentFileid up to 7","items":{"type":"integer","description":"AttachmentFileid up to 7","format":"int32"}},"bank_acc_info":{"$ref":"#/components/schemas/BankAccInfo"},"c_rsc_id":{"maxLength":32,"minLength":0,"type":"string","description":"Client-side resource id, Unique in the requesting system (length 32 characters)"},"contract_file_path_id":{"type":"integer","description":"ContractFile-UploadFileAPIReturn id (Contract/PI/LogisticsFile must pass one)","format":"int32"},"logistics_file_path_id":{"type":"integer","description":"LogisticsFile-UploadFileAPIReturn id (Contract/PI/LogisticsFile must pass one)","format":"int32"},"payee_info":{"$ref":"#/components/schemas/PayeeInfo"},"pi_file_path_id":{"type":"integer","description":"PIFileid-UploadFileAPIReturn id (Contract/PI/LogisticsFile must pass one)","format":"int32"}}}},"components/schemas/PaymentConfirmReq":{"id":"components/schemas/PaymentConfirmReq","kind":"json-schema","title":"PaymentConfirmReq","data":{"required":["c_rsc_id","confirm_token","postscript"],"type":"object","properties":{"c_rsc_id":{"maxLength":32,"minLength":0,"type":"string","description":"Client-side resource id, Unique in the requesting system (length 32 characters)"},"confirm_token":{"type":"string","description":"Upload the original value returned by the Pre-order API"},"postscript":{"maxLength":64,"minLength":0,"type":"string","description":"P.S. Bank payment Remark (length 64 characters)"}}}},"components/schemas/PaymentConfirmRes":{"id":"components/schemas/PaymentConfirmRes","kind":"json-schema","title":"PaymentConfirmRes","data":{"required":["status"],"type":"object","properties":{"status":{"type":"string","description":"Payment Status: PROCESSING-Processing, SUCCEEDED-Processing, FAILED-Failed","enum":["PROCESSING","SUCCEEDED","FAILED"]}}}},"components/schemas/PaymentPreorderReq":{"id":"components/schemas/PaymentPreorderReq","kind":"json-schema","title":"PaymentPreorderReq","data":{"required":["amount","currency","target_id","to_account_type","type"],"type":"object","properties":{"amount":{"minimum":1,"type":"integer","description":"To remit (fixed amount payment)/receive (fixed amount payment) Amount, the amount needs to be enlarged 100 times, and no thousand separators and decimal points may appear. For example, if it is 1020.50 RMB, 102050 should be filled in.","format":"int64"},"currency":{"type":"string","description":"Currency: EUR - Euro, USD - United States dollar, CNY - Chinese yuan, GBP - British pound, JPY - Japanese yen, AUD - Australian dollar, CAD - Canadian dollar, SGD - Singapore dollar, HKD - Hong Kong dollar, PHP - Philippine peso, THB - Thai baht, CNH - offshore Chinese yuan","enum":["EUR","USD","CNY","GBP","JPY","AUD","CAD","SGD","HKD","PHP","THB","CNH"]},"target_id":{"maxLength":32,"minLength":0,"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment target id: when type=PAY, it is the Collection person id; when type=WITHDRAW, it is the withdrawal Accountid (length 32 characters)"},"children":[]}]}]}]},"to_account_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment method: FIX_PAY-fixed payment, FIX_RECEIVE-fixed collection"},"children":[]}]}]}],"enum":["FIX_PAY","FIX_RECEIVE"]},"type":{"type":"string","description":"Payment purpose PAY-payment, WITHDRAW-cash withdrawal","enum":["PAY","WITHDRAW"]}}}},"components/schemas/PaymentPreorderRes":{"id":"components/schemas/PaymentPreorderRes","kind":"json-schema","title":"PaymentPreorderRes","data":{"required":["confirm_token","exchange_rate","expire_time","fee_amount","payment_amount","payment_currency","receive_amount","receive_currency","to_account_type","type"],"type":"object","properties":{"confirm_token":{"maxLength":32,"minLength":0,"type":"string","description":"PaymentConfirmtoken, if ConfirmPaymentUpload according to this value"},"exchange_rate":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exchange Rate (1Payment currency = XXX payment currency, keep 6 decimal places)"},"children":[]}]}]}]},"expire_time":{"type":"string","description":"PaymentConfirmtokenExpiredTime","format":"date-time"},"fee_amount":{"type":"integer","description":"Fee (Currency is the Payment currency)","format":"int64"},"payment_amount":{"type":"integer","description":"PaymentAmount(Return as is)","format":"int64"},"payment_currency":{"type":"string","description":"Currency: EUR - Euro, USD - United States dollar, CNY - Chinese yuan, GBP - British pound, JPY - Japanese yen, AUD - Australian dollar, CAD - Canadian dollar, SGD - Singapore dollar, HKD - Hong Kong dollar, PHP - Philippine peso, THB - Thai baht, CNH - offshore Chinese yuan","enum":["EUR","USD","CNY","GBP","JPY","AUD","CAD","SGD","HKD","PHP","THB","CNH"]},"receive_amount":{"type":"integer","description":"Amount received (the Collection party receives the Amount)","format":"int64"},"receive_currency":{"type":"string","description":"Currency: EUR - Euro, USD - United States dollar, CNY - Chinese yuan, GBP - British pound, JPY - Japanese yen, AUD - Australian dollar, CAD - Canadian dollar, SGD - Singapore dollar, HKD - Hong Kong dollar, PHP - Philippine peso, THB - Thai baht, CNH - offshore Chinese yuan","enum":["EUR","USD","CNY","GBP","JPY","AUD","CAD","SGD","HKD","PHP","THB","CNH"]},"to_account_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment method: FIX_PAY-fixed payment, FIX_RECEIVE-fixed collection"},"children":[]}]}]}],"enum":["FIX_PAY","FIX_RECEIVE"]},"type":{"type":"string","description":"Payment purpose PAY-payment, WITHDRAW-cash withdrawal","enum":["PAY","WITHDRAW"]}}}},"components/schemas/WithdrawalAccountCreateReq":{"id":"components/schemas/WithdrawalAccountCreateReq","kind":"json-schema","title":"WithdrawalAccountCreateReq","data":{"required":["acc_type","bank_card_no","bank_code","c_rsc_id"],"type":"object","properties":{"acc_type":{"type":"string","description":"AccountType: PRIVATE-Personal Account, COMPANY-Enterprise Corporate","enum":["PRIVATE","COMPANY"]},"bank_card_no":{"type":"string","description":"Bank card number (Unique under Merchant)"},"bank_code":{"type":"string","description":"BankCode(See attachmentBankCode)"},"branch_bank_code":{"type":"string","description":"Branch Code (See attachment Branch Code)"},"c_rsc_id":{"maxLength":32,"minLength":0,"type":"string","description":"Client-side resource id, Unique in the requesting system (length 32 characters)"},"license_pic_path_id":{"type":"integer","description":"Account Opening license image id-UploadFileAPIReturn id","format":"int32"},"phone":{"pattern":"^1[3-9]\\d{9}$","type":"string","description":"Bank reserved mobile phone number (length 11 digits)"},"proof_file_path_id":{"type":"integer","description":"Account Opening bill picture id-UploadFileAPIReturn id","format":"int32"}}}},"components/schemas/WithdrawalAccountGetRes":{"id":"components/schemas/WithdrawalAccountGetRes","kind":"json-schema","title":"WithdrawalAccountGetRes","data":{"required":["status","wdl_acc_id"],"type":"object","properties":{"msg":{"type":"string","description":"Result description, not empty when Failed"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ReviewStatus: UNDER_REVIEW-Review REFUSE-ReviewNot approved PASS-ReviewApproved PASS_UNUSED-ReviewApprovedNot use"},"children":[]}]}]}],"enum":["UNDER_REVIEW","REFUSE","PASS","PASS_UNUSED"]},"wdl_acc_id":{"type":"string","description":"Withdraw Accountid"}}}},"components/schemas/WithdrawalAccountNotification":{"id":"components/schemas/WithdrawalAccountNotification","kind":"json-schema","title":"WithdrawalAccountNotification","data":{"required":["c_rsc_id","merch_id","status","wdl_acc_id"],"type":"object","properties":{"c_rsc_id":{"type":"string","description":"Client resource id"},"merch_id":{"type":"string","description":"Merchantid"},"msg":{"type":"string","description":"Result description, not empty when Failed"},"request_id":{"maxLength":32,"minLength":1,"type":"string","description":"New API client side resource id"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ReviewStatus: UNDER_REVIEW-Review REFUSE-ReviewNot approved PASS-ReviewApproved PASS_UNUSED-ReviewApprovedNot use"},"children":[]}]}]}],"enum":["UNDER_REVIEW","REFUSE","PASS","PASS_UNUSED"]},"wdl_acc_id":{"type":"string","description":"Withdraw Accountid"}},"description":"Notification message content"}},"components/schemas/WithdrawalAccountReq":{"id":"components/schemas/WithdrawalAccountReq","kind":"json-schema","title":"WithdrawalAccountReq","data":{"required":["c_rsc_id"],"type":"object","properties":{"c_rsc_id":{"maxLength":32,"minLength":0,"type":"string","description":"Client-side resource id, Unique in the requesting system (length 32 characters)"}}}},"components/schemas/WithdrawalAccountRes":{"id":"components/schemas/WithdrawalAccountRes","kind":"json-schema","title":"WithdrawalAccountRes","data":{"required":["status"],"type":"object","properties":{"msg":{"type":"string","description":"Result description, not empty when Failed"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ReviewStatus: UNDER_REVIEW-Review REFUSE-ReviewNot approved PASS-ReviewApproved PASS_UNUSED-ReviewApprovedNot use"},"children":[]}]}]}],"enum":["UNDER_REVIEW","REFUSE","PASS","PASS_UNUSED"]},"wdl_acc_id":{"type":"string","description":"Withdraw Accountid"}}}},"components/schemas/WithdrawalAccountUpdateReq":{"id":"components/schemas/WithdrawalAccountUpdateReq","kind":"json-schema","title":"WithdrawalAccountUpdateReq","data":{"required":["acc_type","bank_card_no","bank_code","c_rsc_id"],"type":"object","properties":{"acc_type":{"type":"string","description":"AccountType: PRIVATE-Personal Account, COMPANY-Enterprise Corporate","enum":["PRIVATE","COMPANY"]},"bank_card_no":{"type":"string","description":"Bank card number (Unique under Merchant)"},"bank_code":{"type":"string","description":"BankCode(See attachmentBankCode)"},"branch_bank_code":{"type":"string","description":"Branch Code (See attachment Branch Code)"},"c_rsc_id":{"maxLength":32,"minLength":0,"type":"string","description":"Client-side resource id, Unique in the requesting system (length 32 characters)"},"license_pic_path_id":{"type":"integer","description":"Account Opening license image id-UploadFileAPIReturn id","format":"int32"},"phone":{"pattern":"^1[3-9]\\d{9}$","type":"string","description":"Bank reserved mobile phone number (length 11 digits)"},"proof_file_path_id":{"type":"integer","description":"Account Opening bill picture id-UploadFileAPIReturn id","format":"int32"}}}},"components/schemas/响应":{"id":"components/schemas/响应","kind":"json-schema","title":"响应","data":{"required":["ret_code","ret_msg"],"type":"object","properties":{"ret_code":{"type":"string","description":"Result representing Request processing"},"ret_msg":{"type":"string","description":"Result message processed on behalf of Request"}},"description":"Basic Response"}},"components/schemas/MerchVaApplyResultNotification":{"id":"components/schemas/MerchVaApplyResultNotification","kind":"json-schema","title":"MerchVaApplyResultNotification","data":{"required":["c_rsc_id","merch_id"],"type":"object","properties":{"account_no":{"type":"string","description":"Collection account"},"account_type":{"type":"string","description":"AccountType LOCAL-local, GLOBAL-global","enum":["LOCAL","GLOBAL"]},"ach_routing_number":{"type":"string","description":"achRoutingNumber"},"bank":{"type":"string","description":"Bank"},"bank_address":{"type":"string","description":"BankAddress"},"bank_name":{"type":"string","description":"BankName"},"bic":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"bic/swift_code"},"children":[]}]}]}]},"c_rsc_id":{"type":"string","description":"Client resource id"},"country_code":{"type":"string","description":"CollectionCountry, Return as is"},"currency":{"uniqueItems":true,"type":"array","description":"CollectionCurrency, Return as is","items":{"type":"string","description":"Currency: EUR - Euro, USD - United States dollar, CNY - Chinese yuan, GBP - British pound, JPY - Japanese yen, AUD - Australian dollar, CAD - Canadian dollar, SGD - Singapore dollar, HKD - Hong Kong dollar, PHP - Philippine peso, THB - Thai baht, CNH - offshore Chinese yuan","enum":["EUR","USD","CNY","GBP","JPY","AUD","CAD","SGD","HKD","PHP","THB","CNH"]}},"merch_id":{"type":"string","description":"Merchantid"},"request_id":{"maxLength":32,"minLength":1,"type":"string","description":"New API client side resource id"},"routing_number":{"type":"string","description":"routingNumber"},"status":{"type":"string","description":"AccountStatus: ENABLED-enabled, DISABLED-disabled, PENDING-pending Review, REJECTED-ReviewRejected","enum":["ENABLED","DISABLED","PENDING","REJECTED"]},"wire_routing_number":{"type":"string","description":"wireRoutingNumber"}},"description":"Notification message content"}},"components/schemas/NotificationDtoMerchVaApplyResultNotification":{"id":"components/schemas/NotificationDtoMerchVaApplyResultNotification","kind":"json-schema","title":"NotificationDtoMerchVaApplyResultNotification","data":{"required":["data","type"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/MerchVaApplyResultNotification"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BusinessType: MERCH-Merchant, VA-Virtual Account, INCOMING_REMITTANCE-Import Remittance, CONTRACT_ORDER-ContractOrder, TRADE_SETTLE-SettlementCrediting, PAYEE-Collection, WD_ACCOUNT-Withdraw Account, CUR_EXCHANGE-FX, PAYMENT-Payment"},"children":[]}]}]}],"enum":["MERCH","VA","INCOMING_REMITTANCE","CONTRACT_ORDER","TRADE_SETTLE","PAYEE","WD_ACCOUNT","FOREX","PAYMENT"]}}}},"components/schemas/WdAccV2Info":{"id":"components/schemas/WdAccV2Info","kind":"json-schema","title":"WdAccV2Info","data":{"required":["contact_phone_region","country","payee_type"],"type":"object","properties":{"address":{"type":"string","description":"BankAccount holder Address(Optional)"},"cert_no":{"maxLength":100,"minLength":0,"type":"string","description":"ID Document number (domestic personal AccountRequired) (Max 100 characters)"},"cert_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Collection Person ID DocumentType (Domestic Personal AccountRequired): ID_CARD-ID Card PASSPORT-Passport"},"children":[]}]}]}],"enum":["ID_CARD","PASSPORT"]},"city":{"type":"string","description":"City(overseas required)"},"contact_email":{"maxLength":100,"minLength":0,"type":"string","description":"ContactEmail(Max 100 characters)"},"contact_name":{"maxLength":100,"minLength":0,"type":"string","description":"Contact name(Max 100 characters)"},"contact_phone":{"pattern":"^1[3-9]\\d{9}$","type":"string","description":"ContactPhone (up to 11 digits)"},"contact_phone_region":{"maxLength":3,"minLength":0,"type":"string","description":"Prefix code (length no more than 3 characters)"},"country":{"type":"string","description":"Country code, Use ISO3166-2 standard 2-digit Country code, non-sanctioned Country (See appendix)"},"nick_name":{"maxLength":100,"minLength":0,"type":"string","description":"Nickname(Max 100 characters)"},"payee_first_name":{"maxLength":100,"minLength":1,"type":"string","description":"Collection person first name (Overseas Collection person Required) (Max 100 characters)"},"payee_last_name":{"maxLength":100,"minLength":1,"type":"string","description":"Collection person last name (Overseas Collection person Required) (Max 100 characters)"},"payee_name":{"maxLength":100,"minLength":1,"type":"string","description":"Collection person's name (domestic Collection person Required) (Max 100 characters)"},"payee_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CollectionType PFG-payment LWF-Logistics warehousing fee ASF-advertising service fee TSF-technical service fee CSF-consulting service fee OTHER-Other Data dictionary:PAYEE_TYPE"},"children":[]}]}]}],"enum":["PFG","LWF","ASF","TSF","CSF","OTHER"]},"payee_type_desc":{"maxLength":100,"minLength":0,"type":"string","description":"CollectionType description, Required for OtherCollectionType (Max 100 characters)"},"province":{"type":"string","description":"State/Province (US/Canada/Mexico Required)"},"uni_social_credit":{"maxLength":100,"minLength":0,"type":"string","description":"Unified Social Credit Code (domestic corporate AccountRequired) (Max 100 characters)"},"website":{"maxLength":100,"minLength":0,"type":"string","description":"Website(Max 100 characters)"},"zip_code":{"type":"string","description":"Postal code (required overseas)"}},"description":"Withdraw AccountInformation"}},"components/schemas/WithdrawalAccountCreateV2Req":{"id":"components/schemas/WithdrawalAccountCreateV2Req","kind":"json-schema","title":"WithdrawalAccountCreateV2Req","data":{"required":["request_id"],"type":"object","properties":{"request_id":{"maxLength":32,"minLength":1,"type":"string","description":"Request number, Unique within the requesting system"},"wd_acc_v2_info":{"$ref":"#/components/schemas/WdAccV2Info"},"bank_acc_v2_info":{"$ref":"#/components/schemas/BankAccV2Info"},"license_pic_path_id":{"type":"integer","description":"Account Opening license image id-UploadFileAPIReturn id","format":"int32"},"proof_file_path_id":{"type":"integer","description":"Account Opening bill picture id-UploadFileAPIReturn id","format":"int32"}}}},"components/schemas/WithdrawalAccountUpdateV2Req":{"id":"components/schemas/WithdrawalAccountUpdateV2Req","kind":"json-schema","title":"WithdrawalAccountUpdateV2Req","data":{"required":["request_id"],"type":"object","properties":{"bank_acc_v2_info":{"$ref":"#/components/schemas/BankAccV2Info"},"license_pic_path_id":{"type":"integer","description":"Account Opening license image id-UploadFileAPIReturn id","format":"int32"},"proof_file_path_id":{"type":"integer","description":"Account Opening bill picture id-UploadFileAPIReturn id","format":"int32"},"request_id":{"maxLength":32,"minLength":1,"type":"string","description":"Client-side resource id, Unique in the requesting system (length 32 characters)"},"wd_acc_v2_info":{"$ref":"#/components/schemas/WdAccV2Info"}}}},"components/schemas/ContractOrderGetV2Req":{"id":"components/schemas/ContractOrderGetV2Req","kind":"json-schema","title":"ContractOrderGetV2Req","data":{"required":["request_id"],"type":"object","properties":{"request_id":{"maxLength":32,"minLength":1,"type":"string","description":"Request number, Unique within the requesting system"}}}},"components/schemas/ContractOrderNotificationV2":{"id":"components/schemas/ContractOrderNotificationV2","kind":"json-schema","title":"ContractOrderNotificationV2","data":{"required":["contract_order_id","merch_id","request_id","status"],"type":"object","properties":{"request_id":{"maxLength":32,"minLength":1,"type":"string","description":"Request number, Unique within the requesting system"},"merch_id":{"type":"string","description":"Merchantid"},"contract_order_id":{"type":"string","description":"ContractOrderNumber"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Open platform ContractOrderStatus PENDING-to be reviewed REJECT-Not approved PASS-Approved ALL_RELATED-collect all"},"children":[]}]}]}],"enum":["PENDING","REJECT","PASS","ALL_RELATED"]},"reason":{"type":"string","description":"ReviewRejectedReason"}},"description":"Notification message content"}},"components/schemas/NotificationDtoContractOrderNotificationV2":{"id":"components/schemas/NotificationDtoContractOrderNotificationV2","kind":"json-schema","title":"NotificationDtoContractOrderNotificationV2","data":{"required":["data","type"],"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BusinessType: MERCH-Merchant, VA-Virtual Account, INCOMING_REMITTANCE-Import Remittance, CONTRACT_ORDER-ContractOrder, TRADE_SETTLE-SettlementCrediting, PAYEE-Collection, WD_ACCOUNT-Withdraw Account, CUR_EXCHANGE-FX, PAYMENT-Payment"},"children":[]}]}]}],"enum":["MERCH","VA","INCOMING_REMITTANCE","CONTRACT_ORDER","TRADE_SETTLE","PAYEE","WD_ACCOUNT","FOREX","PAYMENT"]},"data":{"$ref":"#/components/schemas/ContractOrderNotificationV2"}}}},"components/schemas/OpenPlatformCommonV2Req":{"id":"components/schemas/OpenPlatformCommonV2Req","kind":"json-schema","title":"OpenPlatformCommonV2Req","data":{"required":["request_id"],"type":"object","properties":{"request_id":{"maxLength":32,"minLength":1,"type":"string","description":"Request number, Unique within the requesting system"}}}},"components/schemas/PaymentConfirmV2Req":{"id":"components/schemas/PaymentConfirmV2Req","kind":"json-schema","title":"PaymentConfirmV2Req","data":{"required":["confirm_token","postscript","request_id"],"type":"object","properties":{"request_id":{"maxLength":32,"minLength":1,"type":"string","description":"Request number, Unique within the requesting system"},"confirm_token":{"type":"string","description":"Upload the original value returned by the Pre-order API"},"postscript":{"maxLength":64,"minLength":0,"type":"string","description":"P.S. Bank payment Remark (length 64 characters)"}}}},"components/schemas/MerchVaGetV2Req":{"id":"components/schemas/MerchVaGetV2Req","kind":"json-schema","title":"MerchVaGetV2Req","data":{"required":["request_id"],"type":"object","properties":{"request_id":{"maxLength":32,"minLength":1,"type":"string","description":"Request number, Unique within the requesting system"}}}},"components/schemas/MerchVaCreateV2Req":{"id":"components/schemas/MerchVaCreateV2Req","kind":"json-schema","title":"MerchVaCreateV2Req","data":{"required":["type","currency","region","request_id","remark_name"],"type":"object","properties":{"request_id":{"maxLength":32,"minLength":1,"type":"string","description":"Request number, Unique within the requesting system"},"region":{"type":"string","description":"CollectionCountry/Region, Use ISO3166-2 standard 2-digit Country/Region code (global Account currently only supports HK, local AccountSupport's CollectionCountrySee attachment)"},"type":{"type":"string","description":"AccountType LOCAL-local,SWIFT-global","enum":["LOCAL","SWIFT"]},"currency":{"type":"string","description":"CollectionAccountCurrencyType, Single Currency: UseISO-4217 standard 3-digit Currency code, Multiple Currency: MUL"},"remark_name":{"type":"string","description":"CollectionAccountRemark name","minLength":1,"maxLength":20}}}},"components/schemas/MerchVaApplyRes":{"id":"components/schemas/MerchVaApplyRes","kind":"json-schema","title":"MerchVaApplyRes","data":{"required":["account_no","type","bank_address","bank_name","bic_swift_code","request_id","country_code","currencies","account_holder_name","status"],"type":"object","properties":{"request_id":{"type":"string","description":"Request number, Unique within the requesting system","maxLength":32,"minLength":1},"type":{"type":"string","description":"AccountType LOCAL-local,SWIFT-global","enum":["LOCAL","GLOBAL"]},"country_code":{"type":"string","description":"CollectionCountry, Return as is"},"currencies":{"uniqueItems":true,"type":"array","description":"CollectionCurrency, Return as is","items":{"type":"string","description":"Currency: EUR - Euro, USD - United States dollar, CNY - Chinese yuan, GBP - British pound, JPY - Japanese yen, AUD - Australian dollar, CAD - Canadian dollar, SGD - Singapore dollar, HKD - Hong Kong dollar, PHP - Philippine peso, THB - Thai baht, CNH - offshore Chinese yuan","enum":["EUR","USD","CNY","GBP","JPY","AUD","CAD","SGD","HKD","PHP","CNH"]}},"account_no":{"maxLength":20,"minLength":0,"type":"string","description":"Collection account (length 20 characters)"},"status":{"type":"string","description":"AccountStatus: ENABLED-enabled, PENDING-pending Review, REJECTED-ReviewRejected","enum":["ENABLED","DISABLED","PENDING","REJECTED"]},"bank_name":{"maxLength":64,"minLength":0,"type":"string","description":"BankName (length 64 characters)"},"bank_address":{"maxLength":128,"minLength":0,"type":"string","description":"BankAddress (length 128 characters)"},"account_holder_name":{"maxLength":100,"minLength":0,"type":"string","description":"Account holder (100 characters)"},"bic_swift_code":{"maxLength":16,"minLength":0,"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"bic/swift_code (length 16 characters)"},"children":[]}]}]}]},"routing_number":{"type":"string","description":"routing number/ach routing number/wire routing number three returns one"}}}},"components/schemas/AttachmentInfos":{"id":"components/schemas/AttachmentInfos","kind":"json-schema","title":"AttachmentInfos","data":{"type":"object","properties":{"other_file_ids":{"maxItems":7,"minItems":0,"type":"array","description":"AttachmentFileid up to 7","items":{"type":"integer","description":"AttachmentFileid up to 7","format":"int32"}},"contract_file_id":{"type":"integer","description":"ContractFile-UploadFileAPIReturn id (Contract/PI/LogisticsFile must pass one)","format":"int32"},"logistics_file_id":{"type":"integer","description":"LogisticsFile-UploadFileAPIReturn id (Contract/PI/LogisticsFile must pass one)","format":"int32"},"pi_file_id":{"type":"integer","description":"PIFileid-UploadFileAPIReturn id (Contract/PI/LogisticsFile must pass one)","format":"int32"}},"description":"Material, AttachmentInformation"}},"components/schemas/PayeeCreateV2Req":{"id":"components/schemas/PayeeCreateV2Req","kind":"json-schema","title":"PayeeCreateV2Req","data":{"required":["bank_acc","beneficiary","type","request_id"],"type":"object","properties":{"request_id":{"maxLength":32,"minLength":1,"type":"string","description":"Request number, Unique within the requesting system"},"type":{"type":"string","description":"Purpose (Required): PAYMENT-Collection, WITHDRAWAL-Withdrawal"},"beneficiary":{"type":"object","properties":{"purpose":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CollectionType PFG-payment LWF-Logistics warehousing fee ASF-advertising service fee TSF-technical service fee CSF-consulting service fee OTHER-Other Data dictionary:PAYEE_TYPE"},"children":[]}]}]}],"enum":["PFG","LWF","ASF","TSF","CSF","OTHER"]},"purpose_desc":{"maxLength":100,"minLength":0,"type":"string","description":"CollectionType description, Required when OtherCollectionType (Max 100 characters), Required when purpose is OTHER"},"country":{"type":"string","description":"Country code, Use ISO3166-2 standard 2-digit Country code, non-sanctioned Country (See appendix)"},"industry":{"type":"integer","description":"Mainly engaged in Industry (See attachment), Required when the company has a public account and is a member of the Collection","format":"int32"},"main_industry":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Main Industrycode (see new IndustryAttachment), Required when the company Account is a Collection member, and one of industry and main_industryRequired; subsequent versions of industry will be abandoned, please modify it as soon as possible"},"children":[]}]}]}]},"sub_industry":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sub-camp Industrycode (see new IndustryAttachment), can be passed when main_industryRequired"},"children":[]}]}]}]},"nick_name":{"maxLength":100,"minLength":0,"type":"string","description":"Account nickname(Max 100 characters)"},"first_name":{"maxLength":100,"minLength":1,"type":"string","description":"Beneficiary first name (Overseas Collection person-to-private Required) (Max 100 characters)"},"last_name":{"maxLength":100,"minLength":1,"type":"string","description":"Beneficiary last name (overseas Collection person-to-private Required) (Max 100 characters)"},"doc_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID DocumentType (domestic individual AccountRequired), domestic individual AccountRequired and is ID_CARD"},"children":[]}]}]}]},"id_number":{"maxLength":100,"minLength":0,"type":"string","description":"ID Document number (domestic personal AccountRequired) (Max 100 characters)"},"uni_social_credit":{"maxLength":18,"minLength":0,"type":"string","description":"Unified Social Credit Code (domestic corporate AccountRequired) (Max 18 characters)"},"address":{"type":"object","properties":{"province":{"type":"string","description":"State/Province (United States/Canada/Mexico and BankCurrencyAccount is not CNYRequired)"},"city":{"maxLength":50,"minLength":0,"type":"string","description":"City(overseas required)"},"zipcode":{"maxLength":20,"minLength":0,"type":"string","description":"Postal code (required overseas)"},"address1":{"maxLength":50,"minLength":0,"type":"string","description":"BankAccount holder Address (overseas Required)"},"address2":{"type":"string","description":"Address line 2"}},"description":"BeneficiaryAddressInformation","required":["province","city","zipcode","address1"]}},"description":"CollectionPeopleInformation","required":["purpose","country"]},"bank_acc":{"description":"BankAccountInformation","type":"object","properties":{"country":{"maxLength":2,"minLength":0,"type":"string","description":"Country code, Use ISO3166-2 standard 2-digit Country code, non-sanctioned Country (See appendix)"},"currency":{"type":"string","description":"Currency: EUR - Euro, USD - United States dollar, CNY - Chinese yuan, GBP - British pound, JPY - Japanese yen, AUD - Australian dollar, CAD - Canadian dollar, SGD - Singapore dollar, HKD - Hong Kong dollar, PHP - Philippine peso, THB - Thai baht, CNH - offshore Chinese yuan","enum":["EUR","USD","CNY","GBP","JPY","AUD","CAD","SGD","HKD","PHP","THB","CNH"]},"acc_name":{"maxLength":100,"minLength":1,"type":"string","description":"AccountName(Max 100 characters)"},"acc_type":{"type":"string","description":"AccountType: PRIVATE-Personal Account, COMPANY-Enterprise Corporate","enum":["PRIVATE","COMPANY"]},"acc_no":{"maxLength":100,"minLength":0,"type":"string","description":"Bank account number, choose one from accNo or iban"},"payment_type":{"type":"string","description":"Payment clearing network: LOCAL - local payment, SWIFT - international payment","enum":["LOCAL","SWIFT"]},"routing_code_type1":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must when LOCAL clearing network (the enumeration value will be expanded as the business develops): ABA (local payment network code in the United States), FASTER_PAYMENT (local payment network code in the United Kingdom), CHAPS (local payment network code in the United Kingdom), SORT_CODE, BANK_CODE (see BankCodeAttachment for details within the country, and fill it out truthfully in Canada)"},"children":[]}]}]}]},"routing_code_value1":{"type":"string","description":"Must when routingCodeType1 is not empty"},"routing_code_type2":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LOCAL clearing network sub-Type (the enumeration value will be expanded as the business develops): BRANCH_BANK_CODE (see BankCodeAttachment for details within the country, and fill in the details truthfully for overseas countries such as Canada)"},"children":[]}]}]}]},"routing_code_value2":{"type":"string","description":"Must when routingCodeType2 is not empty"},"iban":{"maxLength":50,"minLength":0,"type":"string","description":"IBAN, unique to Eurozone Accounts, choose one from accNo or iban"},"bic_swift":{"type":"string","description":"swift code or bic, when SWIFT clears the network, other countries and regions require Upload this Field (only supports 8 or 11 bits)","maxLength":11,"minLength":8,"example":"ABCDEFGH"},"bank_acc_type":{"type":"string","description":"BankAccountType CHECKING-Cheque SAVINGS-Debit Card","enum":["CHECKING","SAVINGS"]},"bank_addr":{"maxLength":100,"minLength":0,"type":"string","description":"Account OpeningBankDetailedAddress(overseas AccountRequired)(Max 100 characters)"},"bank_name":{"maxLength":100,"minLength":0,"type":"string","description":"Account OpeningBankName(overseas AccountRequired; Max 100 characters)"},"branch_bank_name":{"maxLength":100,"minLength":0,"type":"string","description":"Account OpeningBank Branch Name(Max 100 characters)"},"phone":{"type":"string","description":"Bank reserved mobile phone number (Mainland RMB private cash withdrawal)","maxLength":11,"minLength":11,"example":"13800138000"},"province":{"maxLength":10,"minLength":0,"type":"string","description":"Account OpeningBank belongs to Province (domestic Enterprise to corporate AccountRequired, See attachment)"},"city":{"maxLength":10,"minLength":0,"type":"string","description":"City to which Account OpeningBank belongs (domestic Enterprise to corporate AccountRequired, See attachment)"},"district":{"maxLength":10,"minLength":0,"type":"string","description":"Account OpeningBank belongs to the district (domestic Enterprise to corporate AccountRequired, See attachment)"}},"required":["country","currency","acc_name","acc_type","payment_type"]},"attachment":{"description":"OtherFileAttachment","type":"object","properties":{"other_file_ids":{"maxItems":7,"minItems":0,"type":"array","description":"AttachmentFileid up to 7","items":{"type":"integer","description":"AttachmentFileid up to 7","format":"int32"}},"contract_file_id":{"type":"integer","description":"ContractFile-UploadFileAPIReturn id (Contract/PI/LogisticsFile must pass one)","format":"int32"},"logistics_file_id":{"type":"integer","description":"LogisticsFile-UploadFileAPIReturn id (Contract/PI/LogisticsFile must pass one)","format":"int32"},"pi_file_id":{"type":"integer","description":"PIFileid-UploadFileAPIReturn id (Contract/PI/LogisticsFile must pass one)","format":"int32"}}}}}},"components/schemas/PayeeV2Info":{"id":"components/schemas/PayeeV2Info","kind":"json-schema","title":"PayeeV2Info","data":{"required":["country","purpose"],"type":"object","properties":{"purpose":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CollectionType PFG-payment LWF-Logistics warehousing fee ASF-advertising service fee TSF-technical service fee CSF-consulting service fee OTHER-Other Data dictionary:PAYEE_TYPE"},"children":[]}]}]}],"enum":["PFG","LWF","ASF","TSF","CSF","OTHER"]},"purpose_desc":{"maxLength":100,"minLength":0,"type":"string","description":"CollectionType description, Required when OtherCollectionType (Max 100 characters), Required when purpose is OTHER"},"country":{"type":"string","description":"Country code, Use ISO3166-2 standard 2-digit Country code, non-sanctioned Country (See appendix)"},"industry":{"type":"integer","description":"Mainly engaged in Industry (See attachment), Required when the company has a public account and is a member of the Collection","format":"int32"},"main_industry":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Main Industrycode (see new IndustryAttachment), Required when the company Account is a Collection member, and one of industry and main_industryRequired; subsequent versions of industry will be abandoned, please modify it as soon as possible"},"children":[]}]}]}]},"sub_industry":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sub-camp Industrycode (see new IndustryAttachment), can be passed when main_industryRequired"},"children":[]}]}]}]},"nick_name":{"maxLength":100,"minLength":0,"type":"string","description":"Account nickname(Max 100 characters)"},"first_name":{"maxLength":100,"minLength":1,"type":"string","description":"Beneficiary first name (Overseas Collection person-to-private Required) (Max 100 characters)"},"last_name":{"maxLength":100,"minLength":1,"type":"string","description":"Beneficiary last name (overseas Collection person-to-private Required) (Max 100 characters)"},"doc_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID DocumentType (domestic individual AccountRequired), domestic individual AccountRequired and is ID_CARD"},"children":[]}]}]}]},"id_number":{"maxLength":100,"minLength":0,"type":"string","description":"ID Document number (domestic personal AccountRequired) (Max 100 characters)"},"uni_social_credit":{"maxLength":18,"minLength":0,"type":"string","description":"Unified Social Credit Code (domestic corporate AccountRequired) (Max 18 characters)"},"address":{"type":"object","properties":{"province":{"type":"string","description":"State/Province (United States/Canada/Mexico and BankCurrencyAccount is not CNYRequired)"},"city":{"maxLength":50,"minLength":0,"type":"string","description":"City(overseas required)"},"zipcode":{"maxLength":20,"minLength":0,"type":"string","description":"Postal code (required overseas)"},"address1":{"maxLength":50,"minLength":0,"type":"string","description":"BankAccount holder Address (overseas Required)"},"address2":{"type":"string","description":"Address line 2"}},"required":["province","city","address1","zipcode"],"description":"BeneficiaryAddressInformation"}},"description":"CollectionPeopleInformation"}},"components/schemas/PayeeRes":{"id":"components/schemas/PayeeRes","kind":"json-schema","title":"PayeeRes","data":{"required":["status"],"type":"object","properties":{"msg":{"type":"string","description":"Result description, not empty when Failed"},"payee_id":{"type":"string","description":"Collection person id, only Return after CreateSuccessful and ReviewApproved; ApprovedSpecifyCollection person id can be used during Payment InitiatePayment","minLength":0,"maxLength":20},"status":{"type":"string","description":"PayerReviewStatus PENDING-Pending Review NORMAL-Normal REJECTED-ReviewNot approved","enum":["PENDING","NORMAL","REJECTED"]}}}},"components/schemas/PayeeUpdateV2Req":{"id":"components/schemas/PayeeUpdateV2Req","kind":"json-schema","title":"PayeeUpdateV2Req","data":{"required":["bank_acc","beneficiary","type","request_id"],"type":"object","properties":{"request_id":{"maxLength":32,"minLength":1,"type":"string","description":"Request number, Unique within the requesting system"},"type":{"type":"string","description":"Purpose (Required): PAYMENT-Collection, WITHDRAWAL-Withdrawal"},"beneficiary":{"$ref":"#/components/schemas/PayeeV2Info","description":"CollectionPeopleInformation"},"bank_acc":{"$ref":"#/components/schemas/BankAccV2Info","description":"BankAccountInformation"},"attachment":{"$ref":"#/components/schemas/AttachmentInfos","description":"OtherFileAttachment"}}}},"components/schemas/MerchPayeeNotificationV2":{"id":"components/schemas/MerchPayeeNotificationV2","kind":"json-schema","title":"MerchPayeeNotificationV2","data":{"required":["merch_id","payee_id","type","request_id","status"],"type":"object","properties":{"request_id":{"maxLength":32,"minLength":1,"type":"string","description":"Request number, Unique within the requesting system"},"merch_id":{"type":"string","description":"Merchantid","minLength":1,"maxLength":20},"type":{"type":"string","description":"Purpose (Required): PAYMENT-Collection, WITHDRAWAL-Withdrawal"},"payee_id":{"type":"string","description":"Collection person id","minLength":1,"maxLength":20},"status":{"type":"string","description":"PayerReviewStatus PENDING-Pending Review NORMAL-Normal REJECTED-ReviewNot approved","enum":["PENDING","NORMAL","REJECTED"]},"msg":{"type":"string","description":"Result description, not empty when Failed"}},"description":"Notification message content"}},"components/schemas/Account":{"id":"components/schemas/Account","kind":"json-schema","title":"Account","data":{"required":["balance","currency"],"type":"object","properties":{"balance":{"type":"integer","description":"Balance(CurrencyMinimum Unit)","format":"int64"},"currency":{"type":"string","description":"Currency: EUR - Euro, USD - United States dollar, CNY - Chinese yuan, GBP - British pound, JPY - Japanese yen, AUD - Australian dollar, CAD - Canadian dollar, SGD - Singapore dollar, HKD - Hong Kong dollar, PHP - Philippine peso, CNH - offshore Chinese yuan","enum":["EUR","USD","CNY","GBP","JPY","AUD","CAD","SGD","HKD","PHP","CNH"]}},"description":"List"}},"components/schemas/IncomingRemittanceNotification":{"id":"components/schemas/IncomingRemittanceNotification","kind":"json-schema","title":"IncomingRemittanceNotification","data":{"required":["amount","currency","order_no","merch_id","recv_account","recv_time"],"type":"object","properties":{"merch_id":{"type":"string","description":"CollectionMerchantid","minLength":1,"maxLength":20},"order_no":{"type":"string","description":"paykkaCollection order number"},"amount":{"type":"integer","description":"Import RemittanceAmount, minimum Currency unit","format":"int64"},"currency":{"type":"string","description":"Currency: EUR - Euro, USD - United States dollar, CNY - Chinese yuan, GBP - British pound, JPY - Japanese yen, AUD - Australian dollar, CAD - Canadian dollar, SGD - Singapore dollar, HKD - Hong Kong dollar, PHP - Philippine peso, THB - Thai baht, CNH - offshore Chinese yuan","enum":["EUR","USD","CNY","GBP","JPY","AUD","CAD","SGD","HKD","PHP","THB","CNH"]},"payer":{"type":"string","description":"Payer"},"payment_account":{"type":"string","description":"Payment account"},"payer_bank_bic":{"type":"string","description":"PaymentBankBIC"},"payer_bank_name":{"type":"string","description":"PayerBankName"},"payee":{"type":"string","description":"Collection people"},"recv_account":{"type":"string","description":"Collection account"},"recv_time":{"type":"string","description":"CollectionTime","format":"date-time"},"remark":{"type":"string","description":"P.S."}},"description":"Notification message content"}},"components/schemas/NotificationDtoIncomingRemittanceNotification":{"id":"components/schemas/NotificationDtoIncomingRemittanceNotification","kind":"json-schema","title":"NotificationDtoIncomingRemittanceNotification","data":{"required":["data","type","version"],"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BusinessType: MERCH-Merchant, VA-Virtual Account, INCOMING_REMITTANCE-Import Remittance, CONTRACT_ORDER-ContractOrder, TRADE_SETTLE-SettlementCrediting, PAYEE-Collection, WD_ACCOUNT-Withdraw Account, CUR_EXCHANGE-FX, PAYMENT-Payment"},"children":[]}]}]}],"enum":["MERCH","VA","INCOMING_REMITTANCE","CONTRACT_ORDER","TRADE_SETTLE","PAYEE","WD_ACCOUNT","FOREX","PAYMENT"]},"version":{"type":"string","description":"Version number (V1, V2,...)"},"data":{"type":"object","properties":{"merch_id":{"type":"string","description":"CollectionMerchantid","minLength":1,"maxLength":20},"order_no":{"type":"string","description":"paykkaCollection order number"},"amount":{"type":"integer","description":"Import RemittanceAmount, minimum Currency unit","format":"int64"},"currency":{"type":"string","description":"Currency: EUR - Euro, USD - United States dollar, CNY - Chinese yuan, GBP - British pound, JPY - Japanese yen, AUD - Australian dollar, CAD - Canadian dollar, SGD - Singapore dollar, HKD - Hong Kong dollar, PHP - Philippine peso, CNH - offshore Chinese yuan","enum":["EUR","USD","CNY","GBP","JPY","AUD","CAD","SGD","HKD","PHP","CNH"]},"payer":{"type":"string","description":"Payer"},"payment_account":{"type":"string","description":"Payment account"},"payer_bank_bic":{"type":"string","description":"PaymentBankBIC"},"payer_bank_name":{"type":"string","description":"PayerBankName"},"payee":{"type":"string","description":"Collection people"},"recv_account":{"type":"string","description":"Collection account"},"recv_time":{"type":"string","description":"CollectionTime","format":"date-time"},"remark":{"type":"string","description":"P.S."}},"required":["merch_id","order_no","amount","currency","recv_account","recv_time"]}}}},"components/schemas/GoodsInfo":{"id":"components/schemas/GoodsInfo","kind":"json-schema","title":"GoodsInfo","data":{"required":["category","name","custom_dec_info","url"],"type":"object","properties":{"category":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product Category (Support’s Product CategorySee attachment)"},"children":[]}]}]}],"format":"int32"},"name":{"maxLength":128,"minLength":1,"type":"string","description":"Product Name(Max 128 characters)"},"quantity":{"type":"integer","description":"Product quantity","format":"int64"},"url":{"type":"string","description":"Product URL","maxLength":256,"minLength":1},"custom_dec_info":{"type":"object","properties":{"dec_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Declaration method: METHOD_1-Not reported at the customs or Not included in the customs statistics for e-commerce TransactionOrder METHOD_2-Declared for export at the customs according to the general trade method"},"children":[]}]}]}]},"dec_no":{"type":"string","description":"Customs declaration number (Max 32 characters)","minLength":0,"maxLength":32}},"required":["dec_method"],"description":"Customs declarationInformation"}},"description":"ProductInformation"}},"components/schemas/ContractOrderCreateV2Req":{"id":"components/schemas/ContractOrderCreateV2Req","kind":"json-schema","title":"ContractOrderCreateV2Req","data":{"required":["amount","buyer_country","buyer_name","contract_file_ids","contract_no","currency","goods_info","invoice_file_ids","is_exchange_settle","logistics_info","order_date","request_id"],"type":"object","properties":{"request_id":{"maxLength":32,"minLength":1,"type":"string","description":"Request number, Unique within the requesting system"},"buyer_country":{"type":"string","description":"Buy country code, Use ISO3166-2 standard 2-digit country code (See appendix)"},"buyer_name":{"maxLength":128,"minLength":1,"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Buyer’s name (Max 128 characters)"},"children":[]}]}]}]},"amount":{"type":"integer","description":"OrderAmount(CurrencyMinimum Unit)","format":"int64"},"currency":{"type":"string","description":"Currency: EUR - Euro, USD - United States dollar, CNY - Chinese yuan, GBP - British pound, JPY - Japanese yen, AUD - Australian dollar, CAD - Canadian dollar, SGD - Singapore dollar, HKD - Hong Kong dollar, PHP - Philippine peso, CNH - offshore Chinese yuan","enum":["EUR","USD","CNY","GBP","JPY","AUD","CAD","SGD","HKD","PHP","CNH"]},"contract_no":{"maxLength":32,"minLength":1,"type":"string","description":"ContractNumber(Max 32 characters)(can only be numbers and letters)(Unique under Merchant)"},"contract_file_ids":{"maxItems":10,"minItems":1,"type":"array","description":"ContractAttachmentid-UploadFileAPIReturn id (up to 10 Files)","items":{"type":"integer","description":"ContractAttachmentid-UploadFileAPIReturn id (up to 10 Files)","format":"int32"}},"goods_info":{"type":"object","properties":{"category":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product Category (Support’s Product CategorySee attachment)"},"children":[]}]}]}],"format":"int32"},"name":{"maxLength":128,"minLength":1,"type":"string","description":"Product Name(Max 128 characters)"},"quantity":{"type":"integer","description":"Product quantity","format":"int64"},"url":{"type":"string","description":"Product URL","maxLength":256,"minLength":1},"custom_dec_info":{"type":"object","properties":{"dec_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Declaration method: METHOD_1-Not reported at the customs or Not included in the customs statistics for e-commerce TransactionOrder METHOD_2-Declared for export at the customs according to the general trade method"},"children":[]}]}]}]},"dec_no":{"type":"string","description":"Customs declaration number (Max 32 characters)","minLength":0,"maxLength":32}},"required":["dec_method"],"description":"Customs declarationInformation"}},"description":"ProductInformation","required":["category","name","url","custom_dec_info"]},"invoice_file_ids":{"maxItems":10,"minItems":1,"type":"array","description":"PI/CI/Invoice id-UploadFileAPIReturnid (up to 10 Files)","items":{"type":"integer","description":"PI/CI/Invoice id-UploadFileAPIReturnid (up to 10 Files)","format":"int32"}},"is_exchange_settle":{"type":"boolean","description":"Whether settlement of foreign exchange is Required"},"logistics_info":{"$ref":"#/components/schemas/LogisticsInfo"},"order_date":{"type":"string","description":"OrderTime Format: yyyy-MM-dd","format":"date"},"remark":{"maxLength":128,"minLength":0,"type":"string","description":"Remark (length 128 characters)"},"other_file_ids":{"type":"array","description":"OtherAttachmentid-UploadFileAPIReturn id","items":{"type":"integer","description":"OtherAttachmentid-UploadFileAPIReturn id","format":"int32"}}}}},"components/schemas/LogisticsInfo":{"id":"components/schemas/LogisticsInfo","kind":"json-schema","title":"LogisticsInfo","data":{"required":["ship_status","transaction_type"],"type":"object","properties":{"buyer_type":{"type":"string","description":"NEW-New Buyer's home;OLD-Old Buyer's home","enum":["NEW","OLD"]},"destination":{"maxLength":256,"minLength":1,"type":"string","description":"Destination must be passed when shipping (Max 256 characters)"},"expected_ship_date":{"type":"string","description":"Must be passed when ShippingDate Not shipping is expected. Format:yyyy-MM-dd","format":"date-time"},"freight_arrange_file_ids":{"maxItems":10,"minItems":1,"type":"array","description":"Freight arrangement communication record id-UploadFileAPIReturnid (up to 10 Files), must be passed to the new Buyer","items":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Freight arrangement communication record id-UploadFileAPIReturnid Must be transmitted when LogisticsStatus=UNSHIPPED (maximum 10 Files)"},"children":[]}]}]}],"format":"int32"}},"latest_order_file_ids":{"maxItems":10,"minItems":1,"type":"array","description":"The customs declaration form or outbound logistics voucher id-UploadFileAPIReturnid of the most recent transaction between Merchant and the Buyer must be passed to the old Buyer (up to 10 Files)","items":{"type":"integer","description":"The customs declaration form or outbound logistics voucher id-UploadFileAPIReturnid of the most recent transaction between Merchant and the Buyer must be passed to the old Buyer (up to 10 Files)","format":"int32"}},"logistics_company_name":{"maxLength":256,"minLength":1,"type":"string","description":"Logistics company name must be passed when shipping (Max 256 characters)"},"outbound_no":{"maxLength":32,"minLength":1,"type":"string","description":"Outbound Logistics tracking number must be sent when shipping ((Max 32 characters)"},"inquiry_records_file_ids":{"maxItems":10,"minItems":1,"type":"array","description":"Inquiry and order communication record-UploadFileAPIReturn id (up to 10 Files), must be passed to the new Buyer","items":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Inquiry and order communication record - UploadFileAPIReturn must be transmitted when the id LogisticsStatus=UNSHIPPED (up to 10 Files)"},"children":[]}]}]}],"format":"int32"}},"ship_date":{"type":"string","description":"ShippingDate must be passed when shipping Format:yyyy-MM-dd","format":"date-time"},"ship_status":{"type":"string","description":"LogisticsStatus: SHIPPED-Shipping UNSHIPPED-Not shipping","enum":["SHIPPED","UNSHIPPED"]},"shipped_file_ids":{"maxItems":10,"minItems":1,"type":"array","description":"Shipping voucher id-the id of UploadFileAPIReturn must be passed when shipping (up to 10 Files)","items":{"type":"integer","description":"Shipping voucher id-the id of UploadFileAPIReturn must be passed when shipping (up to 10 Files)","format":"int32"}},"transaction_type":{"type":"string","description":"Transaction method: EXW-Ex factory FCA-Free carrier FAS-Free alongside ship FOB-Free on board CFR-Cost and freight CIF-Cost, insurance and freight CPT-Freight paid to DDP-Delivered duty paid DAF-Delivered at the border DDU-Not Delivered duty paid DEQ-Delivered at the port of destination DES-Free on board at the port of destination","enum":["EXW","FCA","FAS","FOB","CFR","CIF","CPT","DDP","DAF","DDU","DEQ","DES"]},"transport_type":{"type":"string","description":"Transportation method: AIR-Air SHIPPING-Sea EXPRESS-Express LAND-Land POST-Post OTHER-Other","enum":["AIR","SHIPPING","EXPRESS","LAND","POST","OTHER"]}},"description":"LogisticsInformation"}},"components/schemas/ContractOrderCreateRes":{"id":"components/schemas/ContractOrderCreateRes","kind":"json-schema","title":"ContractOrderCreateRes","data":{"required":["contract_order_no","status"],"type":"object","properties":{"contract_order_no":{"type":"string","description":"PlatformContractOrderid","minLength":1,"maxLength":32},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Open platform ContractOrderStatus: RELATABLE-Associated, ALL_RELATED-Associated"},"children":[]}]}]}],"enum":["RELATABLE","ALL_RELATED"]}}}},"components/schemas/ContractOrderGetRes":{"id":"components/schemas/ContractOrderGetRes","kind":"json-schema","title":"ContractOrderGetRes","data":{"required":["contract_order_no","status"],"type":"object","properties":{"contract_order_no":{"type":"string","description":"OrderNumber","minLength":1,"maxLength":32},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Open PlatformContractOrderStatus RELATABLE-Associated ALL_RELATED-Associated"},"children":[]}]}]}],"enum":["RELATABLE","ALL_RELATED"]}}}},"components/schemas/ContractOrderUpdateV2Req":{"id":"components/schemas/ContractOrderUpdateV2Req","kind":"json-schema","title":"ContractOrderUpdateV2Req","data":{"required":["amount","buyer_country","buyer_name","contract_file_ids","contract_no","currency","goods_info","invoice_file_ids","is_exchange_settle","logistics_info","order_date","request_id"],"type":"object","properties":{"request_id":{"maxLength":32,"minLength":1,"type":"string","description":"Request number, Unique within the requesting system"},"buyer_name":{"maxLength":128,"minLength":1,"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Buyer’s name (Max 128 characters)"},"children":[]}]}]}]},"buyer_country":{"type":"string","description":"Buy country code, Use ISO3166-2 standard 2-digit country code (See appendix)"},"amount":{"type":"integer","description":"OrderAmount(CurrencyMinimum Unit)","format":"int64"},"currency":{"type":"string","description":"Currency: EUR - Euro, USD - United States dollar, CNY - Chinese yuan, GBP - British pound, JPY - Japanese yen, AUD - Australian dollar, CAD - Canadian dollar, SGD - Singapore dollar, HKD - Hong Kong dollar, PHP - Philippine peso, CNH - offshore Chinese yuan","enum":["EUR","USD","CNY","GBP","JPY","AUD","CAD","SGD","HKD","PHP","CNH"]},"contract_file_ids":{"maxItems":10,"minItems":1,"type":"array","description":"ContractAttachmentid-UploadFileAPIReturn id (up to 10 Files)","items":{"type":"integer","description":"ContractAttachmentid-UploadFileAPIReturn id (up to 10 Files)","format":"int32"}},"contract_no":{"maxLength":32,"minLength":1,"type":"string","description":"ContractNumber(Max 32 characters)(can only be numbers and letters)(Unique under Merchant)"},"goods_info":{"type":"object","properties":{"category":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product Category (Support’s Product CategorySee attachment)"},"children":[]}]}]}],"format":"int32"},"name":{"maxLength":128,"minLength":1,"type":"string","description":"Product Name(Max 128 characters)"},"quantity":{"type":"integer","description":"Product quantity","format":"int64"},"url":{"type":"string","description":"Product URL","maxLength":256,"minLength":1},"custom_dec_info":{"type":"object","properties":{"dec_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Declaration method: METHOD_1-Not reported at the customs or Not included in the customs statistics for e-commerce TransactionOrder METHOD_2-Declared for export at the customs according to the general trade method"},"children":[]}]}]}]},"dec_no":{"type":"string","description":"Customs declaration number (Max 32 characters)","minLength":0,"maxLength":32}},"required":["dec_method"],"description":"Customs declarationInformation"}},"description":"ProductInformation","required":["category","name","url","custom_dec_info"]},"invoice_file_ids":{"maxItems":10,"minItems":1,"type":"array","description":"PI/CI/Invoice id-UploadFileAPIReturnid (up to 10 Files)","items":{"type":"integer","description":"PI/CI/Invoice id-UploadFileAPIReturnid (up to 10 Files)","format":"int32"}},"is_exchange_settle":{"type":"boolean","description":"Whether settlement of foreign exchange is Required"},"logistics_info":{"type":"object","properties":{"buyer_type":{"type":"string","description":"NEW-New Buyer's home;OLD-Old Buyer's home","enum":["NEW","OLD"]},"destination":{"maxLength":256,"minLength":1,"type":"string","description":"Destination must be passed when shipping (Max 256 characters)"},"expected_ship_date":{"type":"string","description":"Must be passed when ShippingDate Not shipping is expected. Format:yyyy-MM-dd","format":"date-time"},"freight_arrange_file_ids":{"maxItems":10,"minItems":1,"type":"array","description":"Freight arrangement communication record id-UploadFileAPIReturnid (up to 10 Files), must be passed to the new Buyer","items":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Freight arrangement communication record id-UploadFileAPIReturnid Must be transmitted when LogisticsStatus=UNSHIPPED (maximum 10 Files)"},"children":[]}]}]}],"format":"int32"}},"latest_order_file_ids":{"maxItems":10,"minItems":1,"type":"array","description":"The customs declaration form or outbound logistics voucher id-UploadFileAPIReturnid of the most recent transaction between Merchant and the Buyer must be passed to the old Buyer (up to 10 Files)","items":{"type":"integer","description":"The customs declaration form or outbound logistics voucher id-UploadFileAPIReturnid of the most recent transaction between Merchant and the Buyer must be passed to the old Buyer (up to 10 Files)","format":"int32"}},"logistics_company_name":{"maxLength":256,"minLength":1,"type":"string","description":"Logistics company name must be passed when shipping (Max 256 characters)"},"outbound_no":{"maxLength":32,"minLength":1,"type":"string","description":"Outbound Logistics tracking number must be sent when shipping ((Max 32 characters)"},"inquiry_records_file_ids":{"maxItems":10,"minItems":1,"type":"array","description":"Inquiry and order communication record-UploadFileAPIReturn id (up to 10 Files), must be passed to the new Buyer","items":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Inquiry and order communication record - UploadFileAPIReturn must be transmitted when the id LogisticsStatus=UNSHIPPED (up to 10 Files)"},"children":[]}]}]}],"format":"int32"}},"ship_date":{"type":"string","description":"ShippingDate must be passed when shipping Format:yyyy-MM-dd","format":"date-time"},"ship_status":{"type":"string","description":"LogisticsStatus: SHIPPED-Shipping UNSHIPPED-Not shipping","enum":["SHIPPED","UNSHIPPED"]},"shipped_file_ids":{"maxItems":10,"minItems":1,"type":"array","description":"Shipping voucher id-the id of UploadFileAPIReturn must be passed when shipping (up to 10 Files)","items":{"type":"integer","description":"Shipping voucher id-the id of UploadFileAPIReturn must be passed when shipping (up to 10 Files)","format":"int32"}},"transaction_type":{"type":"string","description":"Transaction method: EXW-Ex factory FCA-Free carrier FAS-Free alongside ship FOB-Free on board CFR-Cost and freight CIF-Cost, insurance and freight CPT-Freight paid to DDP-Delivered duty paid DAF-Delivered at the border DDU-Not Delivered duty paid DEQ-Delivered at the port of destination DES-Free on board at the port of destination","enum":["EXW","FCA","FAS","FOB","CFR","CIF","CPT","DDP","DAF","DDU","DEQ","DES"]},"transport_type":{"type":"string","description":"Transportation method: AIR-Air SHIPPING-Sea EXPRESS-Express LAND-Land POST-Post OTHER-Other","enum":["AIR","SHIPPING","EXPRESS","LAND","POST","OTHER"]}},"description":"LogisticsInformation","required":["ship_status","transaction_type"]},"order_date":{"type":"string","description":"OrderTime Format: yyyy-MM-dd","format":"date"},"remark":{"maxLength":128,"minLength":0,"type":"string","description":"Remark (length 128 characters)"},"other_file_ids":{"type":"array","description":"OtherAttachmentid-UploadFileAPIReturn id","items":{"type":"integer","description":"OtherAttachmentid-UploadFileAPIReturn id","format":"int32"}}}}},"components/schemas/LogisticsSupplementV2Req":{"id":"components/schemas/LogisticsSupplementV2Req","kind":"json-schema","title":"LogisticsSupplementV2Req","data":{"required":["destination","logistics_company_name","outbound_no","request_id","ship_date","shipped_file_ids","transport_type"],"type":"object","properties":{"request_id":{"maxLength":32,"minLength":1,"type":"string","description":"Request number, Unique within the requesting system"},"logistics_company_name":{"type":"string","description":"Logistics Company Name"},"transport_type":{"type":"string","description":"Transportation method: AIR-Air SHIPPING-Sea EXPRESS-Express LAND-Land POST-Post OTHER-Other","enum":["AIR","SHIPPING","EXPRESS","LAND","POST","OTHER"]},"outbound_no":{"type":"string","description":"Outbound Logistics tracking number"},"destination":{"type":"string","description":"destination"},"ship_date":{"type":"string","description":"ShippingDate(TimeFormat: yyyy-MM-dd)","format":"date"},"shipped_file_ids":{"maxItems":10,"minItems":1,"type":"array","description":"Shipping VoucherFileIDList","items":{"type":"integer","description":"Shipping VoucherFileIDList","format":"int32"}}}}},"components/schemas/LogisticsSupplementRes":{"id":"components/schemas/LogisticsSupplementRes","kind":"json-schema","title":"LogisticsSupplementRes","data":{"required":["status"],"type":"object","properties":{"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Open platform ContractOrderStatus: RELATABLE-Associated, ALL_RELATED-Associated"},"children":[]}]}]}],"enum":["RELATABLE","ALL_RELATED"]}}}},"components/schemas/TradeSettleApplyReq":{"id":"components/schemas/TradeSettleApplyReq","kind":"json-schema","title":"TradeSettleApplyReq","data":{"required":["recv_order_no","relate_list"],"type":"object","properties":{"recv_order_no":{"type":"string","description":"Collection order number (the order number imported into RemittanceNotification)","minLength":1,"maxLength":32},"relate_list":{"maxItems":2147483647,"minItems":1,"type":"array","description":"AssociatedContractOrderList At least one Associated","items":{"$ref":"#/components/schemas/Relate"}}}}},"components/schemas/TradeSettleApplyRes":{"id":"components/schemas/TradeSettleApplyRes","kind":"json-schema","title":"TradeSettleApplyRes","data":{"required":["status"],"type":"object","properties":{"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status(PENDING_RELATE-pending AssociatedOrder, PENDING_REVIEW-Review, CREDITED-Crediting, PENDING_REFUND-Refund, REJECTED-ReviewNot approved, REFUNDED-Refund)"},"children":[]}]}]}],"enum":["PENDING_RELATE","PENDING_REVIEW","CREDITED","REJECTED","PENDING_REFUND","REFUNDED"]}},"description":"SettlementCreditingResult"}},"components/schemas/TradeSettleInquiryReq":{"id":"components/schemas/TradeSettleInquiryReq","kind":"json-schema","title":"TradeSettleInquiryReq","data":{"type":"object","properties":{"recv_order_no":{"type":"string","description":"Collection order id (the order number imported into RemittanceNotification)","minLength":0,"maxLength":32}},"required":["recv_order_no"]}},"components/schemas/TradeSettleInquiryRes":{"id":"components/schemas/TradeSettleInquiryRes","kind":"json-schema","title":"TradeSettleInquiryRes","data":{"required":["status"],"type":"object","properties":{"reason":{"type":"string","description":"The most recentReviewRejectedReason"},"refund_remark":{"type":"string","description":"RefundRemark"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status(PENDING_RELATE-pending AssociatedOrder, PENDING_REVIEW-Review, CREDITED-Crediting, PENDING_REFUND-Refund, REJECTED-ReviewNot approved, REFUNDED-Refund)"},"children":[]}]}]}],"enum":["PENDING_RELATE","PENDING_REVIEW","CREDITED","REJECTED","PENDING_REFUND","REFUNDED"]}}}},"components/schemas/TradeSettleNotification":{"id":"components/schemas/TradeSettleNotification","kind":"json-schema","title":"TradeSettleNotification","data":{"required":["merch_id","recv_order_no","status"],"type":"object","properties":{"merch_id":{"type":"string","description":"Merchantid","minLength":1,"maxLength":20},"reason":{"type":"string","description":"The most recentReviewRejectedReason"},"recv_order_no":{"type":"string","description":"Collection order id (the order number imported into RemittanceNotification)","minLength":1,"maxLength":32},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status(PENDING_RELATE-pending AssociatedOrder, PENDING_REVIEW-Review, CREDITED-Crediting, PENDING_REFUND-Refund, REJECTED-ReviewNot approved, REFUNDED-Refund)"},"children":[]}]}]}],"enum":["PENDING_RELATE","PENDING_REVIEW","CREDITED","REJECTED","PENDING_REFUND","REFUNDED"]}},"description":"Notification message content"}},"components/schemas/NotificationDtoTradeSettleNotification":{"id":"components/schemas/NotificationDtoTradeSettleNotification","kind":"json-schema","title":"NotificationDtoTradeSettleNotification","data":{"required":["data","type","version"],"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BusinessType: MERCH-Merchant, VA-Virtual Account, INCOMING_REMITTANCE-Import Remittance, CONTRACT_ORDER-ContractOrder, TRADE_SETTLE-SettlementCrediting, PAYEE-Collection, WD_ACCOUNT-Withdraw Account, CUR_EXCHANGE-FX, PAYMENT-Payment"},"children":[]}]}]}],"enum":["MERCH","VA","INCOMING_REMITTANCE","CONTRACT_ORDER","TRADE_SETTLE","PAYEE","WD_ACCOUNT","FOREX","PAYMENT"]},"version":{"type":"string","description":"Version number (V1, V2,...)"},"data":{"$ref":"#/components/schemas/TradeSettleNotification"}}}},"components/schemas/Relate":{"id":"components/schemas/Relate","kind":"json-schema","title":"Relate","data":{"required":["amount","contract_order_no"],"type":"object","properties":{"amount":{"type":"integer","description":"This CreditingAmount(CurrencyMinimum Unit)","format":"int64"},"contract_order_no":{"type":"string","description":"PlatformContractNumber(CreateContractOrderAPIReturn)","minLength":1,"maxLength":32}},"description":"AssociatedContractOrderList At least one Associated"}},"components/schemas/AccountBalanceRes":{"id":"components/schemas/AccountBalanceRes","kind":"json-schema","title":"AccountBalanceRes","data":{"required":["account_list"],"type":"object","properties":{"account_list":{"type":"array","description":"List","items":{"type":"object","properties":{"balance":{"type":"integer","description":"Balance(CurrencyMinimum Unit)","format":"int64"},"currency":{"type":"string","description":"Currency: EUR - Euro, USD - United States dollar, CNY - Chinese yuan, GBP - British pound, JPY - Japanese yen, AUD - Australian dollar, CAD - Canadian dollar, SGD - Singapore dollar, HKD - Hong Kong dollar, PHP - Philippine peso, CNH - offshore Chinese yuan","enum":["EUR","USD","CNY","GBP","JPY","AUD","CAD","SGD","HKD","PHP","CNH"]}},"required":["balance","currency"]}}}}},"components/schemas/PayeeInquiryV2Req":{"id":"components/schemas/PayeeInquiryV2Req","kind":"json-schema","title":"PayeeInquiryV2Req","data":{"required":["request_id","type"],"type":"object","properties":{"request_id":{"maxLength":32,"minLength":1,"type":"string","description":"Request number, Unique within the requesting system"},"type":{"type":"string","description":"Purpose (Required): PAYMENT-Collection, WITHDRAWAL-Withdrawal"}}}},"components/schemas/BankAccV2Info":{"id":"components/schemas/BankAccV2Info","kind":"json-schema","title":"BankAccV2Info","data":{"required":["acc_name","acc_type","country","currency","payment_type"],"type":"object","properties":{"country":{"type":"string","description":"Country code, Use ISO3166-2 standard 2-digit Country code, non-sanctioned Country (See appendix)","maxLength":2,"minLength":0,"example":"CN"},"acc_name":{"maxLength":100,"minLength":1,"type":"string","description":"AccountName(Max 100 characters)"},"acc_type":{"type":"string","description":"AccountType: PRIVATE-Personal Account, COMPANY-Enterprise Corporate","enum":["PRIVATE","COMPANY"]},"acc_no":{"maxLength":100,"minLength":0,"type":"string","description":"Bank account number, choose one from accNo or iban"},"payment_type":{"type":"string","description":"Payment clearing network: LOCAL - local payment, SWIFT - international payment","enum":["LOCAL","SWIFT"]},"routing_code_type1":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must when LOCAL clearing network (the enumeration value will be expanded as the business develops): ABA (local payment network code in the United States), FASTER_PAYMENT (local payment network code in the United Kingdom), CHAPS (local payment network code in the United Kingdom), SORT_CODE, BANK_CODE (see BankCodeAttachment for details within the country, and fill it out truthfully in Canada)"},"children":[]}]}]}]},"routing_code_value1":{"type":"string","description":"Must when routingCodeType1 is not empty"},"routing_code_type2":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LOCAL clearing network sub-Type (the enumeration value will be expanded as the business develops): BRANCH_BANK_CODE (see BankCodeAttachment for details within the country, and fill in the details truthfully for overseas countries such as Canada)"},"children":[]}]}]}]},"routing_code_value2":{"type":"string","description":"Must when routingCodeType2 is not empty"},"iban":{"maxLength":50,"minLength":0,"type":"string","description":"IBAN, unique to Eurozone Accounts, choose one from accNo or iban"},"bic_swift":{"type":"string","description":"swift code or bic, when SWIFT clears the network, other countries and regions require Upload this Field (only supports 8 or 11 bits)","maxLength":11,"minLength":8,"example":"ABCDEFGH"},"bank_acc_type":{"type":"string","description":"BankAccountType CHECKING-Cheque SAVINGS-Debit Card","enum":["CHECKING","SAVINGS"]},"bank_addr":{"maxLength":100,"minLength":0,"type":"string","description":"Account OpeningBankDetailedAddress(overseas AccountRequired)(Max 100 characters)"},"bank_name":{"maxLength":100,"minLength":0,"type":"string","description":"Account OpeningBankName(overseas AccountRequired; Max 100 characters)"},"branch_bank_name":{"maxLength":100,"minLength":0,"type":"string","description":"Account OpeningBank Branch Name(Max 100 characters)"},"phone":{"type":"string","description":"Bank reserved mobile phone number (Mainland RMB private cash withdrawal)","maxLength":11,"minLength":11,"example":"13800138000"},"province":{"maxLength":10,"minLength":0,"type":"string","description":"Account OpeningBank belongs to Province (domestic Enterprise to corporate AccountRequired, See attachment)"},"city":{"maxLength":10,"minLength":0,"type":"string","description":"City to which Account OpeningBank belongs (domestic Enterprise to corporate AccountRequired, See attachment)"},"district":{"maxLength":10,"minLength":0,"type":"string","description":"Account OpeningBank belongs to the district (domestic Enterprise to corporate AccountRequired, See attachment)"}},"description":"BankAccountInformation"}},"components/schemas/ContractOrderUpdateRes":{"id":"components/schemas/ContractOrderUpdateRes","kind":"json-schema","title":"ContractOrderUpdateRes","data":{"required":["status"],"type":"object","properties":{"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Open platform ContractOrderStatus: RELATABLE-Associated, ALL_RELATED-Associated"},"children":[]}]}]}],"enum":["RELATABLE","ALL_RELATED"]}}}},"components/schemas/NotificationDtoMerchOnboardApplyResultNotificationV2":{"id":"components/schemas/NotificationDtoMerchOnboardApplyResultNotificationV2","kind":"json-schema","title":"NotificationDtoMerchOnboardApplyResultNotificationV2","data":{"required":["data","type","version"],"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BusinessType: MERCH-Merchant, VA-Virtual Account, INCOMING_REMITTANCE-Import Remittance, CONTRACT_ORDER-ContractOrder, TRADE_SETTLE-SettlementCrediting, PAYEE-Collection, WD_ACCOUNT-Withdraw Account, CUR_EXCHANGE-FX, PAYMENT-Payment"},"children":[]}]}]}],"enum":["MERCH","VA","INCOMING_REMITTANCE","CONTRACT_ORDER","TRADE_SETTLE","PAYEE","WD_ACCOUNT","FOREX","PAYMENT"]},"version":{"type":"string","description":"Version number (V1, V2,...)"},"data":{"$ref":"#/components/schemas/MerchOnboardApplyResultNotificationV2"}}}},"components/schemas/NotificationDtoMerchPayeeNotificationV2":{"id":"components/schemas/NotificationDtoMerchPayeeNotificationV2","kind":"json-schema","title":"NotificationDtoMerchPayeeNotificationV2","data":{"required":["data","type","version"],"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BusinessType: MERCH-Merchant, VA-Virtual Account, INCOMING_REMITTANCE-Import Remittance, CONTRACT_ORDER-ContractOrder, TRADE_SETTLE-SettlementCrediting, PAYEE-Collection, WD_ACCOUNT-Withdraw Account, CUR_EXCHANGE-FX, PAYMENT-Payment"},"children":[]}]}]}],"enum":["MERCH","VA","INCOMING_REMITTANCE","CONTRACT_ORDER","TRADE_SETTLE","PAYEE","WD_ACCOUNT","FOREX","PAYMENT"]},"version":{"type":"string","description":"Version number (V1, V2,...)"},"data":{"$ref":"#/components/schemas/MerchPayeeNotificationV2"}}}},"components/schemas/EntStakeholder":{"id":"components/schemas/EntStakeholder","kind":"json-schema","title":"EntStakeholder","data":{"required":["birth_date","doc_portrait_side_file_id","doc_type","eff_date_start","id_number","identity_type","name"],"type":"object","properties":{"identity_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identity Type: LEGAL_PERSON-Legal person, BENEFICIARY-Ultimate beneficiary, SHAREHOLDER-Shareholder, DIRECTOR-Director"},"children":[]}]}]}]},"name":{"maxLength":128,"minLength":0,"type":"string","description":"Name (length 128 characters)"},"nationality":{"maxLength":2,"minLength":0,"type":"string","description":"Nationality (ISO3166-2 standard 2-digit Country/Region code)"},"birth_date":{"type":"string","description":"Birthday, Formatyyyy-MM-dd, such as 2023-12-12","format":"date"},"address_proof_file_id":{"type":"integer","description":"Address proves File, non-Mainland China ID Card, Address proves FileRequired","format":"int32"},"doc_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID CardType ID_CARD: Second-generation resident ID Card, HK_CARD: Hong Kong permanent residence permit, PASSPORT: Passport, MO_CARD: Macao permanent residence permit, HK_MO_PASS: Mainland travel permit for Hong Kong and Macao residents, TW_CARD: Mainland travel permit for Taiwan residents"},"children":[]}]}]}]},"id_number":{"maxLength":18,"minLength":0,"type":"string","description":"ID Document number (length 18 characters)"},"doc_address":{"maxLength":256,"minLength":0,"type":"string","description":"ID DocumentDetailedAddress (length 256 characters), mainland ID CardRequired"},"doc_non_portrait_side_file_id":{"type":"integer","description":"File on the back of ID Document. Except for Passport and Mainland China Pass, which does not require RequiredProvide, OtherID DocumentType all require RequiredProvide.","format":"int32"},"doc_portrait_side_file_id":{"type":"integer","description":"ID Document frontFile","format":"int32"},"eff_date_start":{"type":"string","description":"ID Document starting date; Formatyyyy-MM-dd, such as 2023-12-12","format":"date"},"eff_date_end":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID Document expiration date; Formatyyyy-MM-dd, such as 2023-12-12, choose one from long_term, for others, press DateFormatUpload"},"children":[]}]}]}],"format":"date"},"long_term":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether it is long-term (Mainland ID DocumentOptional), choose one of eff_date_end"},"children":[]}]}]}]},"share":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shareholding ratio, percentage, 51.12% to 51.12, up to two decimal places, ultimate beneficiary, shareholder Required"},"children":[]}]}]}]},"resident_address":{"$ref":"#/components/schemas/AddressDto"}},"description":"EnterpriseAssociatedPersonalInformationList"}},"components/schemas/AuthAgentStakeholder":{"id":"components/schemas/AuthAgentStakeholder","kind":"json-schema","title":"AuthAgentStakeholder","data":{"required":["birth_date","doc_portrait_side_file_id","doc_type","eff_date_start","id_number","name"],"type":"object","properties":{"name":{"maxLength":128,"minLength":0,"type":"string","description":"Name (length 128 characters)"},"nationality":{"maxLength":2,"minLength":0,"type":"string","description":"Nationality (ISO3166-2 standard 2-digit Country/Region code)"},"birth_date":{"type":"string","description":"Birthday, Formatyyyy-MM-dd, such as 2023-12-12","format":"date"},"address_proof_file_id":{"type":"integer","description":"Address proves File, non-Mainland China ID Card, Address proves FileRequired","format":"int32"},"doc_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID CardType ID_CARD: Second-generation resident ID Card, HK_CARD: Hong Kong permanent residence permit, PASSPORT: Passport, MO_CARD: Macao permanent residence permit, HK_MO_PASS: Mainland travel permit for Hong Kong and Macao residents, TW_CARD: Mainland travel permit for Taiwan residents"},"children":[]}]}]}]},"id_number":{"maxLength":18,"minLength":0,"type":"string","description":"ID Document number (length 18 characters)"},"doc_address":{"maxLength":256,"minLength":0,"type":"string","description":"ID DocumentDetailedAddress (length 256 characters), mainland ID CardRequired"},"doc_non_portrait_side_file_id":{"type":"integer","description":"File on the back of ID Document. Except for Passport and Mainland China Pass, which does not require RequiredProvide, OtherID DocumentType all require RequiredProvide.","format":"int32"},"doc_portrait_side_file_id":{"type":"integer","description":"ID Document frontFile","format":"int32"},"eff_date_start":{"type":"string","description":"ID Document starting date; Formatyyyy-MM-dd, such as 2023-12-12","format":"date"},"eff_date_end":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID Document expiration date; Formatyyyy-MM-dd, such as 2023-12-12, choose one from long_term, for others, press DateFormatUpload"},"children":[]}]}]}],"format":"date"},"long_term":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether it is long-term (Mainland ID DocumentOptional), choose one of eff_date_end"},"children":[]}]}]}]},"resident_address":{"$ref":"#/components/schemas/AddressDto"}},"description":"AuthorizationAgentInformation"}},"components/schemas/MerchOnboardCreateReq":{"id":"components/schemas/MerchOnboardCreateReq","kind":"json-schema","title":"MerchOnboardCreateReq","data":{"required":["business","contact_person","license","request_id","stakeholder_list"],"type":"object","properties":{"request_id":{"maxLength":32,"minLength":1,"type":"string","description":"Request number, Unique within the requesting system"},"contact_person":{"$ref":"#/components/schemas/ContactPersonInfo","description":"ContactInformation"},"license":{"type":"object","properties":{"region":{"maxLength":2,"minLength":0,"type":"string","description":"2-digit English CountryCode, refer to Appendix-CountryRegion Code"},"ent_name":{"maxLength":128,"minLength":0,"type":"string","description":"EnterpriseName (length 128 characters)"},"ent_name_en":{"type":"string","description":"Enterprise English Name (length 128 characters)","maxLength":128,"minLength":0},"found_date":{"type":"string","description":"Date established","format":"date"},"registered_currency":{"maxLength":3,"minLength":0,"type":"string","description":"Registered capital Currency symbol, Use ISO-4217 standard 3-digit Currency code"},"registered_capital":{"type":"number","description":"Registered capital, unit standard Currency, two decimal places, if there is no registered capital, fill in 0; if reigon is a mainland enterprise, it is yuan, if it is a Hong Kong enterprise, it is Hong Kong dollars, and if it is a global enterprise, it is US dollars."},"address":{"$ref":"#/components/schemas/AddressDto","description":"Enterprise registrationAddressInformation"},"legal_rep_name":{"maxLength":128,"minLength":0,"type":"string","description":"Region is Mainland Required - Mainland Enterprise name of legal representative"},"license_file_id":{"type":"integer","description":"region is Mainland Required-Mainland Enterprise Business LicenseFile","format":"int32"},"ent_type":{"type":"string","description":"region is mainland Required-EnterpriseType: PERSONAL-IndividualMerchant, ENTERPRISE-Enterprise"},"uni_social_credit":{"maxLength":18,"minLength":0,"type":"string","description":"region is Mainland Required-Mainland Enterprise Unified Social Credit Code"},"busi_from":{"type":"string","description":"region is Mainland Required-Mainland Enterprise BusinessDate (starting)","format":"date"},"busi_end":{"type":"string","description":"Region is Mainland China Optional-Mainland Enterprise BusinessDate (only), and whether long-term are mutually exclusive Required, choose one of them, both pass the default long-term","format":"date"},"long_term":{"type":"boolean","description":"region is mainland Optional - whether it is long-term, and EnterpriseBusiness cut-off Date are mutually exclusive, and both default to long-term"},"br_no":{"type":"string","description":"region is Hong Kong Required-global Enterprise registration certificate number"},"br_file_id":{"type":"integer","description":"Region is Hong Kong Required-Global Enterprise Company Registration Certificate","format":"int32"},"annual_return_file_id":{"type":"integer","description":"Region is Hong Kong Optional - Hong Kong Enterprise Annual Return (choose one from the corporate establishment form)","format":"int32"},"incorporation_form_file_id":{"type":"integer","description":"Region is Hong Kong Optional-Hong Kong Enterprise Incorporation Form (choose one of the annual return form)","format":"int32"},"br_expiry_date":{"type":"string","description":"region is Hong Kong Required-Hong Kong Enterprise Expiration Date: yyyy-MM-dd","format":"date"},"cr_issue_date":{"type":"string","description":"The region is Hong Kong Required-Hong Kong Enterprise Certificate Issue Date:yyyy-MM-dd","format":"date"},"company_article_file_id":{"type":"integer","description":"region is global EnterpriseRequired-Articles of Association File","format":"int32"},"cr_file_id":{"type":"integer","description":"Region is non-mainland Required-Hong Kong/Global Enterprise Company Registration Certificate","format":"int32"},"cr_no":{"type":"string","description":"Region is non-mainland Required-Hong Kong Enterprise Certificate Number/Global Enterprise Registration Certificate Number"},"share_structure_file_id":{"type":"integer","description":"region is Global EnterpriseRequired-Global Enterprise Equity Structure File","format":"int32"},"cr_expiry_date":{"type":"string","description":"Region is Global Required-Global Enterprise Expiration Date: yyyy-MM-dd","format":"date"},"other_file_ids":{"type":"array","description":"OtherAttachment","items":{"type":"integer","description":"OtherAttachment","format":"int32"}}},"description":"EnterpriseInformation","required":["region","ent_name","found_date","registered_currency","registered_capital"]},"business":{"type":"object","properties":{"main_industry":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Main Industrycode (see new IndustryAttachment), one of industry and main_industryRequired; industry will be abandoned in later versions"},"children":[]}]}]}]},"sub_industry":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sub-camp Industrycode (see new IndustryAttachment), can be passed when main_industryRequired"},"children":[]}]}]}]},"industry":{"type":"integer","description":"Industry Data Dictionary INDUSTRY(See appendix)","format":"int32"},"employee_number":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of Enterprise employees: FIRST_LEVEL: less than 5 people, SECOND_LEVEL: 5-20 people, THIRD_LEVEL: 20-50 people, FOURTH_LEVEL: more than 50 people"},"children":[]}]}]}]},"address":{"$ref":"#/components/schemas/AddressDto","description":"EnterpriseBusinessAddressInformation"},"export_country":{"uniqueItems":true,"type":"array","description":"Mainly exports Country, array, UseISO3166-2 standard 2-digit Country/Region code (See appendix)","items":{"type":"string","description":"Mainly exports Country, array, UseISO3166-2 standard 2-digit Country/Region code (See appendix)"}},"export_type":{"uniqueItems":true,"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Export Type: SELF_SUPPORT-self-operated export, EXPORT-entrusted export, INTERNATIONAL-international express, OTHER-Other"},"children":[]}]}]}],"items":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Export Type: SELF_SUPPORT-self-operated export, EXPORT-entrusted export, INTERNATIONAL-international express, OTHER-Other"},"children":[]}]}]}]}},"trade_volume":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Monthly trade volume: FIRST_LEVEL (USD 0-50,000), SECOND_LEVEL (USD 50,000-100,000), THIRD_LEVEL (USD 100,000-250,000), FOURTH_LEVEL (USD 250,000-500,000), FIFTH_LEVEL (USD 500,000-1 million), SIXTH_LEVEL (more than 1 million US dollars)"},"children":[]}]}]}]},"website":{"maxLength":200,"minLength":0,"type":"string","description":"Company website (character length 200)"},"business_models":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Main BusinessType: B2BCollection-B2B_COLLECTIONS Platform Collection-PLATFORM_COLLECTIONS Independent Station Acquisition-INDEPENDENT_SITE_ACQUIRING"},"children":[]}]}]}]}},"description":"EnterpriseBusinessInformation","required":["main_industry","sub_industry","industry","employee_number","export_country","export_type","trade_volume"]},"stakeholder_list":{"type":"array","description":"EnterpriseAssociatedPersonalInformationList","items":{"type":"object","properties":{"identity_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identity Type: LEGAL_PERSON-Legal person, BENEFICIARY-Ultimate beneficiary, SHAREHOLDER-Shareholder, DIRECTOR-Director"},"children":[]}]}]}]},"name":{"maxLength":128,"minLength":0,"type":"string","description":"Name (length 128 characters)"},"nationality":{"maxLength":2,"minLength":0,"type":"string","description":"Nationality (ISO3166-2 standard 2-digit Country/Region code)"},"birth_date":{"type":"string","description":"Birthday, Formatyyyy-MM-dd, such as 2023-12-12","format":"date"},"address_proof_file_id":{"type":"integer","description":"Address proves File, non-Mainland China ID Card, Address proves FileRequired","format":"int32"},"doc_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID CardType ID_CARD: Second-generation resident ID Card, HK_CARD: Hong Kong permanent residence permit, PASSPORT: Passport, MO_CARD: Macao permanent residence permit, HK_MO_PASS: Mainland travel permit for Hong Kong and Macao residents, TW_CARD: Mainland travel permit for Taiwan residents"},"children":[]}]}]}]},"id_number":{"maxLength":18,"minLength":0,"type":"string","description":"ID Document number (length 18 characters)"},"doc_address":{"maxLength":256,"minLength":0,"type":"string","description":"ID DocumentDetailedAddress (length 256 characters), mainland ID CardRequired"},"doc_non_portrait_side_file_id":{"type":"integer","description":"File on the back of ID Document. Except for Passport and Mainland China Pass, which does not require RequiredProvide, OtherID DocumentType all require RequiredProvide.","format":"int32"},"doc_portrait_side_file_id":{"type":"integer","description":"ID Document frontFile","format":"int32"},"eff_date_start":{"type":"string","description":"ID Document starting date; Formatyyyy-MM-dd, such as 2023-12-12","format":"date"},"eff_date_end":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID Document expiration date; Formatyyyy-MM-dd, such as 2023-12-12, choose one from long_term, for others, press DateFormatUpload"},"children":[]}]}]}],"format":"date"},"long_term":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether it is long-term (Mainland ID DocumentOptional), choose one of eff_date_end"},"children":[]}]}]}]},"share":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shareholding ratio, percentage, 51.12% to 51.12, up to two decimal places, ultimate beneficiary, shareholder Required"},"children":[]}]}]}]},"resident_address":{"$ref":"#/components/schemas/AddressDto","description":"ResidenceAddressInformation"}},"required":["identity_type","name","birth_date","doc_type","id_number","doc_portrait_side_file_id","eff_date_start"]}}}}},"components/schemas/MerchOnboardUpdateReq":{"id":"components/schemas/MerchOnboardUpdateReq","kind":"json-schema","title":"MerchOnboardUpdateReq","data":{"required":["business","contact_person","license","request_id","stakeholder_list"],"type":"object","properties":{"request_id":{"maxLength":32,"minLength":1,"type":"string","description":"Request number, Unique within the requesting system"},"contact_person":{"$ref":"#/components/schemas/ContactPersonInfo","description":"ContactInformation"},"license":{"type":"object","properties":{"region":{"maxLength":2,"minLength":0,"type":"string","description":"2-digit English CountryCode, refer to Appendix-CountryRegion Code"},"ent_name":{"maxLength":128,"minLength":0,"type":"string","description":"EnterpriseName (length 128 characters)"},"ent_name_en":{"type":"string","description":"Enterprise English Name (length 128 characters)","maxLength":128,"minLength":0},"found_date":{"type":"string","description":"Date established","format":"date"},"registered_currency":{"maxLength":3,"minLength":0,"type":"string","description":"Registered capital Currency symbol, Use ISO-4217 standard 3-digit Currency code"},"registered_capital":{"type":"number","description":"Registered capital, unit standard Currency, two decimal places, if there is no registered capital, fill in 0; if reigon is a mainland enterprise, it is yuan, if it is a Hong Kong enterprise, it is Hong Kong dollars, and if it is a global enterprise, it is US dollars."},"address":{"$ref":"#/components/schemas/AddressDto","description":"Enterprise registrationAddressInformation"},"legal_rep_name":{"maxLength":128,"minLength":0,"type":"string","description":"Region is Mainland Required - Mainland Enterprise name of legal representative"},"license_file_id":{"type":"integer","description":"region is Mainland Required-Mainland Enterprise Business LicenseFile","format":"int32"},"ent_type":{"type":"string","description":"region is mainland Required-EnterpriseType: PERSONAL-IndividualMerchant, ENTERPRISE-Enterprise"},"uni_social_credit":{"maxLength":18,"minLength":0,"type":"string","description":"region is Mainland Required-Mainland Enterprise Unified Social Credit Code"},"busi_from":{"type":"string","description":"region is Mainland Required-Mainland Enterprise BusinessDate (starting)","format":"date"},"busi_end":{"type":"string","description":"Region is Mainland China Optional-Mainland Enterprise BusinessDate (only), and whether long-term are mutually exclusive Required, choose one of them, both pass the default long-term","format":"date"},"long_term":{"type":"boolean","description":"region is mainland Optional - whether it is long-term, and EnterpriseBusiness cut-off Date are mutually exclusive, and both default to long-term"},"br_no":{"type":"string","description":"region is Hong Kong Required-global Enterprise registration certificate number"},"br_file_id":{"type":"integer","description":"Region is Hong Kong Required-Global Enterprise Company Registration Certificate","format":"int32"},"annual_return_file_id":{"type":"integer","description":"Region is Hong Kong Optional - Hong Kong Enterprise Annual Return (choose one from the corporate establishment form)","format":"int32"},"incorporation_form_file_id":{"type":"integer","description":"Region is Hong Kong Optional-Hong Kong Enterprise Incorporation Form (choose one of the annual return form)","format":"int32"},"br_expiry_date":{"type":"string","description":"region is Hong Kong Required-Hong Kong Enterprise Expiration Date: yyyy-MM-dd","format":"date"},"cr_issue_date":{"type":"string","description":"The region is Hong Kong Required-Hong Kong Enterprise Certificate Issue Date:yyyy-MM-dd","format":"date"},"company_article_file_id":{"type":"integer","description":"region is global EnterpriseRequired-Articles of Association File","format":"int32"},"cr_file_id":{"type":"integer","description":"Region is non-mainland Required-Hong Kong/Global Enterprise Company Registration Certificate","format":"int32"},"cr_no":{"type":"string","description":"Region is non-mainland Required-Hong Kong Enterprise Certificate Number/Global Enterprise Registration Certificate Number"},"share_structure_file_id":{"type":"integer","description":"region is Global EnterpriseRequired-Global Enterprise Equity Structure File","format":"int32"},"cr_expiry_date":{"type":"string","description":"Region is Global Required-Global Enterprise Expiration Date: yyyy-MM-dd","format":"date"},"other_file_ids":{"type":"array","description":"OtherAttachment","items":{"type":"integer","description":"OtherAttachment","format":"int32"}}},"description":"EnterpriseInformation","required":["region","ent_name","found_date","registered_currency","registered_capital"]},"business":{"type":"object","properties":{"main_industry":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Main Industrycode (see new IndustryAttachment), one of industry and main_industryRequired; subsequent versions of industry will be abandoned, please transform as soon as possible"},"children":[]}]}]}]},"sub_industry":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sub-camp Industrycode (see new IndustryAttachment), can be passed when main_industryRequired"},"children":[]}]}]}]},"industry":{"type":"integer","description":"Industry Data Dictionary INDUSTRY(See appendix)","format":"int32"},"employee_number":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of Enterprise employees: FIRST_LEVEL: less than 5 people, SECOND_LEVEL: 5-20 people, THIRD_LEVEL: 20-50 people, FOURTH_LEVEL: more than 50 people"},"children":[]}]}]}]},"address":{"$ref":"#/components/schemas/AddressDto","description":"EnterpriseBusinessAddressInformation"},"export_country":{"uniqueItems":true,"type":"array","description":"Mainly exports Country, array, UseISO3166-2 standard 2-digit Country/Region code (See appendix)","items":{"type":"string","description":"Mainly exports Country, array, UseISO3166-2 standard 2-digit Country/Region code (See appendix)"}},"export_type":{"uniqueItems":true,"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Export Type: SELF_SUPPORT-self-operated export, EXPORT-entrusted export, INTERNATIONAL-international express, OTHER-Other"},"children":[]}]}]}],"items":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Export Type: SELF_SUPPORT-self-operated export, EXPORT-entrusted export, INTERNATIONAL-international express, OTHER-Other"},"children":[]}]}]}]}},"trade_volume":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Monthly trade volume: FIRST_LEVEL (USD 0-50,000), SECOND_LEVEL (USD 50,000-100,000), THIRD_LEVEL (USD 100,000-250,000), FOURTH_LEVEL (USD 250,000-500,000), FIFTH_LEVEL (USD 500,000-1 million), SIXTH_LEVEL (more than 1 million US dollars)"},"children":[]}]}]}]},"website":{"maxLength":200,"minLength":0,"type":"string","description":"Company website (character length 200)"},"business_models":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Main BusinessType: B2BCollection-B2B_COLLECTIONS Platform Collection-PLATFORM_COLLECTIONS Independent Station Acquisition-INDEPENDENT_SITE_ACQUIRING"},"children":[]}]}]}]}},"description":"EnterpriseBusinessInformation","required":["main_industry","sub_industry","industry","employee_number","export_country","export_type","trade_volume"]},"stakeholder_list":{"type":"array","description":"EnterpriseAssociatedPersonalInformationList","items":{"type":"object","properties":{"identity_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identity Type: LEGAL_PERSON-Legal person, BENEFICIARY-Ultimate beneficiary, SHAREHOLDER-Shareholder, DIRECTOR-Director"},"children":[]}]}]}]},"name":{"maxLength":128,"minLength":0,"type":"string","description":"Name (length 128 characters)"},"nationality":{"maxLength":2,"minLength":0,"type":"string","description":"Nationality (ISO3166-2 standard 2-digit Country/Region code)"},"birth_date":{"type":"string","description":"Birthday, Formatyyyy-MM-dd, such as 2023-12-12","format":"date"},"address_proof_file_id":{"type":"integer","description":"Address proves File, non-Mainland China ID Card, Address proves FileRequired","format":"int32"},"doc_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID CardType ID_CARD: Second-generation resident ID Card, HK_CARD: Hong Kong permanent residence permit, PASSPORT: Passport, MO_CARD: Macao permanent residence permit, HK_MO_PASS: Mainland travel permit for Hong Kong and Macao residents, TW_CARD: Mainland travel permit for Taiwan residents"},"children":[]}]}]}]},"id_number":{"maxLength":18,"minLength":0,"type":"string","description":"ID Document number (length 18 characters)"},"doc_address":{"maxLength":256,"minLength":0,"type":"string","description":"ID DocumentDetailedAddress (length 256 characters), mainland ID CardRequired"},"doc_non_portrait_side_file_id":{"type":"integer","description":"File on the back of ID Document. Except for Passport and Mainland China Pass, which does not require RequiredProvide, OtherID DocumentType all require RequiredProvide.","format":"int32"},"doc_portrait_side_file_id":{"type":"integer","description":"ID Document frontFile","format":"int32"},"eff_date_start":{"type":"string","description":"ID Document starting date; Formatyyyy-MM-dd, such as 2023-12-12","format":"date"},"eff_date_end":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID Document expiration date; Formatyyyy-MM-dd, such as 2023-12-12, choose one from long_term, for others, press DateFormatUpload"},"children":[]}]}]}],"format":"date"},"long_term":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether it is long-term (Mainland ID DocumentOptional), choose one of eff_date_end"},"children":[]}]}]}]},"share":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shareholding ratio, percentage, 51.12% to 51.12, up to two decimal places, ultimate beneficiary, shareholder Required"},"children":[]}]}]}]},"resident_address":{"$ref":"#/components/schemas/AddressDto","description":"ResidenceAddressInformation"}},"required":["identity_type","name","birth_date","doc_type","id_number","doc_portrait_side_file_id","eff_date_start"]}}}}},"components/schemas/EntBusiness":{"id":"components/schemas/EntBusiness","kind":"json-schema","title":"EntBusiness","data":{"required":["employee_number","export_country","export_type","industry","trade_volume","main_industry","sub_industry"],"type":"object","properties":{"main_industry":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Main Industrycode (see new IndustryAttachment), one of industry and main_industryRequired; subsequent versions of industry will be abandoned, please transform as soon as possible"},"children":[]}]}]}]},"sub_industry":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sub-camp Industrycode (see new IndustryAttachment), can be passed when main_industryRequired"},"children":[]}]}]}]},"industry":{"type":"integer","description":"Industry Data Dictionary INDUSTRY(See appendix)","format":"int32"},"employee_number":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of Enterprise employees: FIRST_LEVEL: less than 5 people, SECOND_LEVEL: 5-20 people, THIRD_LEVEL: 20-50 people, FOURTH_LEVEL: more than 50 people"},"children":[]}]}]}]},"address":{"$ref":"#/components/schemas/AddressDto"},"export_country":{"uniqueItems":true,"type":"array","description":"Mainly exports Country, array, UseISO3166-2 standard 2-digit Country/Region code (See appendix)","items":{"type":"string","description":"Mainly exports Country, array, UseISO3166-2 standard 2-digit Country/Region code (See appendix)"}},"export_type":{"uniqueItems":true,"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Export Type: SELF_SUPPORT-self-operated export, EXPORT-entrusted export, INTERNATIONAL-international express, OTHER-Other"},"children":[]}]}]}],"items":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Export Type: SELF_SUPPORT-self-operated export, EXPORT-entrusted export, INTERNATIONAL-international express, OTHER-Other"},"children":[]}]}]}]}},"trade_volume":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Monthly trade volume: FIRST_LEVEL (USD 0-50,000), SECOND_LEVEL (USD 50,000-100,000), THIRD_LEVEL (USD 100,000-250,000), FOURTH_LEVEL (USD 250,000-500,000), FIFTH_LEVEL (USD 500,000-1 million), SIXTH_LEVEL (more than 1 million US dollars)"},"children":[]}]}]}]},"website":{"maxLength":200,"minLength":0,"type":"string","description":"Company website (character length 200)"},"business_models":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Main BusinessType: B2BCollection-B2B_COLLECTIONS Platform Collection-PLATFORM_COLLECTIONS Independent Station Acquisition-INDEPENDENT_SITE_ACQUIRING"},"children":[]}]}]}]}},"description":"EnterpriseBusinessInformation"}},"components/schemas/IdentityVerifyStatusRes":{"id":"components/schemas/IdentityVerifyStatusRes","kind":"json-schema","title":"IdentityVerifyStatusRes","data":{"required":["merch_id","status"],"type":"object","properties":{"merch_id":{"type":"string","description":"Merchantid","minLength":1,"maxLength":20},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identity Authentication Status: INIT-Initial WAIT-Pending Review PASS-ReviewApproved REFUSED-ReviewNot approved REJECTED-ReviewRejected AUTH_FAIL-AuthorizationCancel"},"children":[]}]}]}],"enum":["INIT","WAIT","PASS","REFUSED","AUTH_FAIL","REJECTED"]},"msg":{"type":"string","description":"Result description, not empty when Failed"},"risk_level":{"type":"string","description":"Risk level: LOW-low, MIDDLE-medium, HIGH-high","enum":["LOW","MIDDLE","HIGH"]}}}},"components/schemas/MerchOnboardApplyResultNotificationV2":{"id":"components/schemas/MerchOnboardApplyResultNotificationV2","kind":"json-schema","title":"MerchOnboardApplyResultNotificationV2","data":{"required":["merch_id","request_id","status"],"type":"object","properties":{"request_id":{"maxLength":32,"minLength":1,"type":"string","description":"Request number, Unique within the requesting system"},"merch_id":{"type":"string","description":"Merchantid","minLength":0,"maxLength":20},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identity authentication Status: INIT-Initial WAIT-Pending Review PASS-ReviewApproved REFUSED-ReviewNot approved AUTH_FAIL-AuthorizationCancel"},"children":[]}]}]}],"enum":["INIT","WAIT","PASS","REFUSED","AUTH_FAIL","REJECTED"]},"msg":{"type":"string","description":"ResultDescription"},"risk_level":{"type":"string","description":"Risk level: LOW-low, MIDDLE-medium, HIGH-high","enum":["LOW","MIDDLE","HIGH"]}},"description":"Notification message content"}},"schema_141":{"kind":"json-schema","data":{"type":"string","default":"M24061911365700670"},"id":"schema_141"},"schema_142":{"kind":"json-schema","data":{"type":"object","properties":{"request_id":{"maxLength":32,"minLength":1,"type":"string","description":"Request number, Unique within the requesting system"},"contact_person":{"description":"ContactInformation","type":"object","properties":{"phone_prefix":{"maxLength":5,"minLength":0,"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CountryRegion area code, such as: +86 or +852"},"children":[]}]}]}]},"phone":{"maxLength":64,"minLength":0,"type":"string","description":"ContactPhone (length 64 characters)"},"email":{"maxLength":64,"minLength":0,"type":"string","description":"ContactEmail(length 64 characters)"}},"required":["phone_prefix","phone","email"]},"license":{"type":"object","properties":{"region":{"maxLength":2,"minLength":0,"type":"string","description":"2-digit English CountryCode, refer to Appendix-CountryRegion Code"},"ent_name":{"maxLength":128,"minLength":0,"type":"string","description":"EnterpriseName (length 128 characters)"},"ent_name_en":{"type":"string","description":"Enterprise English Name (length 128 characters)","maxLength":128,"minLength":0},"found_date":{"type":"string","description":"Date established","format":"date"},"registered_currency":{"maxLength":3,"minLength":0,"type":"string","description":"Registered capital Currency symbol, Use ISO-4217 standard 3-digit Currency code"},"registered_capital":{"type":"number","description":"Registered capital, CurrencyMinimum Unit. If there is no registered capital, fill in 0; if reigon is a mainland enterprise, it is CNY, if it is a Hong Kong enterprise, it is HKD, and if it is a global enterprise, it is USD."},"address":{"description":"Enterprise registrationAddressInformation","type":"object","properties":{"province":{"type":"string","description":"Province/state, Mainland China Code(See attachment)","maxLength":50,"minLength":0},"city":{"maxLength":50,"minLength":0,"type":"string","description":"City, Mainland China Code(See attachment)"},"zipcode":{"maxLength":20,"minLength":0,"type":"string","description":"post code"},"address1":{"type":"string","description":"Address line 1"},"address2":{"type":"string","description":"Address line 2"}},"required":["province","city","zipcode","address1"]},"legal_rep_name":{"maxLength":128,"minLength":0,"type":"string","description":"Region is Mainland Required - Mainland Enterprise name of legal representative"},"license_file_id":{"type":"integer","description":"region is Mainland Required-Mainland Enterprise Business LicenseFile","format":"int32"},"ent_type":{"type":"string","description":"region is mainland Required-EnterpriseType: PERSONAL-IndividualMerchant, ENTERPRISE-Enterprise"},"uni_social_credit":{"maxLength":18,"minLength":0,"type":"string","description":"region is Mainland Required-Mainland Enterprise Unified Social Credit Code"},"busi_from":{"type":"string","description":"region is Mainland Required-Mainland Enterprise BusinessDate (starting)","format":"date"},"busi_end":{"type":"string","description":"Region is Mainland China Optional-Mainland Enterprise BusinessDate (only), and whether long-term are mutually exclusive Required, choose one of them, both pass the default long-term","format":"date"},"long_term":{"type":"boolean","description":"region is mainland Optional - whether it is long-term, and EnterpriseBusiness cut-off Date are mutually exclusive, and both default to long-term"},"br_no":{"type":"string","description":"region is Hong Kong Required-global Enterprise registration certificate number"},"br_file_id":{"type":"integer","description":"Region is Hong Kong Required-Global Enterprise Company Registration Certificate","format":"int32"},"annual_return_file_id":{"type":"integer","description":"Region is Hong Kong Optional - Hong Kong Enterprise Annual Return (choose one from the corporate establishment form)","format":"int32"},"incorporation_form_file_id":{"type":"integer","description":"Region is Hong Kong Optional-Hong Kong Enterprise Incorporation Form (choose one of the annual return form)","format":"int32"},"br_expiry_date":{"type":"string","description":"region is Hong Kong Required-Hong Kong Enterprise Expiration Date: yyyy-MM-dd","format":"date"},"cr_issue_date":{"type":"string","description":"The region is Hong Kong Required-Hong Kong Enterprise Certificate Issue Date:yyyy-MM-dd","format":"date"},"company_article_file_id":{"type":"integer","description":"region is global EnterpriseRequired-Articles of Association File","format":"int32"},"cr_file_id":{"type":"integer","description":"Region is non-mainland Required-Hong Kong/Global Enterprise Company Registration Certificate","format":"int32"},"cr_no":{"type":"string","description":"Region is non-mainland Required-Hong Kong Enterprise Certificate Number/Global Enterprise Registration Certificate Number"},"share_structure_file_id":{"type":"integer","description":"region is Global EnterpriseRequired-Global Enterprise Equity Structure File","format":"int32"},"cr_expiry_date":{"type":"string","description":"Region is Global Required-Global Enterprise Expiration Date: yyyy-MM-dd","format":"date"},"other_file_ids":{"type":"array","description":"OtherAttachment","items":{"type":"integer","description":"OtherAttachment","format":"int32"}}},"description":"EnterpriseInformation","required":["region","ent_name","ent_name_en","found_date","registered_currency","registered_capital","address"]},"business":{"type":"object","properties":{"main_industry":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Main Industrycode (see new IndustryAttachment), one of industry and main_industryRequired; subsequent versions of industry will be abandoned, please transform as soon as possible"},"children":[]}]}]}]},"sub_industry":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sub-camp Industrycode (see new IndustryAttachment), can be passed when main_industryRequired"},"children":[]}]}]}]},"industry":{"type":"integer","description":"Industry Data Dictionary INDUSTRY(See appendix)","format":"int32"},"employee_number":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of Enterprise employees: FIRST_LEVEL: less than 5 people, SECOND_LEVEL: 5-20 people, THIRD_LEVEL: 20-50 people, FOURTH_LEVEL: more than 50 people"},"children":[]}]}]}]},"address":{"description":"EnterpriseBusinessAddressInformation","type":"object","properties":{"province":{"type":"string","description":"Province/state, Mainland China Code(See attachment)","minLength":0,"maxLength":50},"city":{"maxLength":50,"minLength":0,"type":"string","description":"City, Mainland China Code(See attachment)"},"zipcode":{"maxLength":20,"minLength":0,"type":"string","description":"post code"},"address1":{"type":"string","description":"Address line 1"},"address2":{"type":"string","description":"Address line 2"}},"required":["province","city","zipcode","address1"]},"export_country":{"uniqueItems":true,"type":"array","description":"Main export Country (non-sanctioned Country), array, Use ISO3166-2 standard 2-digit Country/Region code (See appendix)","items":{"type":"string","description":"Mainly export Country, array, UseISO3166-2 standard 2-digit Country/Region code (See appendix)"}},"export_type":{"uniqueItems":true,"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Export Type: SELF_SUPPORT-self-operated export, EXPORT-entrusted export, INTERNATIONAL-international express, OTHER-Other"},"children":[]}]}]}],"items":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Export Type: SELF_SUPPORT-self-operated export, EXPORT-entrusted export, INTERNATIONAL-international express, OTHER-Other"},"children":[]}]}]}]}},"trade_volume":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Monthly trade volume: FIRST_LEVEL (USD 0-50,000), SECOND_LEVEL (USD 50,000-100,000), THIRD_LEVEL (USD 100,000-250,000), FOURTH_LEVEL (USD 250,000-500,000), FIFTH_LEVEL (USD 500,000-1 million), SIXTH_LEVEL (more than 1 million US dollars)"},"children":[]}]}]}]},"website":{"maxLength":200,"minLength":0,"type":"string","description":"Company website (character length 200)"},"business_models":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Main BusinessType: B2BCollection-B2B_COLLECTIONS Platform Collection-PLATFORM_COLLECTIONS Independent Station Acquisition-INDEPENDENT_SITE_ACQUIRING"},"children":[]}]}]}]}},"description":"EnterpriseBusinessInformation","required":["main_industry","sub_industry","industry","employee_number","address","export_country","export_type","trade_volume"]},"stakeholder_list":{"type":"array","description":"EnterpriseAssociatedPersonalInformationList","items":{"type":"object","properties":{"identity_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identity Type: LEGAL_PERSON-Legal person, BENEFICIARY-Ultimate beneficiary, SHAREHOLDER-Shareholder, DIRECTOR-Director"},"children":[]}]}]}]},"name":{"maxLength":128,"minLength":0,"type":"string","description":"Name (length 128 characters)"},"nationality":{"maxLength":2,"minLength":0,"type":"string","description":"Nationality (ISO3166-2 standard 2-digit Country/Region code)"},"birth_date":{"type":"string","description":"Birthday, Formatyyyy-MM-dd, such as 2023-12-12","format":"date"},"address_proof_file_id":{"type":"integer","description":"Address proves File, non-Mainland China ID Card, Address proves FileRequired","format":"int32"},"doc_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID CardType ID_CARD: Second-generation resident ID Card, HK_CARD: Hong Kong permanent residence permit, PASSPORT: Passport, MO_CARD: Macao permanent residence permit, HK_MO_PASS: Mainland travel permit for Hong Kong and Macao residents, TW_CARD: Mainland travel permit for Taiwan residents"},"children":[]}]}]}]},"id_number":{"maxLength":18,"minLength":0,"type":"string","description":"ID Document number (length 18 characters)"},"doc_address":{"maxLength":256,"minLength":0,"type":"string","description":"ID DocumentDetailedAddress (length 256 characters), mainland ID CardRequired"},"doc_non_portrait_side_file_id":{"type":"integer","description":"File on the back of ID Document. Except for Passport and Mainland China Pass, which does not require RequiredProvide, OtherID DocumentType all require RequiredProvide.","format":"int32"},"doc_portrait_side_file_id":{"type":"integer","description":"ID Document frontFile","format":"int32"},"eff_date_start":{"type":"string","description":"ID Document starting date; Formatyyyy-MM-dd, such as 2023-12-12","format":"date"},"eff_date_end":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID Document expiration date; Formatyyyy-MM-dd, such as 2023-12-12, choose one from long_term, for others, press DateFormatUpload"},"children":[]}]}]}],"format":"date"},"long_term":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether it is long-term (Mainland ID DocumentOptional), choose one of eff_date_end"},"children":[]}]}]}]},"share":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shareholding ratio, percentage, 51.12% to 51.12, up to two decimal places, ultimate beneficiary, shareholder Required"},"children":[]}]}]}]},"resident_address":{"description":"Resident Address","type":"object","properties":{"province":{"type":"string","description":"Province/state, Mainland China Code(See attachment)","minLength":0,"maxLength":50},"city":{"maxLength":50,"minLength":0,"type":"string","description":"City, Mainland China Code(See attachment)"},"zipcode":{"maxLength":20,"minLength":0,"type":"string","description":"post code"},"address1":{"type":"string","description":"Address line 1"},"address2":{"type":"string","description":"Address line 2"}},"required":["province","city","zipcode","address1"]}},"required":["identity_type","name","nationality","birth_date","doc_type","id_number","doc_portrait_side_file_id","eff_date_start","resident_address"]}}},"required":["request_id","contact_person","license","business","stakeholder_list"]},"id":"schema_142"},"schema_143":{"kind":"json-schema","data":{"$ref":"#/components/schemas/%E5%93%8D%E5%BA%94"},"id":"schema_143"},"schema_144":{"kind":"json-schema","data":{"type":"object","properties":{"merch_id":{"type":"string","description":"Merchantid","minLength":1,"maxLength":20},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identity Authentication Status: INIT-Initial WAIT-Pending Review PASS-ReviewApproved REFUSED-ReviewNot approved REJECTED-ReviewRejected AUTH_FAIL-AuthorizationCancel"},"children":[]}]}]}],"enum":["INIT","WAIT","PASS","REFUSED","AUTH_FAIL","REJECTED"]},"msg":{"type":"string","description":"Result description, not empty when Failed"}},"required":["merch_id","status"]},"id":"schema_144"},"schema_145":{"kind":"json-schema","data":{"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BusinessType: MERCH-Merchant, VA-Virtual Account, INCOMING_REMITTANCE-Import Remittance, CONTRACT_ORDER-ContractOrder, TRADE_SETTLE-SettlementCrediting, PAYEE-Collection, WD_ACCOUNT-Withdraw Account, CUR_EXCHANGE-FX, PAYMENT-Payment"},"children":[]}]}]}],"enum":["MERCH","VA","INCOMING_REMITTANCE","CONTRACT_ORDER","TRADE_SETTLE","PAYEE","WD_ACCOUNT","FOREX","PAYMENT"]},"version":{"type":"string","description":"Version number (V1, V2,...)"},"data":{"type":"object","properties":{"request_id":{"maxLength":32,"minLength":1,"type":"string","description":"Request number, Unique within the requesting system"},"merch_id":{"type":"string","description":"Merchantid","minLength":0,"maxLength":20},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identity authentication Status: INIT-Initial WAIT-Pending Review PASS-ReviewApproved REFUSED-ReviewNot approved AUTH_FAIL-AuthorizationCancel"},"children":[]}]}]}],"enum":["INIT","WAIT","PASS","REFUSED","AUTH_FAIL","REJECTED"]},"msg":{"type":"string","description":"ResultDescription"}},"description":"BusinessData","required":["request_id","merch_id","status"]}},"required":["type","version","data"]},"id":"schema_145"},"schema_146":{"kind":"json-schema","data":{"type":"object","properties":{}},"id":"schema_146"},"schema_147":{"kind":"json-schema","data":{"type":"object","properties":{"request_id":{"type":"string","description":"Request number, Unique within the requesting system","maxLength":32,"minLength":1},"type":{"type":"string","description":"AccountType LOCAL-local,SWIFT-global","enum":["LOCAL","GLOBAL"]},"country_code":{"type":"string","description":"CollectionCountry, Return as is"},"currencies":{"uniqueItems":true,"type":"array","description":"CollectionCurrency, Return as is","items":{"type":"string","description":"Currency: EUR - Euro, USD - United States dollar, CNY - Chinese yuan, GBP - British pound, JPY - Japanese yen, AUD - Australian dollar, CAD - Canadian dollar, SGD - Singapore dollar, HKD - Hong Kong dollar, PHP - Philippine peso, THB - Thai baht, CNH - offshore Chinese yuan","enum":["EUR","USD","CNY","GBP","JPY","AUD","CAD","SGD","HKD","PHP","CNH"]}},"account_no":{"maxLength":20,"minLength":0,"type":"string","description":"Collection account (length 20 characters)"},"status":{"type":"string","description":"AccountStatus: ENABLED-enabled, PENDING-pending Review, REJECTED-ReviewRejected","enum":["ENABLED","PENDING","REJECTED"]},"bank_name":{"maxLength":64,"minLength":0,"type":"string","description":"BankName (length 64 characters)"},"bank_address":{"maxLength":128,"minLength":0,"type":"string","description":"BankAddress (length 128 characters)"},"account_holder_name":{"maxLength":100,"minLength":0,"type":"string","description":"Account holder (100 characters)"},"bic_swift_code":{"maxLength":16,"minLength":0,"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"bic/swift_code (length 16 characters)"},"children":[]}]}]}]},"routing_number":{"type":"string","description":"routing number/ach routing number/wire routing number three returns one"}},"required":["request_id","type","country_code","currencies","account_no","status","bank_name","bank_address","account_holder_name","bic_swift_code"]},"id":"schema_147"},"schema_148":{"kind":"json-schema","data":{"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BusinessType: MERCH-Merchant, VA-Virtual Account, INCOMING_REMITTANCE-Import Remittance, CONTRACT_ORDER-ContractOrder, TRADE_SETTLE-SettlementCrediting, PAYEE-Collection, WD_ACCOUNT-Withdraw Account, CUR_EXCHANGE-FX, PAYMENT-Payment"},"children":[]}]}]}]},"version":{"type":"string","description":"Version number (V1, V2,...)"},"data":{"type":"object","properties":{"request_id":{"type":"string","description":"Request number, Unique within the requesting system","minLength":1,"maxLength":32},"merch_id":{"type":"string","description":"Merchantid","minLength":1,"maxLength":20},"status":{"type":"string","description":"AccountStatus: ENABLED-enabled, PENDING-pending Review, REJECTED-ReviewRejected"},"currencies":{"type":"array","items":{"type":"string"},"description":"CollectionCurrency, Return as is"},"country_code":{"type":"string","description":"CollectionCountry, Return as is"},"type":{"type":"string","description":"AccountType LOCAL-local,SWIFT-global"},"account_no":{"type":"string","description":"Collection account"},"bic_swift_code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"bic/swift_code"},"children":[]}]}]}]},"bank_name":{"type":"string","description":"BankName"},"bank_address":{"type":"string","description":"BankAddress"},"routing_number":{"type":"string","description":"routing number/ach routing number/wire routing number three returns one"}},"required":["merch_id","request_id"],"description":"BusinessData"}},"required":["type","data","version"]},"id":"schema_148"},"schema_149":{"kind":"json-schema","data":{"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BusinessType: MERCH-Merchant, VA-Virtual Account, INCOMING_REMITTANCE-Import Remittance, CONTRACT_ORDER-ContractOrder, TRADE_SETTLE-SettlementCrediting, PAYEE-Collection, WD_ACCOUNT-Withdraw Account, CUR_EXCHANGE-FX, PAYMENT-Payment"},"children":[]}]}]}],"enum":["MERCH","VA","INCOMING_REMITTANCE","CONTRACT_ORDER","TRADE_SETTLE","PAYEE","WD_ACCOUNT","FOREX","PAYMENT"]},"version":{"type":"string","description":"Version number (V1, V2,...)"},"data":{"type":"object","properties":{"merch_id":{"type":"string","description":"CollectionMerchantid","minLength":1,"maxLength":20},"order_no":{"type":"string","description":"paykkaCollection order number","minLength":1,"maxLength":32},"amount":{"type":"integer","description":"Import RemittanceAmount(CurrencyMinimum Unit)","format":"int64"},"currency":{"type":"string","description":"Currency: EUR - Euro, USD - United States dollar, CNY - Chinese yuan, GBP - British pound, JPY - Japanese yen, AUD - Australian dollar, CAD - Canadian dollar, SGD - Singapore dollar, HKD - Hong Kong dollar, PHP - Philippine peso, CNH - offshore Chinese yuan","enum":["EUR","USD","CNY","GBP","JPY","AUD","CAD","SGD","HKD","PHP","CNH"]},"payer":{"type":"string","description":"Payer"},"payment_account":{"type":"string","description":"Payment account"},"payer_bank_bic":{"type":"string","description":"PaymentBankBIC"},"payer_bank_name":{"type":"string","description":"PayerBankName"},"payee":{"type":"string","description":"Collection people"},"recv_account":{"type":"string","description":"Collection account"},"recv_time":{"type":"string","description":"CollectionTime","format":"date-time"},"remark":{"type":"string","description":"P.S."}},"description":"BusinessData","required":["merch_id","order_no","amount","currency","recv_account","recv_time"]}},"required":["type","version","data"]},"id":"schema_149"},"schema_150":{"kind":"json-schema","data":{"type":"object","properties":{"request_id":{"maxLength":32,"minLength":1,"type":"string","description":"Request number, Unique within the requesting system"},"buyer_country":{"type":"string","description":"Buy country code, Use ISO3166-2 standard 2-digit country code (See appendix)"},"buyer_name":{"maxLength":128,"minLength":1,"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Buyer’s name (Max 128 characters)"},"children":[]}]}]}]},"amount":{"type":"integer","description":"OrderAmount(CurrencyMinimum Unit)","format":"int64"},"currency":{"type":"string","description":"Currency: EUR - Euro, USD - United States dollar, CNY - Chinese yuan, GBP - British pound, JPY - Japanese yen, AUD - Australian dollar, CAD - Canadian dollar, SGD - Singapore dollar, HKD - Hong Kong dollar, PHP - Philippine peso, CNH - offshore Chinese yuan","enum":["EUR","USD","CNY","GBP","JPY","AUD","CAD","SGD","HKD","PHP","CNH"]},"contract_no":{"maxLength":32,"minLength":1,"type":"string","description":"ContractNumber(Max 32 characters)(can only be numbers and letters)(Unique under Merchant)"},"contract_file_ids":{"maxItems":10,"minItems":1,"type":"array","description":"ContractAttachmentid-UploadFileAPIReturn id (up to 10 Files)","items":{"type":"integer","description":"ContractAttachmentid-UploadFileAPIReturn id (up to 10 Files)","format":"int32"}},"goods_info":{"type":"object","properties":{"category":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product Category (Support’s Product CategorySee attachment)"},"children":[]}]}]}],"format":"int32"},"name":{"maxLength":128,"minLength":1,"type":"string","description":"Product Name(Max 128 characters)"},"quantity":{"type":"integer","description":"Product quantity","format":"int64"},"url":{"type":"string","description":"Product URL","maxLength":256,"minLength":1},"custom_dec_info":{"type":"object","properties":{"dec_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Declaration method: METHOD_1-Not reported at the customs or Not included in the customs statistics for e-commerce TransactionOrder METHOD_2-Declared for export at the customs according to the general trade method"},"children":[]}]}]}]},"dec_no":{"type":"string","description":"Customs declaration number (Max 32 characters)","minLength":0,"maxLength":32}},"required":["dec_method"],"description":"Customs declarationInformation"}},"description":"ProductInformation","required":["category","name","url","custom_dec_info"]},"invoice_file_ids":{"maxItems":10,"minItems":1,"type":"array","description":"PI/CI/Invoice id-UploadFileAPIReturnid (up to 10 Files)","items":{"type":"integer","description":"PI/CI/Invoice id-UploadFileAPIReturnid (up to 10 Files)","format":"int32"}},"is_exchange_settle":{"type":"boolean","description":"Whether settlement of foreign exchange is Required"},"logistics_info":{"type":"object","properties":{"buyer_type":{"type":"string","description":"NEW-New Buyer;OLD-Old Buyer Not shipping must be passed on","enum":["NEW","OLD"]},"destination":{"maxLength":256,"minLength":1,"type":"string","description":"Destination must be passed when shipping (Max 256 characters)"},"expected_ship_date":{"type":"string","description":"Must be passed when ShippingDate Not shipping is expected. Format:yyyy-MM-dd","format":"date"},"freight_arrange_file_ids":{"maxItems":10,"minItems":1,"type":"array","description":"Freight arrangement communication record id-UploadFileAPIReturnid (up to 10 Files), must be passed to the new Buyer","items":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Freight arrangement communication record id-UploadFileAPIReturnid Must be transmitted when LogisticsStatus=UNSHIPPED (maximum 10 Files)"},"children":[]}]}]}],"format":"int32"}},"latest_order_file_ids":{"maxItems":10,"minItems":1,"type":"array","description":"The customs declaration form or outbound logistics voucher id-UploadFileAPIReturnid of the most recent transaction between Merchant and the Buyer must be passed to the old Buyer (up to 10 Files)","items":{"type":"integer","description":"The customs declaration form or outbound logistics voucher id-UploadFileAPIReturnid of the most recent transaction between Merchant and the Buyer must be passed to the old Buyer (up to 10 Files)","format":"int32"}},"logistics_company_name":{"maxLength":256,"minLength":1,"type":"string","description":"Logistics company name must be passed when shipping (Max 256 characters)"},"outbound_no":{"maxLength":32,"minLength":1,"type":"string","description":"Outbound Logistics tracking number must be sent when shipping ((Max 32 characters)"},"inquiry_records_file_ids":{"maxItems":10,"minItems":1,"type":"array","description":"Inquiry and order communication record-UploadFileAPIReturn id (up to 10 Files), must be passed to the new Buyer","items":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Inquiry and order communication record - UploadFileAPIReturn must be transmitted when the id LogisticsStatus=UNSHIPPED (up to 10 Files)"},"children":[]}]}]}],"format":"int32"}},"ship_date":{"type":"string","description":"ShippingDate must be passed when shipping Format:yyyy-MM-dd","format":"date"},"ship_status":{"type":"string","description":"LogisticsStatus: SHIPPED-Shipping UNSHIPPED-Not shipping","enum":["SHIPPED","UNSHIPPED"]},"shipped_file_ids":{"maxItems":10,"minItems":1,"type":"array","description":"Shipping voucher id-the id of UploadFileAPIReturn must be passed when shipping (up to 10 Files)","items":{"type":"integer","description":"Shipping voucher id-the id of UploadFileAPIReturn must be passed when shipping (up to 10 Files)","format":"int32"}},"transaction_type":{"type":"string","description":"Transaction method: EXW-Ex factory FCA-Free carrier FAS-Free alongside ship FOB-Free on board CFR-Cost and freight CIF-Cost, insurance and freight CPT-Freight paid to DDP-Delivered duty paid DAF-Delivered at the border DDU-Not Delivered duty paid DEQ-Delivered at the port of destination DES-Free on board at the port of destination","enum":["EXW","FCA","FAS","FOB","CFR","CIF","CPT","DDP","DAF","DDU","DEQ","DES"]},"transport_type":{"type":"string","description":"Transportation method: AIR-Air SHIPPING-Sea EXPRESS-Express LAND-Land POST-Post OTHER-Other","enum":["AIR","SHIPPING","EXPRESS","LAND","POST","OTHER"]}},"description":"LogisticsInformation","required":["ship_status","transaction_type"]},"order_date":{"type":"string","description":"OrderTime Format: yyyy-MM-dd","format":"date"},"remark":{"maxLength":128,"minLength":0,"type":"string","description":"Remark (length 128 characters)"},"other_file_ids":{"type":"array","description":"OtherAttachmentid-UploadFileAPIReturn id","items":{"type":"integer","description":"OtherAttachmentid-UploadFileAPIReturn id","format":"int32"}}},"required":["request_id","buyer_country","buyer_name","amount","currency","contract_no","contract_file_ids","goods_info","invoice_file_ids","is_exchange_settle","logistics_info","order_date"]},"id":"schema_150"},"schema_151":{"kind":"json-schema","data":{"type":"object","properties":{"request_id":{"maxLength":32,"minLength":1,"type":"string","description":"Request number, Unique within the requesting system"},"buyer_name":{"maxLength":128,"minLength":1,"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Buyer’s name (Max 128 characters)"},"children":[]}]}]}]},"buyer_country":{"type":"string","description":"Buy country code, Use ISO3166-2 standard 2-digit country code (See appendix)"},"amount":{"type":"integer","description":"OrderAmount(CurrencyMinimum Unit)","format":"int64"},"currency":{"type":"string","description":"Currency: EUR - Euro, USD - United States dollar, CNY - Chinese yuan, GBP - British pound, JPY - Japanese yen, AUD - Australian dollar, CAD - Canadian dollar, SGD - Singapore dollar, HKD - Hong Kong dollar, PHP - Philippine peso, CNH - offshore Chinese yuan","enum":["EUR","USD","CNY","GBP","JPY","AUD","CAD","SGD","HKD","PHP","CNH"]},"contract_file_ids":{"maxItems":10,"minItems":1,"type":"array","description":"ContractAttachmentid-UploadFileAPIReturn id (up to 10 Files)","items":{"type":"integer","description":"ContractAttachmentid-UploadFileAPIReturn id (up to 10 Files)","format":"int32"}},"contract_no":{"maxLength":32,"minLength":1,"type":"string","description":"ContractNumber(Max 32 characters)(can only be numbers and letters)(Unique under Merchant)"},"goods_info":{"type":"object","properties":{"category":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product Category (Support’s Product CategorySee attachment)"},"children":[]}]}]}],"format":"int32"},"name":{"maxLength":128,"minLength":1,"type":"string","description":"Product Name(Max 128 characters)"},"quantity":{"type":"integer","description":"Product quantity","format":"int64"},"url":{"type":"string","description":"Product URL","maxLength":256,"minLength":1},"custom_dec_info":{"type":"object","properties":{"dec_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Declaration method: METHOD_1-Not reported at the customs or Not included in the customs statistics for e-commerce TransactionOrder METHOD_2-Declared for export at the customs according to the general trade method"},"children":[]}]}]}]},"dec_no":{"type":"string","description":"Customs declaration number (Max 32 characters)","minLength":0,"maxLength":32}},"required":["dec_method"],"description":"Customs declarationInformation"}},"description":"ProductInformation","required":["category","name","url","custom_dec_info"]},"invoice_file_ids":{"maxItems":10,"minItems":1,"type":"array","description":"PI/CI/Invoice id-UploadFileAPIReturnid (up to 10 Files)","items":{"type":"integer","description":"PI/CI/Invoice id-UploadFileAPIReturnid (up to 10 Files)","format":"int32"}},"is_exchange_settle":{"type":"boolean","description":"Whether settlement of foreign exchange is Required"},"logistics_info":{"type":"object","properties":{"buyer_type":{"type":"string","description":"NEW-New Buyer's home;OLD-Old Buyer's home","enum":["NEW","OLD"]},"destination":{"maxLength":256,"minLength":1,"type":"string","description":"Destination must be passed when shipping (Max 256 characters)"},"expected_ship_date":{"type":"string","description":"Must be passed when ShippingDate Not shipping is expected. Format:yyyy-MM-dd","format":"date"},"freight_arrange_file_ids":{"maxItems":10,"minItems":1,"type":"array","description":"Freight arrangement communication record id-UploadFileAPIReturnid (up to 10 Files), must be passed to the new Buyer","items":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Freight arrangement communication record id-UploadFileAPIReturnid Must be transmitted when LogisticsStatus=UNSHIPPED (maximum 10 Files)"},"children":[]}]}]}],"format":"int32"}},"latest_order_file_ids":{"maxItems":10,"minItems":1,"type":"array","description":"The customs declaration form or outbound logistics voucher id-UploadFileAPIReturnid of the most recent transaction between Merchant and the Buyer must be passed to the old Buyer (up to 10 Files)","items":{"type":"integer","description":"The customs declaration form or outbound logistics voucher id-UploadFileAPIReturnid of the most recent transaction between Merchant and the Buyer must be passed to the old Buyer (up to 10 Files)","format":"int32"}},"logistics_company_name":{"maxLength":256,"minLength":1,"type":"string","description":"Logistics company name must be passed when shipping (Max 256 characters)"},"outbound_no":{"maxLength":32,"minLength":1,"type":"string","description":"Outbound Logistics tracking number must be sent when shipping ((Max 32 characters)"},"inquiry_records_file_ids":{"maxItems":10,"minItems":1,"type":"array","description":"Inquiry and order communication record-UploadFileAPIReturn id (up to 10 Files), must be passed to the new Buyer","items":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Inquiry and order communication record - UploadFileAPIReturn must be transmitted when the id LogisticsStatus=UNSHIPPED (up to 10 Files)"},"children":[]}]}]}],"format":"int32"}},"ship_date":{"type":"string","description":"ShippingDate must be passed when shipping Format:yyyy-MM-dd","format":"date"},"ship_status":{"type":"string","description":"LogisticsStatus: SHIPPED-Shipping UNSHIPPED-Not shipping","enum":["SHIPPED","UNSHIPPED"]},"shipped_file_ids":{"maxItems":10,"minItems":1,"type":"array","description":"Shipping voucher id-the id of UploadFileAPIReturn must be passed when shipping (up to 10 Files)","items":{"type":"integer","description":"Shipping voucher id-the id of UploadFileAPIReturn must be passed when shipping (up to 10 Files)","format":"int32"}},"transaction_type":{"type":"string","description":"Transaction method: EXW-Ex factory FCA-Free carrier FAS-Free alongside ship FOB-Free on board CFR-Cost and freight CIF-Cost, insurance and freight CPT-Freight paid to DDP-Delivered duty paid DAF-Delivered at the border DDU-Not Delivered duty paid DEQ-Delivered at the port of destination DES-Free on board at the port of destination","enum":["EXW","FCA","FAS","FOB","CFR","CIF","CPT","DDP","DAF","DDU","DEQ","DES"]},"transport_type":{"type":"string","description":"Transportation method: AIR-Air SHIPPING-Sea EXPRESS-Express LAND-Land POST-Post OTHER-Other","enum":["AIR","SHIPPING","EXPRESS","LAND","POST","OTHER"]}},"description":"LogisticsInformation","required":["ship_status","transaction_type"]},"order_date":{"type":"string","description":"OrderTime Format: yyyy-MM-dd","format":"date"},"remark":{"maxLength":128,"minLength":0,"type":"string","description":"Remark (length 128 characters)"},"other_file_ids":{"type":"array","description":"OtherAttachmentid-UploadFileAPIReturn id","items":{"type":"integer","description":"OtherAttachmentid-UploadFileAPIReturn id","format":"int32"}}},"required":["request_id","buyer_name","buyer_country","amount","currency","contract_file_ids","contract_no","goods_info","invoice_file_ids","is_exchange_settle","logistics_info","order_date"]},"id":"schema_151"},"schema_152":{"kind":"json-schema","data":{"type":"object","properties":{"contract_order_no":{"type":"string","description":"OrderNumber","minLength":1,"maxLength":32},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Open PlatformContractOrderStatus RELATABLE-Associated ALL_RELATED-Associated"},"children":[]}]}]}],"enum":["RELATABLE","ALL_RELATED"]},"amount":{"type":"integer","description":"Open Platform ContractOrder Total Amount"},"relatable_amount":{"type":"integer","description":"Open Platform ContractOrder Remaining AssociatedAmount"}},"required":["contract_order_no","status","amount","relatable_amount"]},"id":"schema_152"},"schema_153":{"kind":"json-schema","data":{"type":"object","properties":{"request_id":{"maxLength":32,"minLength":1,"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request number, Unique in the Request party system (request_id of OrderAPI of RequiredSupplement)"},"children":[]}]}]}]},"logistics_company_name":{"type":"string","description":"Logistics Company Name"},"transport_type":{"type":"string","description":"Transportation method: AIR-Air SHIPPING-Sea EXPRESS-Express LAND-Land POST-Post OTHER-Other","enum":["AIR","SHIPPING","EXPRESS","LAND","POST","OTHER"]},"outbound_no":{"type":"string","description":"Outbound Logistics tracking number"},"destination":{"type":"string","description":"destination"},"ship_date":{"type":"string","description":"ShippingDate(TimeFormat: yyyy-MM-dd)","format":"date"},"shipped_file_ids":{"maxItems":10,"minItems":1,"type":"array","description":"Shipping VoucherFileIDList","items":{"type":"integer","description":"Shipping VoucherFileIDList","format":"int32"}}},"required":["request_id","logistics_company_name","transport_type","outbound_no","destination","ship_date","shipped_file_ids"]},"id":"schema_153"},"schema_154":{"kind":"json-schema","data":{"type":"string"},"id":"schema_154"},"schema_155":{"kind":"json-schema","data":{"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BusinessType: MERCH-Merchant, VA-Virtual Account, INCOMING_REMITTANCE-Import Remittance, CONTRACT_ORDER-ContractOrder, TRADE_SETTLE-SettlementCrediting, PAYEE-Collection, WD_ACCOUNT-Withdraw Account, CUR_EXCHANGE-FX, PAYMENT-Payment"},"children":[]}]}]}],"enum":["MERCH","VA","INCOMING_REMITTANCE","CONTRACT_ORDER","TRADE_SETTLE","PAYEE","WD_ACCOUNT","FOREX","PAYMENT"]},"version":{"type":"string","description":"Version number (V1, V2,...)"},"data":{"type":"object","properties":{"merch_id":{"type":"string","description":"Merchantid","minLength":1,"maxLength":20},"reason":{"type":"string","description":"The most recentReviewRejectedReason"},"recv_order_no":{"type":"string","description":"Collection order id (the order number imported into RemittanceNotification)","minLength":1,"maxLength":32},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status(PENDING_RELATE-pending AssociatedOrder, PENDING_REVIEW-Review, CREDITED-Crediting, PENDING_REFUND-Refund, REJECTED-ReviewNot approved, REFUNDED-Refund)"},"children":[]}]}]}],"enum":["PENDING_RELATE","PENDING_REVIEW","CREDITED","REJECTED","PENDING_REFUND","REFUNDED"]}},"description":"BusinessData","required":["merch_id","recv_order_no","status"]}},"required":["type","version","data"]},"id":"schema_155"},"schema_156":{"kind":"json-schema","data":{"type":"object","properties":{"currency":{"type":"string","description":"Currency: EUR - Euro, USD - United States dollar, CNY - Chinese yuan, GBP - British pound, JPY - Japanese yen, AUD - Australian dollar, CAD - Canadian dollar, SGD - Singapore dollar, HKD - Hong Kong dollar, PHP - Philippine peso, CNH - offshore Chinese yuan","enum":["EUR","USD","CNY","GBP","JPY","AUD","CAD","SGD","HKD","PHP","CNH"]}}},"id":"schema_156"},"schema_157":{"kind":"json-schema","data":{"type":"object","properties":{"request_id":{"maxLength":32,"minLength":1,"type":"string","description":"Request number, Unique within the requesting system"},"type":{"type":"string","description":"Purpose (Required): PAYMENT-Collection, WITHDRAWAL-Withdrawal"},"beneficiary":{"type":"object","properties":{"purpose":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CollectionType PFG-payment LWF-Logistics warehousing fee ASF-advertising service fee TSF-technical service fee CSF-consulting service fee OTHER-Other Data dictionary:PAYEE_TYPE"},"children":[]}]}]}],"enum":["PFG","LWF","ASF","TSF","CSF","OTHER"]},"purpose_desc":{"maxLength":100,"minLength":0,"type":"string","description":"CollectionType description, Required when OtherCollectionType (Max 100 characters), Required when purpose is OTHER"},"country":{"type":"string","description":"Country code, Use ISO3166-2 standard 2-digit Country code, non-sanctioned Country (See appendix)"},"industry":{"type":"integer","description":"Mainly engaged in Industry (See attachment), Required when the company has a public account and is a member of the Collection","format":"int32"},"main_industry":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Main Industrycode (see new IndustryAttachment), Required when the company Account is a Collection member, and one of industry and main_industryRequired; subsequent versions of industry will be abandoned, please modify it as soon as possible"},"children":[]}]}]}]},"sub_industry":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sub-camp Industrycode (see new IndustryAttachment), can be passed when main_industryRequired"},"children":[]}]}]}]},"nick_name":{"maxLength":100,"minLength":0,"type":"string","description":"Account nickname(Max 100 characters)"},"first_name":{"maxLength":100,"minLength":1,"type":"string","description":"Beneficiary first name (Overseas Collection person-to-private Required) (Max 100 characters)"},"last_name":{"maxLength":100,"minLength":1,"type":"string","description":"Beneficiary last name (overseas Collection person-to-private Required) (Max 100 characters)"},"doc_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID DocumentType (domestic individual AccountRequired), domestic individual AccountRequired and is ID_CARD"},"children":[]}]}]}]},"id_number":{"maxLength":100,"minLength":0,"type":"string","description":"ID Document number (domestic personal AccountRequired) (Max 100 characters)"},"uni_social_credit":{"maxLength":18,"minLength":0,"type":"string","description":"Unified Social Credit Code (domestic corporate AccountRequired) (Max 18 characters)"},"address":{"type":"object","properties":{"province":{"type":"string","description":"State/Province (United States/Canada/Mexico and BankCurrencyAccount is not CNYRequired)"},"city":{"maxLength":50,"minLength":0,"type":"string","description":"City(overseas required)"},"zipcode":{"maxLength":20,"minLength":0,"type":"string","description":"Postal code (required overseas)"},"address1":{"maxLength":50,"minLength":0,"type":"string","description":"BankAccount holder Address (overseas Required)"},"address2":{"type":"string","description":"Address line 2"}},"description":"BeneficiaryAddressInformation","required":["province","city","zipcode","address1"]}},"description":"CollectionPeopleInformation","required":["purpose","country"]},"bank_acc":{"description":"BankAccountInformation","type":"object","properties":{"country":{"type":"string","description":"Country code, Use ISO3166-2 standard 2-digit Country code, non-sanctioned Country (See appendix)","maxLength":2,"minLength":0,"example":"CN"},"currency":{"type":"string","description":"Currency: EUR - Euro, USD - United States dollar, CNY - Chinese yuan, GBP - British pound, JPY - Japanese yen, AUD - Australian dollar, CAD - Canadian dollar, SGD - Singapore dollar, HKD - Hong Kong dollar, PHP - Philippine peso, CNH - offshore Chinese yuan","enum":["EUR","USD","CNY","GBP","JPY","AUD","CAD","SGD","HKD","PHP","CNH"]},"acc_name":{"maxLength":100,"minLength":1,"type":"string","description":"AccountName(Max 100 characters)"},"acc_type":{"type":"string","description":"AccountType: PRIVATE-Personal Account, COMPANY-Enterprise Corporate","enum":["PRIVATE","COMPANY"]},"acc_no":{"maxLength":100,"minLength":0,"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bank account number, choose one from acc_no or iban"},"children":[]}]}]}]},"payment_type":{"type":"string","description":"Payment clearing network: LOCAL - local payment, SWIFT - international payment","enum":["LOCAL","SWIFT"]},"routing_code_type1":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must when LOCAL clearing network (the enumeration value will be expanded as the business develops): ABA (local payment network code in the United States), FASTER_PAYMENT (local payment network code in the United Kingdom), CHAPS (local payment network code in the United Kingdom), SORT_CODE, BANK_CODE (see BankCodeAttachment for details within the country, and fill it out truthfully in Canada)"},"children":[]}]}]}]},"routing_code_value1":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must when routing_code_type1 is not empty"},"children":[]}]}]}]},"routing_code_type2":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LOCAL clearing network sub-Type (the enumeration value will be expanded as the business develops): BRANCH_BANK_CODE (see BankCodeAttachment for details within the country, and fill in the details truthfully for overseas countries such as Canada)"},"children":[]}]}]}]},"routing_code_value2":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must when routing_code_type2 is not empty"},"children":[]}]}]}]},"iban":{"maxLength":50,"minLength":0,"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IBAN, unique to Eurozone Accounts, choose one of acc_no and iban"},"children":[]}]}]}]},"bic_swift":{"type":"string","description":"swift code or bic, when SWIFT clears the network, other countries and regions require Upload this Field (only supports 8 or 11 bits)","maxLength":11,"minLength":8,"example":"ABCDEFGH"},"bank_acc_type":{"type":"string","description":"BankAccountType CHECKING-Cheque SAVINGS-Debit Card","enum":["CHECKING","SAVINGS"]},"bank_addr":{"maxLength":100,"minLength":0,"type":"string","description":"Account OpeningBankDetailedAddress(overseas AccountRequired)(Max 100 characters)"},"bank_name":{"maxLength":100,"minLength":0,"type":"string","description":"Account OpeningBankName(overseas AccountRequired; Max 100 characters)"},"branch_bank_name":{"maxLength":100,"minLength":0,"type":"string","description":"Account OpeningBank Branch Name(Max 100 characters)"},"phone":{"type":"string","description":"Bank reserved mobile phone number (Mainland RMB private cash withdrawal)","maxLength":11,"minLength":11,"example":"13800138000"},"province":{"maxLength":10,"minLength":0,"type":"string","description":"Account OpeningBank belongs to Province (domestic Enterprise to corporate AccountRequired, See attachment)"},"city":{"maxLength":10,"minLength":0,"type":"string","description":"City to which Account OpeningBank belongs (domestic Enterprise to corporate AccountRequired, See attachment)"},"district":{"maxLength":10,"minLength":0,"type":"string","description":"Account OpeningBank belongs to the district (domestic Enterprise to corporate AccountRequired, See attachment)"}},"required":["country","currency","acc_name","acc_type","payment_type"]},"attachment":{"description":"OtherFileAttachment","type":"object","properties":{"other_file_ids":{"maxItems":7,"minItems":0,"type":"array","description":"AttachmentFileid up to 7","items":{"type":"integer","description":"AttachmentFileid up to 7","format":"int32"}},"contract_file_id":{"type":"integer","description":"ContractFile-UploadFileAPIReturn's id (when the destination is Collection, one of Contract/PI/LogisticsFile must be passed)","format":"int32"},"logistics_file_id":{"type":"integer","description":"LogisticsFile-UploadFileAPIReturn id (when the destination is Collection, one of Contract/PI/LogisticsFile must be passed)","format":"int32"},"pi_file_id":{"type":"integer","description":"PIFile-UploadFileAPIReturn id (when the destination is Collection, Contract/PI/LogisticsFile must pass one)","format":"int32"}}}},"required":["request_id","type","beneficiary","bank_acc"]},"id":"schema_157"},"schema_158":{"kind":"json-schema","data":{"type":"object","properties":{"request_id":{"maxLength":32,"minLength":1,"type":"string","description":"Request number, Unique within the requesting system"},"type":{"type":"string","description":"Purpose (Required): PAYMENT-Collection, WITHDRAWAL-Withdrawal"},"beneficiary":{"description":"CollectionPeopleInformation","type":"object","properties":{"purpose":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CollectionType PFG-payment LWF-Logistics warehousing fee ASF-advertising service fee TSF-technical service fee CSF-consulting service fee OTHER-Other Data dictionary:PAYEE_TYPE"},"children":[]}]}]}],"enum":["PFG","LWF","ASF","TSF","CSF","OTHER"]},"purpose_desc":{"maxLength":100,"minLength":0,"type":"string","description":"CollectionType description, Required when OtherCollectionType (Max 100 characters), Required when purpose is OTHER"},"country":{"type":"string","description":"Country code, Use ISO3166-2 standard 2-digit Country code, non-sanctioned Country (See appendix)"},"industry":{"type":"integer","description":"Mainly engaged in Industry (See attachment), Required when the company has a public account and is a member of the Collection","format":"int32"},"main_industry":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Main Industrycode (see new IndustryAttachment), Required when the company Account is a Collection member, and one of industry and main_industryRequired; subsequent versions of industry will be abandoned, please modify it as soon as possible"},"children":[]}]}]}]},"sub_industry":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sub-camp Industrycode (see new IndustryAttachment), can be passed when main_industryRequired"},"children":[]}]}]}]},"nick_name":{"maxLength":100,"minLength":0,"type":"string","description":"Account nickname(Max 100 characters)"},"first_name":{"maxLength":100,"minLength":1,"type":"string","description":"Beneficiary first name (Overseas Collection person-to-private Required) (Max 100 characters)"},"last_name":{"maxLength":100,"minLength":1,"type":"string","description":"Beneficiary last name (overseas Collection person-to-private Required) (Max 100 characters)"},"doc_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID DocumentType (domestic individual AccountRequired), domestic individual AccountRequired and is ID_CARD"},"children":[]}]}]}]},"id_number":{"maxLength":100,"minLength":0,"type":"string","description":"ID Document number (domestic personal AccountRequired) (Max 100 characters)"},"uni_social_credit":{"maxLength":18,"minLength":0,"type":"string","description":"Unified Social Credit Code (domestic corporate AccountRequired) (Max 18 characters)"},"address":{"type":"object","properties":{"province":{"type":"string","description":"State/Province (United States/Canada/Mexico and BankCurrencyAccount is not CNYRequired)"},"city":{"maxLength":50,"minLength":0,"type":"string","description":"City(overseas required)"},"zipcode":{"maxLength":20,"minLength":0,"type":"string","description":"Postal code (required overseas)"},"address1":{"maxLength":50,"minLength":0,"type":"string","description":"BankAccount holder Address (overseas Required)"},"address2":{"type":"string","description":"Address line 2"}},"required":["province","city","address1","zipcode"],"description":"BeneficiaryAddressInformation"}},"required":["purpose","country"]},"bank_acc":{"description":"BankAccountInformation","type":"object","properties":{"country":{"maxLength":2,"minLength":0,"type":"string","description":"Country code, Use ISO3166-2 standard 2-digit Country code, non-sanctioned Country (See appendix)"},"currency":{"type":"string","description":"Currency: EUR - Euro, USD - United States dollar, CNY - Chinese yuan, GBP - British pound, JPY - Japanese yen, AUD - Australian dollar, CAD - Canadian dollar, SGD - Singapore dollar, HKD - Hong Kong dollar, PHP - Philippine peso, CNH - offshore Chinese yuan","enum":["EUR","USD","CNY","GBP","JPY","AUD","CAD","SGD","HKD","PHP","CNH"]},"acc_name":{"maxLength":100,"minLength":1,"type":"string","description":"AccountName(Max 100 characters)"},"acc_type":{"type":"string","description":"AccountType: PRIVATE-Personal Account, COMPANY-Enterprise Corporate","enum":["PRIVATE","COMPANY"]},"acc_no":{"maxLength":100,"minLength":0,"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bank account number, choose one from acc_no or iban"},"children":[]}]}]}]},"payment_type":{"type":"string","description":"Payment clearing network: LOCAL - local payment, SWIFT - international payment","enum":["LOCAL","SWIFT"]},"routing_code_type1":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must when LOCAL clearing network (the enumeration value will be expanded as the business develops): ABA (local payment network code in the United States), FASTER_PAYMENT (local payment network code in the United Kingdom), CHAPS (local payment network code in the United Kingdom), SORT_CODE, BANK_CODE (see BankCodeAttachment for details within the country, and fill it out truthfully in Canada)"},"children":[]}]}]}]},"routing_code_value1":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must when routing_code_type1 is not empty"},"children":[]}]}]}]},"routing_code_type2":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LOCAL clearing network sub-Type (the enumeration value will be expanded as the business develops): BRANCH_BANK_CODE (see BankCodeAttachment for details within the country, and fill in the details truthfully for overseas countries such as Canada)"},"children":[]}]}]}]},"routing_code_value2":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must when routing_code_type2 is not empty"},"children":[]}]}]}]},"iban":{"maxLength":50,"minLength":0,"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IBAN, unique to Eurozone Accounts, choose one of acc_no and iban"},"children":[]}]}]}]},"bic_swift":{"type":"string","description":"swift code or bic, when SWIFT clears the network, other countries and regions require Upload this Field (only supports 8 or 11 bits)","maxLength":11,"minLength":8,"example":"ABCDEFGH"},"bank_acc_type":{"type":"string","description":"BankAccountType CHECKING-Cheque SAVINGS-Debit Card","enum":["CHECKING","SAVINGS"]},"bank_addr":{"maxLength":100,"minLength":0,"type":"string","description":"Account OpeningBankDetailedAddress(overseas AccountRequired)(Max 100 characters)"},"bank_name":{"maxLength":100,"minLength":0,"type":"string","description":"Account OpeningBankName(overseas AccountRequired; Max 100 characters)"},"branch_bank_name":{"maxLength":100,"minLength":0,"type":"string","description":"Account OpeningBank Branch Name(Max 100 characters)"},"phone":{"type":"string","description":"Bank reserved mobile phone number (Mainland RMB private cash withdrawal)","maxLength":11,"minLength":11,"example":"13800138000"},"province":{"maxLength":10,"minLength":0,"type":"string","description":"Account OpeningBank belongs to Province (domestic Enterprise to corporate AccountRequired, See attachment)"},"city":{"maxLength":10,"minLength":0,"type":"string","description":"City to which Account OpeningBank belongs (domestic Enterprise to corporate AccountRequired, See attachment)"},"district":{"maxLength":10,"minLength":0,"type":"string","description":"Account OpeningBank belongs to the district (domestic Enterprise to corporate AccountRequired, See attachment)"}},"required":["country","currency","acc_name","acc_type","payment_type"]},"attachment":{"description":"OtherFileAttachment","type":"object","properties":{"other_file_ids":{"maxItems":7,"minItems":0,"type":"array","description":"AttachmentFileid up to 7","items":{"type":"integer","description":"AttachmentFileid up to 7","format":"int32"}},"contract_file_id":{"type":"integer","description":"ContractFile-UploadFileAPIReturn's id (when the destination is Collection, one of Contract/PI/LogisticsFile must be passed)","format":"int32"},"logistics_file_id":{"type":"integer","description":"LogisticsFile-UploadFileAPIReturn id (when the destination is Collection, Contract/PI/LogisticsFile must pass one)","format":"int32"},"pi_file_id":{"type":"integer","description":"PIFileid-the id of UploadFileAPIReturn (when the purpose is Collection, Contract/PI/LogisticsFile must pass one)","format":"int32"}}}},"required":["request_id","type","beneficiary","bank_acc"]},"id":"schema_158"},"schema_159":{"kind":"json-schema","data":{"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BusinessType: MERCH-Merchant, VA-Virtual Account, INCOMING_REMITTANCE-Import Remittance, CONTRACT_ORDER-ContractOrder, TRADE_SETTLE-SettlementCrediting, PAYEE-Collection, WD_ACCOUNT-Withdraw Account, CUR_EXCHANGE-FX, PAYMENT-Payment"},"children":[]}]}]}],"enum":["MERCH","VA","INCOMING_REMITTANCE","CONTRACT_ORDER","TRADE_SETTLE","PAYEE","WD_ACCOUNT","FOREX","PAYMENT"]},"version":{"type":"string","description":"Version number (V1, V2,...)"},"data":{"type":"object","properties":{"request_id":{"maxLength":32,"minLength":1,"type":"string","description":"Request number, Unique within the requesting system"},"merch_id":{"type":"string","description":"Merchantid","minLength":1,"maxLength":20},"type":{"type":"string","description":"Purpose (Required): PAYMENT-Collection, WITHDRAWAL-Withdrawal"},"payee_id":{"type":"string","description":"Collection person id","minLength":1,"maxLength":20},"status":{"type":"string","description":"PayerReviewStatus PENDING-Pending Review NORMAL-Normal REJECTED-ReviewNot approved","enum":["PENDING","NORMAL","REJECTED"]},"msg":{"type":"string","description":"Result description, not empty when Failed"}},"description":"BusinessData","required":["request_id","merch_id","type","payee_id","status"]}},"required":["type","version","data"]},"id":"schema_159"},"schema_160":{"kind":"json-schema","data":{"type":"object","properties":{"sell_currency":{"type":"string","description":"Sell Currency: EUR - Euro, USD - United States dollar, CNY - Chinese yuan, GBP - British pound, JPY - Japanese yen, AUD - Australian dollar, CAD - Canadian dollar, SGD - Singapore dollar, HKD - Hong Kong dollar, PHP - Philippine peso, CNH - offshore Chinese yuan","enum":["EUR","USD","CNY","GBP","JPY","AUD","CAD","SGD","HKD","PHP","CNH"]},"buy_currency":{"type":"string","description":"Buy Currency: EUR - Euro, USD - United States dollar, CNY - Chinese yuan, GBP - British pound, JPY - Japanese yen, AUD - Australian dollar, CAD - Canadian dollar, SGD - Singapore dollar, HKD - Hong Kong dollar, PHP - Philippine peso, CNH - offshore Chinese yuan","enum":["EUR","USD","CNY","GBP","JPY","AUD","CAD","SGD","HKD","PHP","CNH"]},"sell_amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sell out Amount (CurrencyMinimum Unit), one of sell_amount and buy_amount must be passed"},"children":[]}]}]}]},"buy_amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Buy Amount (CurrencyMinimum Unit), one of sell_amount and buy_amount must be passed"},"children":[]}]}]}]}},"required":["sell_currency","buy_currency"]},"id":"schema_160"},"schema_161":{"kind":"json-schema","data":{"type":"object","properties":{"order_no":{"type":"string","description":"FXOrder number"},"sell_currency":{"type":"string","description":"Sell out Currency"},"buy_currency":{"type":"string","description":"Buy into Currency"},"sell_amount":{"type":"integer","description":"SellAmount(CurrencyMinimum Unit)"},"buy_amount":{"type":"integer","description":"BuyAmount(CurrencyMinimum Unit)"},"fx_rate":{"type":"number","description":"Exchange Rate (How many units of Buy currency are exchanged for 1 unit of Sell currency)"},"expire_at":{"type":"string","description":"Expired in (format: yyyy-MM-dd'T'HH:mm:ssXXX)","format":"date-time","example":"2024-12-03T23:33:33Z"}},"required":["order_no","expire_at","fx_rate","sell_currency","buy_currency","sell_amount","buy_amount"]},"id":"schema_161"},"schema_162":{"kind":"json-schema","data":{"type":"object","properties":{"order_no":{"type":"string","description":"Order number (Pre-orderReturn)"},"request_id":{"type":"string","description":"Request number, Unique within the requesting system","minLength":1,"maxLength":32}},"required":["order_no","request_id"]},"id":"schema_162"},"schema_163":{"kind":"json-schema","data":{"title":"","type":"object","properties":{"status":{"type":"string","enum":["PROCESSING","SUCCEEDED","FAILED"]}},"required":["status"]},"id":"schema_163"},"schema_164":{"kind":"json-schema","data":{"type":"object","properties":{"order_no":{"type":"string","description":"Order number"}},"required":["order_no"]},"id":"schema_164"},"schema_165":{"kind":"json-schema","data":{"type":"object","properties":{"status":{"type":"string","enum":["PROCESSING","SUCCEEDED","FAILED"]},"fail_reason":{"type":"string","description":"Reason (value when Failed)","maxLength":255}},"required":["status"]},"id":"schema_165"},"schema_166":{"kind":"json-schema","data":{"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BusinessType: MERCH-Merchant, VA-Virtual Account, INCOMING_REMITTANCE-Import Remittance, CONTRACT_ORDER-ContractOrder, TRADE_SETTLE-SettlementCrediting, PAYEE-Collection, WD_ACCOUNT-Withdraw Account, FOREX-FX, PAYMENT-Payment"},"children":[]}]}]}],"enum":["MERCH","VA","INCOMING_REMITTANCE","CONTRACT_ORDER","TRADE_SETTLE","PAYEE","WD_ACCOUNT","FOREX","PAYMENT"]},"version":{"type":"string","description":"Version number (V1, V2,...)"},"data":{"type":"object","properties":{"merch_id":{"type":"string"},"status":{"type":"string","enum":["SUCCEEDED","FAILED"]},"fail_reason":{"type":"string","maxLength":255},"order_no":{"type":"string"}},"required":["merch_id","status","fail_reason","order_no"]}},"required":["type","data","version"]},"id":"schema_166"},"schema_167":{"kind":"json-schema","data":{"type":"object","properties":{"request_id":{"type":"string","description":"Requestid"},"amount":{"minimum":1,"type":"integer","description":"PaymentAmount(CurrencyMinimum Unit)","format":"int64"},"currency":{"type":"string","description":"Currency: EUR - Euro, USD - United States dollar, CNY - Chinese yuan, GBP - British pound, JPY - Japanese yen, AUD - Australian dollar, CAD - Canadian dollar, SGD - Singapore dollar, HKD - Hong Kong dollar, PHP - Philippine peso, CNH - offshore Chinese yuan","enum":["EUR","USD","CNY","GBP","JPY","AUD","CAD","SGD","HKD","PHP","CNH"]},"beneficiary_id":{"maxLength":32,"minLength":0,"type":"string","description":"Collection person id"},"postscript":{"type":"string","description":"P.S.","maxLength":64,"nullable":true}},"required":["amount","currency","beneficiary_id","request_id"]},"id":"schema_167"},"schema_168":{"kind":"json-schema","data":{"type":"object","properties":{"status":{"type":"string","enum":["PROCESSING","SUCCEEDED","FAILED"],"description":"Status"},"fee_amount":{"type":"integer","description":"Fee (Currency is the Payment currency, the CurrencyMinimum Unit)","format":"int64"},"beneficiary_type":{"type":"string","description":"CollectionPeopleType","enum":["PAY","WITHDRAW"]}},"required":["fee_amount","beneficiary_type","status"]},"id":"schema_168"},"schema_169":{"kind":"json-schema","data":{"type":"object","properties":{"status":{"type":"string","description":"Status","enum":["PROCESSING","SUCCEEDED","FAILED","RETURNED"]},"fee_amount":{"type":"integer","description":"Fee (Currency is the Payment currency, the CurrencyMinimum Unit)","format":"int64"},"beneficiary_type":{"type":"string","description":"CollectionPeopleType","enum":["PAY","WITHDRAW"]},"order_no":{"type":"string","description":"PaymentOrder number"},"failed_reason":{"type":"string","description":"FailedReason"},"payment_currency":{"type":"string","description":"PaymentOriginalCurrency"},"received_currency":{"type":"string","description":"Payment targetCurrency"},"payment_amount":{"type":"string","description":"PaymentAmount"},"received_amount":{"type":"string","description":"Amount received"}},"required":["fee_amount","beneficiary_type","status","order_no","failed_reason","payment_currency","received_currency","payment_amount","received_amount"]},"id":"schema_169"},"schema_170":{"kind":"json-schema","data":{"type":"object","properties":{"type":{"type":"string"},"version":{"type":"string","description":"Version number (V1, V2,...)"},"data":{"type":"object","properties":{"request_id":{"type":"string"},"status":{"type":"string","enum":["PROCESSING","SUCCEEDED","FAILED","RETURNED"],"description":"Status"},"fee_amount":{"type":"integer","description":"Fee (Currency is the Payment currency, the CurrencyMinimum Unit)"},"beneficiary_type":{"type":"string","enum":["PAY","WITHDRAW"],"description":"CollectionPeopleType"},"merch_id":{"type":"string","description":"Merchantid","maxLength":20,"minLength":1},"order_no":{"type":"string","description":"PaymentOrder number"},"product_type":{"type":"string","description":"Product Type B2B-B2B foreign trade B2C-Cross-border e-commerce"},"failed_reason":{"type":"string","description":"FailedReason"},"payment_currency":{"type":"string","description":"PaymentOriginalCurrency"},"received_currency":{"type":"string","description":"Payment targetCurrency"},"payment_amount":{"type":"string","description":"PaymentAmount"},"received_amount":{"type":"string","description":"Amount received"}},"required":["request_id","status","fee_amount","beneficiary_type","merch_id","order_no","product_type","failed_reason","payment_currency","received_currency","payment_amount","received_amount"]}},"required":["type","data","version"]},"id":"schema_170"},"schema_171":{"kind":"json-schema","data":{"type":"object","properties":{"status":{"type":"string","enum":["PROCESSING","SUCCEEDED","FAILED"],"description":"Status"},"fee_amount":{"type":"integer","description":"Fee (Currency is the Payment currency)","format":"int64"},"beneficiary_type":{"type":"string","description":"CollectionPeopleType","enum":["PAY","WITHDRAW"]}},"required":["fee_amount","beneficiary_type","status"]},"id":"schema_171"},"schema_172":{"kind":"json-schema","data":{"type":"object","properties":{"file":{"format":"binary","type":"string","description":"File (maximum no more than 10MiB)","example":""},"meta":{"description":"File metaData(json)","example":"","type":"string"}},"required":["file","meta"]},"id":"schema_172"}},"exampleStore":{"paths/~1api~1v2~1merch~1onboard~1apply/post/requestBody/content/application~1json/example":{"value":"","id":"paths/~1api~1v2~1merch~1onboard~1apply/post/requestBody/content/application~1json/example"},"paths/~1api~1v2~1merch~1onboard~1update/post/requestBody/content/application~1json/example":{"value":"","id":"paths/~1api~1v2~1merch~1onboard~1update/post/requestBody/content/application~1json/example"},"paths/~1api~1v2~1merch~1onboard~1inquiry/post/requestBody/content/application~1json/example":{"value":"","id":"paths/~1api~1v2~1merch~1onboard~1inquiry/post/requestBody/content/application~1json/example"},"paths/~1api~1v2~1merch~1onboard~1notify/post/requestBody/content/application~1json/example":{"value":"","id":"paths/~1api~1v2~1merch~1onboard~1notify/post/requestBody/content/application~1json/example"},"paths/~1api~1v2~1merch~1va~1apply/post/requestBody/content/application~1json/example":{"value":"","id":"paths/~1api~1v2~1merch~1va~1apply/post/requestBody/content/application~1json/example"},"paths/~1api~1v2~1merch~1va~1inquiry/post/requestBody/content/application~1json/example":{"value":"","id":"paths/~1api~1v2~1merch~1va~1inquiry/post/requestBody/content/application~1json/example"},"paths/~1api~1v2~1merch~1va~1notify/post/requestBody/content/application~1json/example":{"value":{"type":"MERCH","data":{"merch_id":"example","status":"ENABLED","currency":["EUR"],"country_code":"example","account_type":"LOCAL","account_no":"example","bic":"example","bank":"example","bank_name":"example","bank_address":"example","c_rsc_id":"example"}},"id":"paths/~1api~1v2~1merch~1va~1notify/post/requestBody/content/application~1json/example"},"paths/~1api~1v2~1remittance~1notify/post/requestBody/content/application~1json/example":{"value":"","id":"paths/~1api~1v2~1remittance~1notify/post/requestBody/content/application~1json/example"},"paths/~1api~1v2~1merch~1contract~1create/post/requestBody/content/application~1json/example":{"value":"","id":"paths/~1api~1v2~1merch~1contract~1create/post/requestBody/content/application~1json/example"},"paths/~1api~1v2~1merch~1contract~1update/post/requestBody/content/application~1json/example":{"value":"","id":"paths/~1api~1v2~1merch~1contract~1update/post/requestBody/content/application~1json/example"},"paths/~1api~1v2~1merch~1contract~1inquiry/post/requestBody/content/application~1json/example":{"value":"","id":"paths/~1api~1v2~1merch~1contract~1inquiry/post/requestBody/content/application~1json/example"},"paths/~1api~1v2~1merch~1contract~1logistics~1supplement/post/requestBody/content/application~1json/example":{"value":"","id":"paths/~1api~1v2~1merch~1contract~1logistics~1supplement/post/requestBody/content/application~1json/example"},"paths/~1api~1v2~1trade-settle~1apply/post/requestBody/content/application~1json/example":{"value":"","id":"paths/~1api~1v2~1trade-settle~1apply/post/requestBody/content/application~1json/example"},"paths/~1api~1v2~1trade-settle~1inquiry/post/requestBody/content/application~1json/example":{"value":"","id":"paths/~1api~1v2~1trade-settle~1inquiry/post/requestBody/content/application~1json/example"},"paths/~1api~1v2~1trade-settle~1notify/post/requestBody/content/application~1json/example":{"value":"","id":"paths/~1api~1v2~1trade-settle~1notify/post/requestBody/content/application~1json/example"},"paths/~1api~1v2~1merch~1balance/post/requestBody/content/application~1json/example":{"value":"","id":"paths/~1api~1v2~1merch~1balance/post/requestBody/content/application~1json/example"},"paths/~1api~1v2~1merch~1beneficiary~1create/post/requestBody/content/application~1json/example":{"value":"","id":"paths/~1api~1v2~1merch~1beneficiary~1create/post/requestBody/content/application~1json/example"},"paths/~1api~1v2~1merch~1beneficiary~1update/post/requestBody/content/application~1json/example":{"value":"","id":"paths/~1api~1v2~1merch~1beneficiary~1update/post/requestBody/content/application~1json/example"},"paths/~1api~1v2~1merch~1beneficiary~1inquiry/post/requestBody/content/application~1json/example":{"value":"","id":"paths/~1api~1v2~1merch~1beneficiary~1inquiry/post/requestBody/content/application~1json/example"},"paths/~1api~1v2~1merch~1beneficiary~1notify/post/requestBody/content/application~1json/example":{"value":"","id":"paths/~1api~1v2~1merch~1beneficiary~1notify/post/requestBody/content/application~1json/example"},"paths/~1api~1v2~1fx~1conversion~1notify/post/requestBody/content/application~1json/example":{"value":{"type":"MERCH","data":{"request_id":"123","merch_id":"example","status":"ENABLED","fail_reason":"example","order_no":"LOCAL"}},"id":"paths/~1api~1v2~1fx~1conversion~1notify/post/requestBody/content/application~1json/example"},"paths/~1api~1v2~1merch~1pay~1apply/post/requestBody/content/application~1json/example":{"value":"","id":"paths/~1api~1v2~1merch~1pay~1apply/post/requestBody/content/application~1json/example"},"paths/~1api~1v2~1merch~1pay~1inquiry/post/requestBody/content/application~1json/example":{"value":"","id":"paths/~1api~1v2~1merch~1pay~1inquiry/post/requestBody/content/application~1json/example"},"paths/~1api~1v2~1merch~1pay~1notify/post/requestBody/content/application~1json/example":{"value":{"type":"MERCH","data":{"request_id":"123","status":"ENABLED","fee_amount":123,"beneficiary_type":"sss"}},"id":"paths/~1api~1v2~1merch~1pay~1notify/post/requestBody/content/application~1json/example"},"paths/~1api~1file~1upload/post/requestBody/content/multipart~1form-data/example":{"value":"","id":"paths/~1api~1file~1upload/post/requestBody/content/multipart~1form-data/example"}},"securitySchemeStore":{},"servers":[{"url":"https://api.paykka.com"}]},"options":{"showExtensions":true,"jsonSamplesExpandLevel":5,"sortRequiredPropsFirst":false,"hideDownloadButtons":false,"codeSamples":{"skipOptionalParameters":false,"languages":[{"lang":"curl","label":"cURL"},{"lang":"Python"},{"lang":"PHP"},{"lang":"Node.js"},{"lang":"Ruby"},{"lang":"Java"},{"lang":"Java8+Apache","label":"ApacheHttpClint"},{"lang":"Go"},{"lang":"JavaScript","label":"JS"},{"lang":"C#"}]},"events":{"codeSamplesLanguageSwitch":"({ lang, label, exampleId}) => {\n  console.log(`Switched to language: ${lang}`);\n}\n","tryItOpen":"() => {\n  console.log(`Try it panel opened`);\n}\n","tryItSent":"({Sent, ValidationFailed}) => {\n  console.log(`Try it panel send : ${Sent}`, then : ${ValidationFailed}`);\n}\n","targetServerSwitch":"({ serverUrl }) => {\n  console.log(`Switched to server: ${serverUrl}`);\n}\n","codeSamplesCopy":"({lang, label}) => {\n  console.log(`Code samples copied: ${lang}`);\n}\n"},"hideSidebar":true,"mockServer":{"off":true,"strictExamples":true,"position":"last","errorIfForcedExampleNotFound":true},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/collection/apis/@v2/openapi.json?download"},{"url":"/_bundle/collection/apis/@v2/openapi.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"PayKKa-collection-openplatform","description":"Open platform APIs for merchant onboarding (v2). See appendices for country codes, industries, and file upload flows."}},"baseSlug":"/collection/apis/openapi","routesMapping":{}}