# Models ## The CustomerInfo object ```json {"openapi":"3.0.3","info":{"title":"Finpay Payment Gateway API","version":"1.0.0"},"components":{"schemas":{"CustomerInfo":{"type":"object","properties":{"id":{"type":"string","description":"Customer ID"},"email":{"type":"string","format":"email","description":"Customer email"},"firstName":{"type":"string","description":"Customer first name"},"lastName":{"type":"string","description":"Customer last name"},"mobilePhone":{"type":"string","description":"Customer mobile phone"}}}}}} ``` ## The OrderInfo object ```json {"openapi":"3.0.3","info":{"title":"Finpay Payment Gateway API","version":"1.0.0"},"components":{"schemas":{"OrderInfo":{"type":"object","properties":{"id":{"type":"string","description":"Order ID"},"amount":{"type":"string","description":"Transaction amount"},"currency":{"type":"string","description":"Currency code"},"description":{"type":"string","description":"Order description"},"item":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"quantity":{"type":"string"},"category":{"type":"string"},"description":{"type":"string"},"unitPrice":{"type":"string"}}}}}}}}} ``` ## The UrlInfo object ```json {"openapi":"3.0.3","info":{"title":"Finpay Payment Gateway API","version":"1.0.0"},"components":{"schemas":{"UrlInfo":{"type":"object","properties":{"callbackUrl":{"type":"string","format":"uri","description":"Callback URL"},"successUrl":{"type":"string","format":"uri","description":"Success URL"},"failUrl":{"type":"string","format":"uri","description":"Failure URL"}}}}}} ``` ## The SourceOfFunds object ```json {"openapi":"3.0.3","info":{"title":"Finpay Payment Gateway API","version":"1.0.0"},"components":{"schemas":{"SourceOfFunds":{"type":"object","properties":{"type":{"type":"string","description":"Payment method type"},"paymentCode":{"type":"string","description":"Payment code for VA operations"}}}}}} ``` ## The FinpayPaycodeRequest object ```json {"openapi":"3.0.3","info":{"title":"Finpay Payment Gateway API","version":"1.0.0"},"components":{"schemas":{"FinpayPaycodeRequest":{"type":"object","properties":{"customer":{"$ref":"#/components/schemas/CustomerInfo"},"order":{"$ref":"#/components/schemas/OrderInfo"},"url":{"$ref":"#/components/schemas/UrlInfo"},"sourceOfFunds":{"$ref":"#/components/schemas/SourceOfFunds"}}},"CustomerInfo":{"type":"object","properties":{"id":{"type":"string","description":"Customer ID"},"email":{"type":"string","format":"email","description":"Customer email"},"firstName":{"type":"string","description":"Customer first name"},"lastName":{"type":"string","description":"Customer last name"},"mobilePhone":{"type":"string","description":"Customer mobile phone"}}},"OrderInfo":{"type":"object","properties":{"id":{"type":"string","description":"Order ID"},"amount":{"type":"string","description":"Transaction amount"},"currency":{"type":"string","description":"Currency code"},"description":{"type":"string","description":"Order description"},"item":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"quantity":{"type":"string"},"category":{"type":"string"},"description":{"type":"string"},"unitPrice":{"type":"string"}}}}}},"UrlInfo":{"type":"object","properties":{"callbackUrl":{"type":"string","format":"uri","description":"Callback URL"},"successUrl":{"type":"string","format":"uri","description":"Success URL"},"failUrl":{"type":"string","format":"uri","description":"Failure URL"}}},"SourceOfFunds":{"type":"object","properties":{"type":{"type":"string","description":"Payment method type"},"paymentCode":{"type":"string","description":"Payment code for VA operations"}}}}}} ``` ## The VARegisterRequest object ```json {"openapi":"3.0.3","info":{"title":"Finpay Payment Gateway API","version":"1.0.0"},"components":{"schemas":{"VARegisterRequest":{"type":"object","properties":{"customer":{"$ref":"#/components/schemas/CustomerInfo"},"sourceOfFunds":{"$ref":"#/components/schemas/SourceOfFunds"}}},"CustomerInfo":{"type":"object","properties":{"id":{"type":"string","description":"Customer ID"},"email":{"type":"string","format":"email","description":"Customer email"},"firstName":{"type":"string","description":"Customer first name"},"lastName":{"type":"string","description":"Customer last name"},"mobilePhone":{"type":"string","description":"Customer mobile phone"}}},"SourceOfFunds":{"type":"object","properties":{"type":{"type":"string","description":"Payment method type"},"paymentCode":{"type":"string","description":"Payment code for VA operations"}}}}}} ``` ## The VAUpdateRequest object ```json {"openapi":"3.0.3","info":{"title":"Finpay Payment Gateway API","version":"1.0.0"},"components":{"schemas":{"VAUpdateRequest":{"type":"object","properties":{"customer":{"$ref":"#/components/schemas/CustomerInfo"},"sourceOfFunds":{"$ref":"#/components/schemas/SourceOfFunds"}}},"CustomerInfo":{"type":"object","properties":{"id":{"type":"string","description":"Customer ID"},"email":{"type":"string","format":"email","description":"Customer email"},"firstName":{"type":"string","description":"Customer first name"},"lastName":{"type":"string","description":"Customer last name"},"mobilePhone":{"type":"string","description":"Customer mobile phone"}}},"SourceOfFunds":{"type":"object","properties":{"type":{"type":"string","description":"Payment method type"},"paymentCode":{"type":"string","description":"Payment code for VA operations"}}}}}} ``` ## The DANAPaymentRequest object ```json {"openapi":"3.0.3","info":{"title":"Finpay Payment Gateway API","version":"1.0.0"},"components":{"schemas":{"DANAPaymentRequest":{"type":"object","properties":{"customer":{"$ref":"#/components/schemas/CustomerInfo"},"order":{"$ref":"#/components/schemas/OrderInfo"},"url":{"$ref":"#/components/schemas/UrlInfo"},"sourceOfFunds":{"type":"object","properties":{"type":{"type":"string"}}}}},"CustomerInfo":{"type":"object","properties":{"id":{"type":"string","description":"Customer ID"},"email":{"type":"string","format":"email","description":"Customer email"},"firstName":{"type":"string","description":"Customer first name"},"lastName":{"type":"string","description":"Customer last name"},"mobilePhone":{"type":"string","description":"Customer mobile phone"}}},"OrderInfo":{"type":"object","properties":{"id":{"type":"string","description":"Order ID"},"amount":{"type":"string","description":"Transaction amount"},"currency":{"type":"string","description":"Currency code"},"description":{"type":"string","description":"Order description"},"item":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"quantity":{"type":"string"},"category":{"type":"string"},"description":{"type":"string"},"unitPrice":{"type":"string"}}}}}},"UrlInfo":{"type":"object","properties":{"callbackUrl":{"type":"string","format":"uri","description":"Callback URL"},"successUrl":{"type":"string","format":"uri","description":"Success URL"},"failUrl":{"type":"string","format":"uri","description":"Failure URL"}}}}}} ``` ## The QRISPaymentRequest object ```json {"openapi":"3.0.3","info":{"title":"Finpay Payment Gateway API","version":"1.0.0"},"components":{"schemas":{"QRISPaymentRequest":{"type":"object","properties":{"customer":{"$ref":"#/components/schemas/CustomerInfo"},"order":{"$ref":"#/components/schemas/OrderInfo"},"url":{"$ref":"#/components/schemas/UrlInfo"},"sourceOfFunds":{"type":"object","properties":{"type":{"type":"string"}}}}},"CustomerInfo":{"type":"object","properties":{"id":{"type":"string","description":"Customer ID"},"email":{"type":"string","format":"email","description":"Customer email"},"firstName":{"type":"string","description":"Customer first name"},"lastName":{"type":"string","description":"Customer last name"},"mobilePhone":{"type":"string","description":"Customer mobile phone"}}},"OrderInfo":{"type":"object","properties":{"id":{"type":"string","description":"Order ID"},"amount":{"type":"string","description":"Transaction amount"},"currency":{"type":"string","description":"Currency code"},"description":{"type":"string","description":"Order description"},"item":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"quantity":{"type":"string"},"category":{"type":"string"},"description":{"type":"string"},"unitPrice":{"type":"string"}}}}}},"UrlInfo":{"type":"object","properties":{"callbackUrl":{"type":"string","format":"uri","description":"Callback URL"},"successUrl":{"type":"string","format":"uri","description":"Success URL"},"failUrl":{"type":"string","format":"uri","description":"Failure URL"}}}}}} ``` ## The CardPaymentRequest object ```json {"openapi":"3.0.3","info":{"title":"Finpay Payment Gateway API","version":"1.0.0"},"components":{"schemas":{"CardPaymentRequest":{"type":"object","properties":{"customer":{"$ref":"#/components/schemas/CustomerInfo"},"order":{"$ref":"#/components/schemas/OrderInfo"},"url":{"$ref":"#/components/schemas/UrlInfo"},"sourceOfFunds":{"type":"object","properties":{"type":{"type":"string"}}}}},"CustomerInfo":{"type":"object","properties":{"id":{"type":"string","description":"Customer ID"},"email":{"type":"string","format":"email","description":"Customer email"},"firstName":{"type":"string","description":"Customer first name"},"lastName":{"type":"string","description":"Customer last name"},"mobilePhone":{"type":"string","description":"Customer mobile phone"}}},"OrderInfo":{"type":"object","properties":{"id":{"type":"string","description":"Order ID"},"amount":{"type":"string","description":"Transaction amount"},"currency":{"type":"string","description":"Currency code"},"description":{"type":"string","description":"Order description"},"item":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"quantity":{"type":"string"},"category":{"type":"string"},"description":{"type":"string"},"unitPrice":{"type":"string"}}}}}},"UrlInfo":{"type":"object","properties":{"callbackUrl":{"type":"string","format":"uri","description":"Callback URL"},"successUrl":{"type":"string","format":"uri","description":"Success URL"},"failUrl":{"type":"string","format":"uri","description":"Failure URL"}}}}}} ``` ## The BCAKlikPayPaymentRequest object ```json {"openapi":"3.0.3","info":{"title":"Finpay Payment Gateway API","version":"1.0.0"},"components":{"schemas":{"BCAKlikPayPaymentRequest":{"type":"object","properties":{"customer":{"$ref":"#/components/schemas/CustomerInfo"},"order":{"$ref":"#/components/schemas/OrderInfo"},"url":{"$ref":"#/components/schemas/UrlInfo"},"sourceOfFunds":{"type":"object","properties":{"type":{"type":"string"}}}}},"CustomerInfo":{"type":"object","properties":{"id":{"type":"string","description":"Customer ID"},"email":{"type":"string","format":"email","description":"Customer email"},"firstName":{"type":"string","description":"Customer first name"},"lastName":{"type":"string","description":"Customer last name"},"mobilePhone":{"type":"string","description":"Customer mobile phone"}}},"OrderInfo":{"type":"object","properties":{"id":{"type":"string","description":"Order ID"},"amount":{"type":"string","description":"Transaction amount"},"currency":{"type":"string","description":"Currency code"},"description":{"type":"string","description":"Order description"},"item":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"quantity":{"type":"string"},"category":{"type":"string"},"description":{"type":"string"},"unitPrice":{"type":"string"}}}}}},"UrlInfo":{"type":"object","properties":{"callbackUrl":{"type":"string","format":"uri","description":"Callback URL"},"successUrl":{"type":"string","format":"uri","description":"Success URL"},"failUrl":{"type":"string","format":"uri","description":"Failure URL"}}}}}} ``` ## The IndodanaPaymentRequest object ```json {"openapi":"3.0.3","info":{"title":"Finpay Payment Gateway API","version":"1.0.0"},"components":{"schemas":{"IndodanaPaymentRequest":{"type":"object","properties":{"customer":{"$ref":"#/components/schemas/CustomerInfo"},"order":{"$ref":"#/components/schemas/OrderInfo"},"url":{"$ref":"#/components/schemas/UrlInfo"},"sourceOfFunds":{"type":"object","properties":{"type":{"type":"string"}}}}},"CustomerInfo":{"type":"object","properties":{"id":{"type":"string","description":"Customer ID"},"email":{"type":"string","format":"email","description":"Customer email"},"firstName":{"type":"string","description":"Customer first name"},"lastName":{"type":"string","description":"Customer last name"},"mobilePhone":{"type":"string","description":"Customer mobile phone"}}},"OrderInfo":{"type":"object","properties":{"id":{"type":"string","description":"Order ID"},"amount":{"type":"string","description":"Transaction amount"},"currency":{"type":"string","description":"Currency code"},"description":{"type":"string","description":"Order description"},"item":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"quantity":{"type":"string"},"category":{"type":"string"},"description":{"type":"string"},"unitPrice":{"type":"string"}}}}}},"UrlInfo":{"type":"object","properties":{"callbackUrl":{"type":"string","format":"uri","description":"Callback URL"},"successUrl":{"type":"string","format":"uri","description":"Success URL"},"failUrl":{"type":"string","format":"uri","description":"Failure URL"}}}}}} ``` ## The FinpayMoneyPaymentRequest object ```json {"openapi":"3.0.3","info":{"title":"Finpay Payment Gateway API","version":"1.0.0"},"components":{"schemas":{"FinpayMoneyPaymentRequest":{"type":"object","properties":{"customer":{"$ref":"#/components/schemas/CustomerInfo"},"order":{"$ref":"#/components/schemas/OrderInfo"},"url":{"$ref":"#/components/schemas/UrlInfo"},"sourceOfFunds":{"type":"object","properties":{"type":{"type":"string"}}}}},"CustomerInfo":{"type":"object","properties":{"id":{"type":"string","description":"Customer ID"},"email":{"type":"string","format":"email","description":"Customer email"},"firstName":{"type":"string","description":"Customer first name"},"lastName":{"type":"string","description":"Customer last name"},"mobilePhone":{"type":"string","description":"Customer mobile phone"}}},"OrderInfo":{"type":"object","properties":{"id":{"type":"string","description":"Order ID"},"amount":{"type":"string","description":"Transaction amount"},"currency":{"type":"string","description":"Currency code"},"description":{"type":"string","description":"Order description"},"item":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"quantity":{"type":"string"},"category":{"type":"string"},"description":{"type":"string"},"unitPrice":{"type":"string"}}}}}},"UrlInfo":{"type":"object","properties":{"callbackUrl":{"type":"string","format":"uri","description":"Callback URL"},"successUrl":{"type":"string","format":"uri","description":"Success URL"},"failUrl":{"type":"string","format":"uri","description":"Failure URL"}}}}}} ``` ## The JeniusPayPaymentRequest object ```json {"openapi":"3.0.3","info":{"title":"Finpay Payment Gateway API","version":"1.0.0"},"components":{"schemas":{"JeniusPayPaymentRequest":{"type":"object","properties":{"customer":{"$ref":"#/components/schemas/CustomerInfo"},"order":{"$ref":"#/components/schemas/OrderInfo"},"url":{"$ref":"#/components/schemas/UrlInfo"},"sourceOfFunds":{"type":"object","properties":{"type":{"type":"string"}}}}},"CustomerInfo":{"type":"object","properties":{"id":{"type":"string","description":"Customer ID"},"email":{"type":"string","format":"email","description":"Customer email"},"firstName":{"type":"string","description":"Customer first name"},"lastName":{"type":"string","description":"Customer last name"},"mobilePhone":{"type":"string","description":"Customer mobile phone"}}},"OrderInfo":{"type":"object","properties":{"id":{"type":"string","description":"Order ID"},"amount":{"type":"string","description":"Transaction amount"},"currency":{"type":"string","description":"Currency code"},"description":{"type":"string","description":"Order description"},"item":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"quantity":{"type":"string"},"category":{"type":"string"},"description":{"type":"string"},"unitPrice":{"type":"string"}}}}}},"UrlInfo":{"type":"object","properties":{"callbackUrl":{"type":"string","format":"uri","description":"Callback URL"},"successUrl":{"type":"string","format":"uri","description":"Success URL"},"failUrl":{"type":"string","format":"uri","description":"Failure URL"}}}}}} ``` ## The LinkAjaAppLinkPaymentRequest object ```json {"openapi":"3.0.3","info":{"title":"Finpay Payment Gateway API","version":"1.0.0"},"components":{"schemas":{"LinkAjaAppLinkPaymentRequest":{"type":"object","properties":{"customer":{"$ref":"#/components/schemas/CustomerInfo"},"order":{"$ref":"#/components/schemas/OrderInfo"},"url":{"$ref":"#/components/schemas/UrlInfo"},"sourceOfFunds":{"type":"object","properties":{"type":{"type":"string"}}}}},"CustomerInfo":{"type":"object","properties":{"id":{"type":"string","description":"Customer ID"},"email":{"type":"string","format":"email","description":"Customer email"},"firstName":{"type":"string","description":"Customer first name"},"lastName":{"type":"string","description":"Customer last name"},"mobilePhone":{"type":"string","description":"Customer mobile phone"}}},"OrderInfo":{"type":"object","properties":{"id":{"type":"string","description":"Order ID"},"amount":{"type":"string","description":"Transaction amount"},"currency":{"type":"string","description":"Currency code"},"description":{"type":"string","description":"Order description"},"item":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"quantity":{"type":"string"},"category":{"type":"string"},"description":{"type":"string"},"unitPrice":{"type":"string"}}}}}},"UrlInfo":{"type":"object","properties":{"callbackUrl":{"type":"string","format":"uri","description":"Callback URL"},"successUrl":{"type":"string","format":"uri","description":"Success URL"},"failUrl":{"type":"string","format":"uri","description":"Failure URL"}}}}}} ``` ## The LinkAjaWebPaymentRequest object ```json {"openapi":"3.0.3","info":{"title":"Finpay Payment Gateway API","version":"1.0.0"},"components":{"schemas":{"LinkAjaWebPaymentRequest":{"type":"object","properties":{"customer":{"$ref":"#/components/schemas/CustomerInfo"},"order":{"$ref":"#/components/schemas/OrderInfo"},"url":{"$ref":"#/components/schemas/UrlInfo"},"sourceOfFunds":{"type":"object","properties":{"type":{"type":"string"}}}}},"CustomerInfo":{"type":"object","properties":{"id":{"type":"string","description":"Customer ID"},"email":{"type":"string","format":"email","description":"Customer email"},"firstName":{"type":"string","description":"Customer first name"},"lastName":{"type":"string","description":"Customer last name"},"mobilePhone":{"type":"string","description":"Customer mobile phone"}}},"OrderInfo":{"type":"object","properties":{"id":{"type":"string","description":"Order ID"},"amount":{"type":"string","description":"Transaction amount"},"currency":{"type":"string","description":"Currency code"},"description":{"type":"string","description":"Order description"},"item":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"quantity":{"type":"string"},"category":{"type":"string"},"description":{"type":"string"},"unitPrice":{"type":"string"}}}}}},"UrlInfo":{"type":"object","properties":{"callbackUrl":{"type":"string","format":"uri","description":"Callback URL"},"successUrl":{"type":"string","format":"uri","description":"Success URL"},"failUrl":{"type":"string","format":"uri","description":"Failure URL"}}}}}} ``` ## The OVOPaymentRequest object ```json {"openapi":"3.0.3","info":{"title":"Finpay Payment Gateway API","version":"1.0.0"},"components":{"schemas":{"OVOPaymentRequest":{"type":"object","properties":{"customer":{"$ref":"#/components/schemas/CustomerInfo"},"order":{"$ref":"#/components/schemas/OrderInfo"},"url":{"$ref":"#/components/schemas/UrlInfo"},"sourceOfFunds":{"type":"object","properties":{"type":{"type":"string"}}}}},"CustomerInfo":{"type":"object","properties":{"id":{"type":"string","description":"Customer ID"},"email":{"type":"string","format":"email","description":"Customer email"},"firstName":{"type":"string","description":"Customer first name"},"lastName":{"type":"string","description":"Customer last name"},"mobilePhone":{"type":"string","description":"Customer mobile phone"}}},"OrderInfo":{"type":"object","properties":{"id":{"type":"string","description":"Order ID"},"amount":{"type":"string","description":"Transaction amount"},"currency":{"type":"string","description":"Currency code"},"description":{"type":"string","description":"Order description"},"item":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"quantity":{"type":"string"},"category":{"type":"string"},"description":{"type":"string"},"unitPrice":{"type":"string"}}}}}},"UrlInfo":{"type":"object","properties":{"callbackUrl":{"type":"string","format":"uri","description":"Callback URL"},"successUrl":{"type":"string","format":"uri","description":"Success URL"},"failUrl":{"type":"string","format":"uri","description":"Failure URL"}}}}}} ``` ## The ShopeePayPaymentRequest object ```json {"openapi":"3.0.3","info":{"title":"Finpay Payment Gateway API","version":"1.0.0"},"components":{"schemas":{"ShopeePayPaymentRequest":{"type":"object","properties":{"customer":{"$ref":"#/components/schemas/CustomerInfo"},"order":{"$ref":"#/components/schemas/OrderInfo"},"url":{"$ref":"#/components/schemas/UrlInfo"},"sourceOfFunds":{"type":"object","properties":{"type":{"type":"string"}}}}},"CustomerInfo":{"type":"object","properties":{"id":{"type":"string","description":"Customer ID"},"email":{"type":"string","format":"email","description":"Customer email"},"firstName":{"type":"string","description":"Customer first name"},"lastName":{"type":"string","description":"Customer last name"},"mobilePhone":{"type":"string","description":"Customer mobile phone"}}},"OrderInfo":{"type":"object","properties":{"id":{"type":"string","description":"Order ID"},"amount":{"type":"string","description":"Transaction amount"},"currency":{"type":"string","description":"Currency code"},"description":{"type":"string","description":"Order description"},"item":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"quantity":{"type":"string"},"category":{"type":"string"},"description":{"type":"string"},"unitPrice":{"type":"string"}}}}}},"UrlInfo":{"type":"object","properties":{"callbackUrl":{"type":"string","format":"uri","description":"Callback URL"},"successUrl":{"type":"string","format":"uri","description":"Success URL"},"failUrl":{"type":"string","format":"uri","description":"Failure URL"}}}}}} ``` ## The VirgoPaymentRequest object ```json {"openapi":"3.0.3","info":{"title":"Finpay Payment Gateway API","version":"1.0.0"},"components":{"schemas":{"VirgoPaymentRequest":{"type":"object","properties":{"customer":{"$ref":"#/components/schemas/CustomerInfo"},"order":{"$ref":"#/components/schemas/OrderInfo"},"url":{"$ref":"#/components/schemas/UrlInfo"},"sourceOfFunds":{"type":"object","properties":{"type":{"type":"string"}}}}},"CustomerInfo":{"type":"object","properties":{"id":{"type":"string","description":"Customer ID"},"email":{"type":"string","format":"email","description":"Customer email"},"firstName":{"type":"string","description":"Customer first name"},"lastName":{"type":"string","description":"Customer last name"},"mobilePhone":{"type":"string","description":"Customer mobile phone"}}},"OrderInfo":{"type":"object","properties":{"id":{"type":"string","description":"Order ID"},"amount":{"type":"string","description":"Transaction amount"},"currency":{"type":"string","description":"Currency code"},"description":{"type":"string","description":"Order description"},"item":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"quantity":{"type":"string"},"category":{"type":"string"},"description":{"type":"string"},"unitPrice":{"type":"string"}}}}}},"UrlInfo":{"type":"object","properties":{"callbackUrl":{"type":"string","format":"uri","description":"Callback URL"},"successUrl":{"type":"string","format":"uri","description":"Success URL"},"failUrl":{"type":"string","format":"uri","description":"Failure URL"}}}}}} ``` ## The BSecurePaymentRequest object ```json {"openapi":"3.0.3","info":{"title":"Finpay Payment Gateway API","version":"1.0.0"},"components":{"schemas":{"BSecurePaymentRequest":{"type":"object","properties":{"customer":{"$ref":"#/components/schemas/CustomerInfo"},"order":{"$ref":"#/components/schemas/OrderInfo"},"url":{"$ref":"#/components/schemas/UrlInfo"},"sourceOfFunds":{"type":"object","properties":{"type":{"type":"string"}}}}},"CustomerInfo":{"type":"object","properties":{"id":{"type":"string","description":"Customer ID"},"email":{"type":"string","format":"email","description":"Customer email"},"firstName":{"type":"string","description":"Customer first name"},"lastName":{"type":"string","description":"Customer last name"},"mobilePhone":{"type":"string","description":"Customer mobile phone"}}},"OrderInfo":{"type":"object","properties":{"id":{"type":"string","description":"Order ID"},"amount":{"type":"string","description":"Transaction amount"},"currency":{"type":"string","description":"Currency code"},"description":{"type":"string","description":"Order description"},"item":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"quantity":{"type":"string"},"category":{"type":"string"},"description":{"type":"string"},"unitPrice":{"type":"string"}}}}}},"UrlInfo":{"type":"object","properties":{"callbackUrl":{"type":"string","format":"uri","description":"Callback URL"},"successUrl":{"type":"string","format":"uri","description":"Success URL"},"failUrl":{"type":"string","format":"uri","description":"Failure URL"}}}}}} ``` ## The OctoClicksPaymentRequest object ```json {"openapi":"3.0.3","info":{"title":"Finpay Payment Gateway API","version":"1.0.0"},"components":{"schemas":{"OctoClicksPaymentRequest":{"type":"object","properties":{"customer":{"$ref":"#/components/schemas/CustomerInfo"},"order":{"$ref":"#/components/schemas/OrderInfo"},"url":{"$ref":"#/components/schemas/UrlInfo"},"sourceOfFunds":{"type":"object","properties":{"type":{"type":"string"}}}}},"CustomerInfo":{"type":"object","properties":{"id":{"type":"string","description":"Customer ID"},"email":{"type":"string","format":"email","description":"Customer email"},"firstName":{"type":"string","description":"Customer first name"},"lastName":{"type":"string","description":"Customer last name"},"mobilePhone":{"type":"string","description":"Customer mobile phone"}}},"OrderInfo":{"type":"object","properties":{"id":{"type":"string","description":"Order ID"},"amount":{"type":"string","description":"Transaction amount"},"currency":{"type":"string","description":"Currency code"},"description":{"type":"string","description":"Order description"},"item":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"quantity":{"type":"string"},"category":{"type":"string"},"description":{"type":"string"},"unitPrice":{"type":"string"}}}}}},"UrlInfo":{"type":"object","properties":{"callbackUrl":{"type":"string","format":"uri","description":"Callback URL"},"successUrl":{"type":"string","format":"uri","description":"Success URL"},"failUrl":{"type":"string","format":"uri","description":"Failure URL"}}}}}} ``` ## The PermataNetPaymentRequest object ```json {"openapi":"3.0.3","info":{"title":"Finpay Payment Gateway API","version":"1.0.0"},"components":{"schemas":{"PermataNetPaymentRequest":{"type":"object","properties":{"customer":{"$ref":"#/components/schemas/CustomerInfo"},"order":{"$ref":"#/components/schemas/OrderInfo"},"url":{"$ref":"#/components/schemas/UrlInfo"},"sourceOfFunds":{"type":"object","properties":{"type":{"type":"string"}}}}},"CustomerInfo":{"type":"object","properties":{"id":{"type":"string","description":"Customer ID"},"email":{"type":"string","format":"email","description":"Customer email"},"firstName":{"type":"string","description":"Customer first name"},"lastName":{"type":"string","description":"Customer last name"},"mobilePhone":{"type":"string","description":"Customer mobile phone"}}},"OrderInfo":{"type":"object","properties":{"id":{"type":"string","description":"Order ID"},"amount":{"type":"string","description":"Transaction amount"},"currency":{"type":"string","description":"Currency code"},"description":{"type":"string","description":"Order description"},"item":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"quantity":{"type":"string"},"category":{"type":"string"},"description":{"type":"string"},"unitPrice":{"type":"string"}}}}}},"UrlInfo":{"type":"object","properties":{"callbackUrl":{"type":"string","format":"uri","description":"Callback URL"},"successUrl":{"type":"string","format":"uri","description":"Success URL"},"failUrl":{"type":"string","format":"uri","description":"Failure URL"}}}}}} ``` ## The KredivoPaymentRequest object ```json {"openapi":"3.0.3","info":{"title":"Finpay Payment Gateway API","version":"1.0.0"},"components":{"schemas":{"KredivoPaymentRequest":{"type":"object","properties":{"customer":{"$ref":"#/components/schemas/CustomerInfo"},"order":{"$ref":"#/components/schemas/OrderInfo"},"url":{"$ref":"#/components/schemas/UrlInfo"},"sourceOfFunds":{"type":"object","properties":{"type":{"type":"string"}}}}},"CustomerInfo":{"type":"object","properties":{"id":{"type":"string","description":"Customer ID"},"email":{"type":"string","format":"email","description":"Customer email"},"firstName":{"type":"string","description":"Customer first name"},"lastName":{"type":"string","description":"Customer last name"},"mobilePhone":{"type":"string","description":"Customer mobile phone"}}},"OrderInfo":{"type":"object","properties":{"id":{"type":"string","description":"Order ID"},"amount":{"type":"string","description":"Transaction amount"},"currency":{"type":"string","description":"Currency code"},"description":{"type":"string","description":"Order description"},"item":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"quantity":{"type":"string"},"category":{"type":"string"},"description":{"type":"string"},"unitPrice":{"type":"string"}}}}}},"UrlInfo":{"type":"object","properties":{"callbackUrl":{"type":"string","format":"uri","description":"Callback URL"},"successUrl":{"type":"string","format":"uri","description":"Success URL"},"failUrl":{"type":"string","format":"uri","description":"Failure URL"}}}}}} ``` ## The ShopeePaylaterPaymentRequest object ```json {"openapi":"3.0.3","info":{"title":"Finpay Payment Gateway API","version":"1.0.0"},"components":{"schemas":{"ShopeePaylaterPaymentRequest":{"type":"object","properties":{"customer":{"$ref":"#/components/schemas/CustomerInfo"},"order":{"$ref":"#/components/schemas/OrderInfo"},"url":{"$ref":"#/components/schemas/UrlInfo"},"sourceOfFunds":{"type":"object","properties":{"type":{"type":"string"}}}}},"CustomerInfo":{"type":"object","properties":{"id":{"type":"string","description":"Customer ID"},"email":{"type":"string","format":"email","description":"Customer email"},"firstName":{"type":"string","description":"Customer first name"},"lastName":{"type":"string","description":"Customer last name"},"mobilePhone":{"type":"string","description":"Customer mobile phone"}}},"OrderInfo":{"type":"object","properties":{"id":{"type":"string","description":"Order ID"},"amount":{"type":"string","description":"Transaction amount"},"currency":{"type":"string","description":"Currency code"},"description":{"type":"string","description":"Order description"},"item":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"quantity":{"type":"string"},"category":{"type":"string"},"description":{"type":"string"},"unitPrice":{"type":"string"}}}}}},"UrlInfo":{"type":"object","properties":{"callbackUrl":{"type":"string","format":"uri","description":"Callback URL"},"successUrl":{"type":"string","format":"uri","description":"Success URL"},"failUrl":{"type":"string","format":"uri","description":"Failure URL"}}}}}} ``` ## The SnapAccessTokenRequest object ```json {"openapi":"3.0.3","info":{"title":"Finpay Payment Gateway API","version":"1.0.0"},"components":{"schemas":{"SnapAccessTokenRequest":{"type":"object","properties":{"grantType":{"type":"string","enum":["client_credentials"]}}}}}} ``` ## The SnapAccessTokenResponse object ```json {"openapi":"3.0.3","info":{"title":"Finpay Payment Gateway API","version":"1.0.0"},"components":{"schemas":{"SnapAccessTokenResponse":{"type":"object","properties":{"responseCode":{"type":"string"},"responseMessage":{"type":"string"},"accessToken":{"type":"string","description":"Access token"},"tokenType":{"type":"string"},"expiresIn":{"type":"integer"}}}}}} ``` ## The GenerateQRCodeRequest object ```json {"openapi":"3.0.3","info":{"title":"Finpay Payment Gateway API","version":"1.0.0"},"components":{"schemas":{"GenerateQRCodeRequest":{"type":"object","properties":{"partnerReferenceNo":{"type":"string","description":"Partner reference number"},"amount":{"type":"object","properties":{"value":{"type":"string"},"currency":{"type":"string"}}},"FeeAmount":{"type":"object","properties":{"value":{"type":"string"},"currency":{"type":"string"}}},"merchantId":{"type":"string","description":"Merchant ID"},"subMerchantId":{"type":"string","description":"Sub-merchant ID"},"terminalId":{"type":"string","description":"Terminal ID"},"validityPeriod":{"type":"string","description":"QR code validity period"},"additionalInfo":{"type":"object","properties":{"tips_indikator":{"type":"string"},"tips_fixamount":{"type":"string"},"tips_percentage":{"type":"string"},"note":{"type":"string"},"qr_type":{"type":"string"},"callback_payment":{"type":"string"}}}}}}}} ``` ## The GenerateQRCodeResponse object ```json {"openapi":"3.0.3","info":{"title":"Finpay Payment Gateway API","version":"1.0.0"},"components":{"schemas":{"GenerateQRCodeResponse":{"type":"object","properties":{"responseCode":{"type":"string"},"responseMessage":{"type":"string"},"referenceNo":{"type":"string","description":"Reference number"},"partnerReferenceNo":{"type":"string","description":"Partner reference number"},"qrContent":{"type":"string","description":"QR code content"},"merchantName":{"type":"string","description":"Merchant name"},"qrUrl":{"type":"string","description":"QR code URL"},"terminalId":{"type":"string","description":"Terminal ID"},"additionalInfo":{"type":"object","properties":{"merchantId":{"type":"string"},"subMerchantId":{"type":"string"},"nmid":{"type":"string"},"validityPeriod":{"type":"string"}}}}}}}} ``` ## The PaymentNotifyRequest object ```json {"openapi":"3.0.3","info":{"title":"Finpay Payment Gateway API","version":"1.0.0"},"components":{"schemas":{"PaymentNotifyRequest":{"type":"object","properties":{"originalPartnerReferenceNo":{"type":"string","description":"Original partner reference number"},"originalReferenceNo":{"type":"string","description":"Original reference number"},"amount":{"type":"object","properties":{"value":{"type":"string"},"currency":{"type":"string"}}},"transactionDate":{"type":"string","format":"date-time","description":"Transaction date"}}}}}} ``` ## The PaymentNotifyResponse object ```json {"openapi":"3.0.3","info":{"title":"Finpay Payment Gateway API","version":"1.0.0"},"components":{"schemas":{"PaymentNotifyResponse":{"type":"object","properties":{"responseCode":{"type":"string"},"responseMessage":{"type":"string"}}}}}} ``` ## The QueryPaymentRequest object ```json {"openapi":"3.0.3","info":{"title":"Finpay Payment Gateway API","version":"1.0.0"},"components":{"schemas":{"QueryPaymentRequest":{"type":"object","properties":{"partnerReferenceNo":{"type":"string","description":"Partner reference number"},"originalReferenceNo":{"type":"string","description":"Original reference number"},"merchantId":{"type":"string","description":"Merchant ID"},"additionalInfo":{"type":"object","properties":{"merchantId":{"type":"string"},"subMerchantId":{"type":"string"}}}}}}}} ``` ## The QueryPaymentResponse object ```json {"openapi":"3.0.3","info":{"title":"Finpay Payment Gateway API","version":"1.0.0"},"components":{"schemas":{"QueryPaymentResponse":{"type":"object","properties":{"responseCode":{"type":"string"},"responseMessage":{"type":"string"},"referenceNo":{"type":"string","description":"Reference number"},"partnerReferenceNo":{"type":"string","description":"Partner reference number"},"amount":{"type":"object","properties":{"value":{"type":"string"},"currency":{"type":"string"}}},"transactionStatus":{"type":"string","description":"Transaction status"},"transactionDate":{"type":"string","format":"date-time","description":"Transaction date"}}}}}} ``` ## The RefundPaymentRequest object ```json {"openapi":"3.0.3","info":{"title":"Finpay Payment Gateway API","version":"1.0.0"},"components":{"schemas":{"RefundPaymentRequest":{"type":"object","properties":{"partnerReferenceNo":{"type":"string","description":"Partner reference number for refund"},"originalPartnerReferenceNo":{"type":"string","description":"Original partner reference number"},"originalReferenceNo":{"type":"string","description":"Original reference number"},"amount":{"type":"object","properties":{"value":{"type":"string"},"currency":{"type":"string"}}},"reason":{"type":"string","description":"Refund reason"},"additionalInfo":{"type":"object","properties":{"merchantId":{"type":"string"},"subMerchantId":{"type":"string"}}}}}}}} ``` ## The RefundPaymentResponse object ```json {"openapi":"3.0.3","info":{"title":"Finpay Payment Gateway API","version":"1.0.0"},"components":{"schemas":{"RefundPaymentResponse":{"type":"object","properties":{"responseCode":{"type":"string"},"responseMessage":{"type":"string"},"referenceNo":{"type":"string","description":"Refund reference number"},"partnerReferenceNo":{"type":"string","description":"Partner reference number"},"originalPartnerReferenceNo":{"type":"string","description":"Original partner reference number"},"originalReferenceNo":{"type":"string","description":"Original reference number"},"amount":{"type":"object","properties":{"value":{"type":"string"},"currency":{"type":"string"}}},"transactionDate":{"type":"string","format":"date-time","description":"Refund date"}}}}}} ``` ## The StandardResponse object ```json {"openapi":"3.0.3","info":{"title":"Finpay Payment Gateway API","version":"1.0.0"},"components":{"schemas":{"StandardResponse":{"type":"object","properties":{"responseCode":{"type":"string","description":"Response code"},"responseMessage":{"type":"string","description":"Response message"},"processingTime":{"type":"number","description":"Processing time in seconds"}}}}}} ``` ## The FinpayPaycodeResponse object ```json {"openapi":"3.0.3","info":{"title":"Finpay Payment Gateway API","version":"1.0.0"},"components":{"schemas":{"FinpayPaycodeResponse":{"allOf":[{"$ref":"#/components/schemas/StandardResponse"},{"type":"object","properties":{"redirecturl":{"type":"string","description":"Redirect URL for payment"},"expiryLink":{"type":"string","description":"Expiry date for payment link"},"paymentCode":{"type":"string","description":"Generated payment code"}}}]},"StandardResponse":{"type":"object","properties":{"responseCode":{"type":"string","description":"Response code"},"responseMessage":{"type":"string","description":"Response message"},"processingTime":{"type":"number","description":"Processing time in seconds"}}}}}} ``` ## The VARegisterResponse object ```json {"openapi":"3.0.3","info":{"title":"Finpay Payment Gateway API","version":"1.0.0"},"components":{"schemas":{"VARegisterResponse":{"allOf":[{"$ref":"#/components/schemas/StandardResponse"},{"type":"object","properties":{"paymentCode":{"type":"string","description":"Generated payment code"}}}]},"StandardResponse":{"type":"object","properties":{"responseCode":{"type":"string","description":"Response code"},"responseMessage":{"type":"string","description":"Response message"},"processingTime":{"type":"number","description":"Processing time in seconds"}}}}}} ``` ## The VAUpdateResponse object ```json {"openapi":"3.0.3","info":{"title":"Finpay Payment Gateway API","version":"1.0.0"},"components":{"schemas":{"VAUpdateResponse":{"allOf":[{"$ref":"#/components/schemas/StandardResponse"},{"type":"object","properties":{"paymentCode":{"type":"string","description":"Updated payment code"}}}]},"StandardResponse":{"type":"object","properties":{"responseCode":{"type":"string","description":"Response code"},"responseMessage":{"type":"string","description":"Response message"},"processingTime":{"type":"number","description":"Processing time in seconds"}}}}}} ``` ## The VACheckResponse object ```json {"openapi":"3.0.3","info":{"title":"Finpay Payment Gateway API","version":"1.0.0"},"components":{"schemas":{"VACheckResponse":{"allOf":[{"$ref":"#/components/schemas/StandardResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"customer":{"$ref":"#/components/schemas/CustomerInfo"},"sourceOfFunds":{"$ref":"#/components/schemas/SourceOfFunds"}}}}}]},"StandardResponse":{"type":"object","properties":{"responseCode":{"type":"string","description":"Response code"},"responseMessage":{"type":"string","description":"Response message"},"processingTime":{"type":"number","description":"Processing time in seconds"}}},"CustomerInfo":{"type":"object","properties":{"id":{"type":"string","description":"Customer ID"},"email":{"type":"string","format":"email","description":"Customer email"},"firstName":{"type":"string","description":"Customer first name"},"lastName":{"type":"string","description":"Customer last name"},"mobilePhone":{"type":"string","description":"Customer mobile phone"}}},"SourceOfFunds":{"type":"object","properties":{"type":{"type":"string","description":"Payment method type"},"paymentCode":{"type":"string","description":"Payment code for VA operations"}}}}}} ``` ## The VADeleteResponse object ```json {"openapi":"3.0.3","info":{"title":"Finpay Payment Gateway API","version":"1.0.0"},"components":{"schemas":{"VADeleteResponse":{"allOf":[{"$ref":"#/components/schemas/StandardResponse"}]},"StandardResponse":{"type":"object","properties":{"responseCode":{"type":"string","description":"Response code"},"responseMessage":{"type":"string","description":"Response message"},"processingTime":{"type":"number","description":"Processing time in seconds"}}}}}} ``` ## The DANAPaymentResponse object ```json {"openapi":"3.0.3","info":{"title":"Finpay Payment Gateway API","version":"1.0.0"},"components":{"schemas":{"DANAPaymentResponse":{"allOf":[{"$ref":"#/components/schemas/StandardResponse"},{"type":"object","properties":{"redirecturl":{"type":"string","description":"Redirect URL for DANA payment"},"expiryLink":{"type":"string","description":"Expiry date for payment link"},"paymentCode":{"type":"string","nullable":true,"description":"Payment code (null for DANA)"}}}]},"StandardResponse":{"type":"object","properties":{"responseCode":{"type":"string","description":"Response code"},"responseMessage":{"type":"string","description":"Response message"},"processingTime":{"type":"number","description":"Processing time in seconds"}}}}}} ``` ## The QRISPaymentResponse object ```json {"openapi":"3.0.3","info":{"title":"Finpay Payment Gateway API","version":"1.0.0"},"components":{"schemas":{"QRISPaymentResponse":{"allOf":[{"$ref":"#/components/schemas/StandardResponse"},{"type":"object","properties":{"redirecturl":{"type":"string","description":"Redirect URL for QRIS payment"},"appurl":{"type":"string","description":"App URL for QRIS payment"},"imageurl":{"type":"string","description":"Image URL for QR code"},"expiryLink":{"type":"string","description":"Expiry date for payment link"},"paymentCode":{"type":"string","description":"Payment code (empty for QRIS)"},"stringQr":{"type":"string","description":"QR code string"}}}]},"StandardResponse":{"type":"object","properties":{"responseCode":{"type":"string","description":"Response code"},"responseMessage":{"type":"string","description":"Response message"},"processingTime":{"type":"number","description":"Processing time in seconds"}}}}}} ``` ## The CardPaymentResponse object ```json {"openapi":"3.0.3","info":{"title":"Finpay Payment Gateway API","version":"1.0.0"},"components":{"schemas":{"CardPaymentResponse":{"allOf":[{"$ref":"#/components/schemas/StandardResponse"},{"type":"object","properties":{"redirecturl":{"type":"string","description":"Redirect URL for credit card payment"},"expiryLink":{"type":"string","description":"Expiry date for payment link"}}}]},"StandardResponse":{"type":"object","properties":{"responseCode":{"type":"string","description":"Response code"},"responseMessage":{"type":"string","description":"Response message"},"processingTime":{"type":"number","description":"Processing time in seconds"}}}}}} ``` ## The BCAKlikPayPaymentResponse object ```json {"openapi":"3.0.3","info":{"title":"Finpay Payment Gateway API","version":"1.0.0"},"components":{"schemas":{"BCAKlikPayPaymentResponse":{"allOf":[{"$ref":"#/components/schemas/StandardResponse"},{"type":"object","properties":{"redirecturl":{"type":"string","description":"Redirect URL for BCA KlikPay payment"},"appurl":{"type":"string","description":"App URL for payment"},"imageurl":{"type":"string","description":"Image URL for payment"},"expiryLink":{"type":"string","description":"Expiry date for payment link"},"paymentCode":{"type":"string","description":"Payment code"}}}]},"StandardResponse":{"type":"object","properties":{"responseCode":{"type":"string","description":"Response code"},"responseMessage":{"type":"string","description":"Response message"},"processingTime":{"type":"number","description":"Processing time in seconds"}}}}}} ``` ## The FinpayMoneyPaymentResponse object ```json {"openapi":"3.0.3","info":{"title":"Finpay Payment Gateway API","version":"1.0.0"},"components":{"schemas":{"FinpayMoneyPaymentResponse":{"allOf":[{"$ref":"#/components/schemas/StandardResponse"},{"type":"object","properties":{"redirecturl":{"type":"string","description":"Redirect URL for Finpay Money payment"},"expiryLink":{"type":"string","description":"Expiry date for payment link"},"paymentCode":{"type":"string","description":"Generated payment code"}}}]},"StandardResponse":{"type":"object","properties":{"responseCode":{"type":"string","description":"Response code"},"responseMessage":{"type":"string","description":"Response message"},"processingTime":{"type":"number","description":"Processing time in seconds"}}}}}} ``` ## The IndodanaPaymentResponse object ```json {"openapi":"3.0.3","info":{"title":"Finpay Payment Gateway API","version":"1.0.0"},"components":{"schemas":{"IndodanaPaymentResponse":{"allOf":[{"$ref":"#/components/schemas/StandardResponse"},{"type":"object","properties":{"redirecturl":{"type":"string","description":"Redirect URL for Indodana payment"},"expiryLink":{"type":"string","description":"Expiry date for payment link"},"paymentCode":{"type":"string","description":"Generated payment code"}}}]},"StandardResponse":{"type":"object","properties":{"responseCode":{"type":"string","description":"Response code"},"responseMessage":{"type":"string","description":"Response message"},"processingTime":{"type":"number","description":"Processing time in seconds"}}}}}} ``` ## The JeniusPayPaymentResponse object ```json {"openapi":"3.0.3","info":{"title":"Finpay Payment Gateway API","version":"1.0.0"},"components":{"schemas":{"JeniusPayPaymentResponse":{"allOf":[{"$ref":"#/components/schemas/StandardResponse"},{"type":"object","properties":{"redirecturl":{"type":"string","description":"Redirect URL for Jenius Pay payment"},"expiryLink":{"type":"string","description":"Expiry date for payment link"},"paymentCode":{"type":"string","description":"Generated payment code"}}}]},"StandardResponse":{"type":"object","properties":{"responseCode":{"type":"string","description":"Response code"},"responseMessage":{"type":"string","description":"Response message"},"processingTime":{"type":"number","description":"Processing time in seconds"}}}}}} ``` ## The LinkAjaAppLinkPaymentResponse object ```json {"openapi":"3.0.3","info":{"title":"Finpay Payment Gateway API","version":"1.0.0"},"components":{"schemas":{"LinkAjaAppLinkPaymentResponse":{"allOf":[{"$ref":"#/components/schemas/StandardResponse"},{"type":"object","properties":{"redirecturl":{"type":"string","description":"Redirect URL for LinkAja App Link payment"},"expiryLink":{"type":"string","description":"Expiry date for payment link"},"paymentCode":{"type":"string","description":"Generated payment code"}}}]},"StandardResponse":{"type":"object","properties":{"responseCode":{"type":"string","description":"Response code"},"responseMessage":{"type":"string","description":"Response message"},"processingTime":{"type":"number","description":"Processing time in seconds"}}}}}} ``` ## The LinkAjaWebPaymentResponse object ```json {"openapi":"3.0.3","info":{"title":"Finpay Payment Gateway API","version":"1.0.0"},"components":{"schemas":{"LinkAjaWebPaymentResponse":{"allOf":[{"$ref":"#/components/schemas/StandardResponse"},{"type":"object","properties":{"redirecturl":{"type":"string","description":"Redirect URL for LinkAja Web payment"},"expiryLink":{"type":"string","description":"Expiry date for payment link"},"paymentCode":{"type":"string","description":"Generated payment code"}}}]},"StandardResponse":{"type":"object","properties":{"responseCode":{"type":"string","description":"Response code"},"responseMessage":{"type":"string","description":"Response message"},"processingTime":{"type":"number","description":"Processing time in seconds"}}}}}} ``` ## The OVOPaymentResponse object ```json {"openapi":"3.0.3","info":{"title":"Finpay Payment Gateway API","version":"1.0.0"},"components":{"schemas":{"OVOPaymentResponse":{"allOf":[{"$ref":"#/components/schemas/StandardResponse"},{"type":"object","properties":{"redirecturl":{"type":"string","description":"Redirect URL for OVO payment"},"expiryLink":{"type":"string","description":"Expiry date for payment link"},"paymentCode":{"type":"string","description":"Generated payment code"}}}]},"StandardResponse":{"type":"object","properties":{"responseCode":{"type":"string","description":"Response code"},"responseMessage":{"type":"string","description":"Response message"},"processingTime":{"type":"number","description":"Processing time in seconds"}}}}}} ``` ## The ShopeePayPaymentResponse object ```json {"openapi":"3.0.3","info":{"title":"Finpay Payment Gateway API","version":"1.0.0"},"components":{"schemas":{"ShopeePayPaymentResponse":{"allOf":[{"$ref":"#/components/schemas/StandardResponse"},{"type":"object","properties":{"redirecturl":{"type":"string","description":"Redirect URL for ShopeePay payment"},"expiryLink":{"type":"string","description":"Expiry date for payment link"},"paymentCode":{"type":"string","description":"Generated payment code"}}}]},"StandardResponse":{"type":"object","properties":{"responseCode":{"type":"string","description":"Response code"},"responseMessage":{"type":"string","description":"Response message"},"processingTime":{"type":"number","description":"Processing time in seconds"}}}}}} ``` ## The VirgoPaymentResponse object ```json {"openapi":"3.0.3","info":{"title":"Finpay Payment Gateway API","version":"1.0.0"},"components":{"schemas":{"VirgoPaymentResponse":{"allOf":[{"$ref":"#/components/schemas/StandardResponse"},{"type":"object","properties":{"redirecturl":{"type":"string","description":"Redirect URL for Virgo payment"},"expiryLink":{"type":"string","description":"Expiry date for payment link"},"paymentCode":{"type":"string","description":"Generated payment code"}}}]},"StandardResponse":{"type":"object","properties":{"responseCode":{"type":"string","description":"Response code"},"responseMessage":{"type":"string","description":"Response message"},"processingTime":{"type":"number","description":"Processing time in seconds"}}}}}} ``` ## The BSecurePaymentResponse object ```json {"openapi":"3.0.3","info":{"title":"Finpay Payment Gateway API","version":"1.0.0"},"components":{"schemas":{"BSecurePaymentResponse":{"allOf":[{"$ref":"#/components/schemas/StandardResponse"},{"type":"object","properties":{"redirecturl":{"type":"string","description":"Redirect URL for BSecure payment"},"expiryLink":{"type":"string","description":"Expiry date for payment link"},"paymentCode":{"type":"string","description":"Generated payment code"}}}]},"StandardResponse":{"type":"object","properties":{"responseCode":{"type":"string","description":"Response code"},"responseMessage":{"type":"string","description":"Response message"},"processingTime":{"type":"number","description":"Processing time in seconds"}}}}}} ``` ## The OctoClicksPaymentResponse object ```json {"openapi":"3.0.3","info":{"title":"Finpay Payment Gateway API","version":"1.0.0"},"components":{"schemas":{"OctoClicksPaymentResponse":{"allOf":[{"$ref":"#/components/schemas/StandardResponse"},{"type":"object","properties":{"redirecturl":{"type":"string","description":"Redirect URL for Octo Clicks payment"},"expiryLink":{"type":"string","description":"Expiry date for payment link"},"paymentCode":{"type":"string","description":"Generated payment code"}}}]},"StandardResponse":{"type":"object","properties":{"responseCode":{"type":"string","description":"Response code"},"responseMessage":{"type":"string","description":"Response message"},"processingTime":{"type":"number","description":"Processing time in seconds"}}}}}} ``` ## The PermataNetPaymentResponse object ```json {"openapi":"3.0.3","info":{"title":"Finpay Payment Gateway API","version":"1.0.0"},"components":{"schemas":{"PermataNetPaymentResponse":{"allOf":[{"$ref":"#/components/schemas/StandardResponse"},{"type":"object","properties":{"redirecturl":{"type":"string","description":"Redirect URL for PermataNet payment"},"expiryLink":{"type":"string","description":"Expiry date for payment link"},"paymentCode":{"type":"string","description":"Generated payment code"}}}]},"StandardResponse":{"type":"object","properties":{"responseCode":{"type":"string","description":"Response code"},"responseMessage":{"type":"string","description":"Response message"},"processingTime":{"type":"number","description":"Processing time in seconds"}}}}}} ``` ## The KredivoPaymentResponse object ```json {"openapi":"3.0.3","info":{"title":"Finpay Payment Gateway API","version":"1.0.0"},"components":{"schemas":{"KredivoPaymentResponse":{"allOf":[{"$ref":"#/components/schemas/StandardResponse"},{"type":"object","properties":{"redirecturl":{"type":"string","description":"Redirect URL for Kredivo payment"},"expiryLink":{"type":"string","description":"Expiry date for payment link"},"paymentCode":{"type":"string","description":"Generated payment code"}}}]},"StandardResponse":{"type":"object","properties":{"responseCode":{"type":"string","description":"Response code"},"responseMessage":{"type":"string","description":"Response message"},"processingTime":{"type":"number","description":"Processing time in seconds"}}}}}} ``` ## The ShopeePaylaterPaymentResponse object ```json {"openapi":"3.0.3","info":{"title":"Finpay Payment Gateway API","version":"1.0.0"},"components":{"schemas":{"ShopeePaylaterPaymentResponse":{"allOf":[{"$ref":"#/components/schemas/StandardResponse"},{"type":"object","properties":{"redirecturl":{"type":"string","description":"Redirect URL for ShopeePay Later payment"},"expiryLink":{"type":"string","description":"Expiry date for payment link"},"paymentCode":{"type":"string","description":"Generated payment code"}}}]},"StandardResponse":{"type":"object","properties":{"responseCode":{"type":"string","description":"Response code"},"responseMessage":{"type":"string","description":"Response message"},"processingTime":{"type":"number","description":"Processing time in seconds"}}}}}} ``` ## The RefundRequest object ```json {"openapi":"3.0.3","info":{"title":"Finpay Payment Gateway API","version":"1.0.0"},"components":{"schemas":{"RefundRequest":{"type":"object","properties":{"order":{"type":"object","properties":{"id":{"type":"string","description":"Order ID"},"amount":{"type":"string","description":"Refund amount"}}}}}}}} ``` ## The VoidRequest object ```json {"openapi":"3.0.3","info":{"title":"Finpay Payment Gateway API","version":"1.0.0"},"components":{"schemas":{"VoidRequest":{"type":"object","properties":{"order":{"type":"object","properties":{"id":{"type":"string","description":"Order ID"},"amount":{"type":"string","description":"Void amount"}}}}}}}} ``` ## The CheckStatusResponse object ```json {"openapi":"3.0.3","info":{"title":"Finpay Payment Gateway API","version":"1.0.0"},"components":{"schemas":{"CheckStatusResponse":{"allOf":[{"$ref":"#/components/schemas/StandardResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"customer":{"$ref":"#/components/schemas/CustomerInfo"},"order":{"$ref":"#/components/schemas/OrderInfo"},"card":{"type":"object","properties":{"mask":{"type":"string","description":"Masked card number"},"info":{"type":"object","properties":{"brand":{"type":"string","description":"Card brand"},"issuing":{"type":"string","description":"Issuing bank"},"type":{"type":"string","description":"Card type"},"subType":{"type":"string","description":"Card subtype"},"country":{"type":"string","description":"Card country"}}}}},"meta":{"type":"object","properties":{"data":{"type":"object","nullable":true}}},"result":{"type":"object","properties":{"payment":{"type":"object","properties":{"amount":{"type":"integer","description":"Payment amount"},"status":{"type":"string","description":"Payment status"},"statusDesc":{"type":"string","nullable":true,"description":"Status description"}}}}}}}}}]},"StandardResponse":{"type":"object","properties":{"responseCode":{"type":"string","description":"Response code"},"responseMessage":{"type":"string","description":"Response message"},"processingTime":{"type":"number","description":"Processing time in seconds"}}},"CustomerInfo":{"type":"object","properties":{"id":{"type":"string","description":"Customer ID"},"email":{"type":"string","format":"email","description":"Customer email"},"firstName":{"type":"string","description":"Customer first name"},"lastName":{"type":"string","description":"Customer last name"},"mobilePhone":{"type":"string","description":"Customer mobile phone"}}},"OrderInfo":{"type":"object","properties":{"id":{"type":"string","description":"Order ID"},"amount":{"type":"string","description":"Transaction amount"},"currency":{"type":"string","description":"Currency code"},"description":{"type":"string","description":"Order description"},"item":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"quantity":{"type":"string"},"category":{"type":"string"},"description":{"type":"string"},"unitPrice":{"type":"string"}}}}}}}}} ``` ## The RefundResponse object ```json {"openapi":"3.0.3","info":{"title":"Finpay Payment Gateway API","version":"1.0.0"},"components":{"schemas":{"RefundResponse":{"allOf":[{"$ref":"#/components/schemas/StandardResponse"}]},"StandardResponse":{"type":"object","properties":{"responseCode":{"type":"string","description":"Response code"},"responseMessage":{"type":"string","description":"Response message"},"processingTime":{"type":"number","description":"Processing time in seconds"}}}}}} ``` ## The VoidResponse object ```json {"openapi":"3.0.3","info":{"title":"Finpay Payment Gateway API","version":"1.0.0"},"components":{"schemas":{"VoidResponse":{"allOf":[{"$ref":"#/components/schemas/StandardResponse"}]},"StandardResponse":{"type":"object","properties":{"responseCode":{"type":"string","description":"Response code"},"responseMessage":{"type":"string","description":"Response message"},"processingTime":{"type":"number","description":"Processing time in seconds"}}}}}} ``` ## The CancelResponse object ```json {"openapi":"3.0.3","info":{"title":"Finpay Payment Gateway API","version":"1.0.0"},"components":{"schemas":{"CancelResponse":{"allOf":[{"$ref":"#/components/schemas/StandardResponse"}]},"StandardResponse":{"type":"object","properties":{"responseCode":{"type":"string","description":"Response code"},"responseMessage":{"type":"string","description":"Response message"},"processingTime":{"type":"number","description":"Processing time in seconds"}}}}}} ``` --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.finpay.id/api-reference/finpay-pg-rest-api/models.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.