{"mock":"https://private-anon-9164e831de-yourpay.apiary-mock.com/","production":"https://webservice.yourpay.dk/","proxy":"https://private-anon-9164e831de-yourpay.apiary-proxy.com/"}
FORMAT: 1A
HOST: https://webservice.yourpay.dk/
# Yourpay
+ Parameters
+ merchant_token (string)
Test, localize and find the code examples you need to work with our endpoints and services.
# Apps [/v4.3/app_customer_list{?merchant_token}]
## All installed apps [GET]
You can through this endpoint read all installed Apps on the merchant account.
This can be usefull if you through the checkoutflow wish to verify if a payment extension should be enabled or not.
+ Parameters
+ merchant_token (string) - Merchant Token
+ Response 200 (application/json)
{
"success": true,
"time": 1536781505,
"message": "Request performed successfully.",
"code": 0,
"content": {}
}
# App Data [/v4.3/app_data{?id,merchant_token}]
## App Data [GET]
Gain access to data related directly to a specific App. This should be a unique app-identifier.
The ID is gained from "All installed apps".
+ Parameters
+ id (string) - ID from All installed apps
+ merchant_token (optional) - Merchant Token
+ Response 200 (application/json)
[
{
"success": true,
"time": 1536781822,
"message": "Request performed successfully.",
"code": 0,
"content": {
"settings": [
],
"settings_values": [
],
"installed": false,
"title": "Billy",
"category": "Regnskab",
"website": {
"name": "billy.dk",
"link": "https://www.billy.dk/"
},
"developer": {
"name": "Yourpay",
"link": "support@yourpay.io"
},
"tags": [
"Regnskab",
"Fakturering",
"Handel",
"Enkelhed"
],
"cost": 0,
"monthly_cost": 0,
"currency": "DKK",
"subdivision": "Brug Billy's funktioner til regnskab og fakturering. ",
"content": "<p><strong><span>Bliv fri for at vente på dine penge</span></strong></p>\n <p><span>Med Billy kan du nemt modtage online kortbetaling på dine fakturaer. Når du sender en faktura med Yourpay som betalingsmetode vil et kortbetalingslink automatisk blive indlejret.</span></p>\n <p><span>Det lader dine kunder betale med deres kreditkort - direkte i fakturaen! Det gør det let for dine kunder at betale, hvad de skylder. De slipper for besvær med NemID og bankoverførsler, og du får dine penge med det samme. </span></p>\n <p><span> </span></p>\n <p><strong><span>Dine fordele med Billy</span></strong></p>\n <ul>\n <li><span>Slip for administrativt besvær. Alt bogføres automatisk.</span></li>\n <li><span>Kortbetalingslink direkte på dine fakturaer</span></li>\n <li><span>Send fakturaer og rykkere på sms</span></li>\n <li><span>Hurtig opsætning – det tager kun 5 minutter at installere</span></li>\n </ul>\n <p><span> </span></p>\n <p><strong><span>Din unikke aftale som Yourpay-kunde</span></strong></p>\n <p><span>Som nuværende bruger af Yourpay får du 3 mdr. gratis Billy Premium, når du opretter en ny Billy-bruger. Hvis du har regnskab et andet sted, hjælper Billy dig med at flytte det.</span></p>",
"image": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAJsAAACZCAMAAAAPd7i1AAABxVBMVEVMaXE5nuY5nuY5nuY5nuY5nuY5nuY5nuY5nuY5nuY5nuY5nuY5nuY5nuY5nuY5nuY5nuZzX1D/1Mz///9ZWVlZSkeslpKsrKzVta9Wfptlb3U9mt3V1dVPhq5IjsBjY2Pq6upwY1mXl5fz0c6cudn1zMXBpqG1wNb19fVtbW1sZ2KCgoLBwcFjYGCEstxrrN+MjIzqxb5FoeT2zcRtaGeCd3VAltPlvrXgvbZeqOHct63g4OBhc362npmBa2d3r97nzc+Xh4SWfG+hj4usjolSpeOhoaFddojLy8uMf314eHjbytG5mY57Zld4cG5oa2ywkobCw9TOx9LLqJ6NdWfCoZbVsar1y8S2l5GXfXljUU+EbV9aepHKqJ1Lire2trbLrajLqKKQttupvNdEksrTr6VsW1eMdHDBoJpSgqTtxbx8Zljuxr3gurPqw7y5mo6FbmChhoCeg3Z3ZVini354ZVh4Y1+Qem+BipWspqXLr6p4dnWXk5JvhZdYfJasqamTe29tammAbGBxd3z3zcWXrsifhHdta2uXiIVrcHRqaWeeiH9lbnWXi4lta2p7a2CrkYenlJB6amB4amGLfnmah4DUsKb4Twz6AAAAEHRSTlMAMKAgEGDggMDwQHDQsFCQY3Aq6wAAAAlwSFlzAAALEgAACxIB0t1+/AAACTtJREFUeNrNnPdbE0kYxyUEkhCQzQZSCCkkQAIEkAAh9BKpoiIKgtKxe+rpqdd77/3+3tu+O1tnZkv2+4OPD5nyyTtvmd3szoULemoKevwBwh41+luDdRfwVB9sIWxXoKXBi0zW4CecUstFFDCvL0A4qcYGaLSgs2QIdE2NRC3kN44LbytRK/kM0OqaidrJrxuyFwNELdWos64NRI0VqHMtGgXX4Fo0Lcu5Ak0dri7gDjaiURGt3kbCLfLL2VoI9ygoS2yEm1QPrGjAVWzAqrYS7pIky9VbOnAq3sFoNZ5M4caqyOaxjCuRnAkB6p+JpxImDGeZ2Y5kYALg6uN7mIazxtvKB10hHXXNIPHx1xBWBGlqJmSsrplkGfYCx7LcluwPwar/4AjK/7yWREIiDk/GquNxGTIaAibJukIY6j9IQSxqUw3IWO9b1VvdAM3mqw0Zaz2dta0zswMxTbaaMnK4xtqQXU8ahKuHYsNDe2yKrGvVOA83U3txmJRvIp+ppZAk1NeHC1PZYKkOM+4fhy0NTXBsIQlcecYE2cwRyv0RHxSbAJc4CFmgpKVs3HBm0wYCGgIbPaA8BG7ZiYbCFvpMEgK3tg6nSJI8tBHNiO0ozgg0192t+6Mkp/tXkdF+sSgWEtflI1/dmiClmkCH67doTWVwS4ekXBNoTrd1k65XKUv8TQq3NEWqaPQVPNlV6rvdZEpD2YpYSPzEu78qGa0dWLS7jD/cZDchCdNs5VVu3B1SW5DrusWFEAvXFU+YiwU+116dIHW1CWE00e43ud1I0gRbkq8CX42SBnqyZOBpm9LWL/iQTWGypYQweDNBGmtqSY9M9uW+E/ZL9zDYypIqMEVCaeK1xmruKMz+jeihq2VENmC7sUnCavTwlTwX391SNfrEU7GJRlBosUmr1BckkqZ2Xi/dZfPh0ubhE5jEcx2JTbKgb0ZJWyRxzw5ctvv2oJHvPMVkE/fd75N26YUwxwESW1zo98Q2NvJdIRjw2DbtQ+PLAypbkuv13qiNbEI4pJDYUg6YjUo3ZtjsNZvgcWW0uuCE2QSPQ6ynbCebzUaST7HZfrYbjdzSLlnabExhkFXpkVgsNhth1RuLjUDNLulzQv1fXhy0y4I+2+8C02xkfLxNqbHxaq82YWx2Ub3TOvXN+Eb0XmkGkY0uWn+QZGW2qjY+MNfiiZKrp3fdqNt45GSE3Y7EEdnizJJG2qA0FukBLbYI168txiwqBttfpIJtYGAlSmltjf43O9AnfDC4yC9T5aR6TeywwXQ47iyyHTYUbHSKSyKyUUXrX5Ct7zgTlqvQubKhaZRLx9OKDuHObBpk29IqC9psKWbjJrKli2ENTV9SA0tHCxrtCysA239YbE8kbH2ZsLbW0gq0jYJO+6KUjXK4BCJbIvQ35Tyz/CDTYT11IqGFw1G+XYUpDcjXgKF/aM/mAi4a1pd8Wdf0mxf6RDRyqQud7U8mTw0yg4Armsn2tQ0UFYYYo3N/lemg3zocZl2uym7NO5DZOthrGMbjPgadn3WvrIxtkcshgyAb1/qSihOwJWUHne1H9mJ+hB7kE2BgPqsVQTY+/UZANr416Bb0X9a5DeYqMtvX3P6ITqQfAlEpJGKAbVwoCtRHncow6VOwzXJscWS2T7mpqtQon6sGmcQ6A4IVKAFsaq05tgrXHp3tA65nr3w9hNnSwMJFBLYxaYeiNhvf/giZ7VvJEq0AocBPJgZDgU2jnNalnp8RKpicTXCCFDJbt2SJBtSSWToDuKC4E5kFTLqilr0zYlyT5D18tjG5HxcYuLToU+Gs1N2Y0F6TwaXXFDlEcAICn43eJMpK0HQ0WpT8qUClsF7J9u0amPwyx0Br3mdjFrBFgLjTKI+D0s1lr6KSqNW4HgvYYkb1NJOWRimtQbnry0XF9TUSn21eOtOA3kQDMrOxhivqfRuhmOKxDQt9F/WXKCumeKnHpaf190h85iUXzLBV2vSWKNsGBCkXqoNgICudQFzSbYzfF8SZxmW7Duk09OXCtR7ltanOrq9A9xGvG2+YYqOt0JZV2cpmaKOpoVEuR/fpU3O66Q1pUSDJbgy2bdC329LHIF2myBaIH3pUr+orY0ynFdkWeJr5OtLYGcJgO5cFHl27osVORtHoJW5f9v1HWrcceqr8XirLdzvOsr3GKpJ2kxhsZ4D/jKlegn7Zq3ebZmRxULXXImBpnN/aJmUOtC6faLxaMbqJ1NP762/y+xNV8O7ONtbvgDmFHWInEeEWVwX6Hpt4k2s2FlM45zkW2w3SCc1jsQ05wob32+6yE2g3MH8Tv+IA2xAm25kDbCVMtpL9aHns5xzsj9RhbLZhu9EWTDy7slC7SDBksznF5UpmnkeyxHC3tT7oNvWslKbhnkGTPZp7gGU24+e4tjUmbJ97BGWyvQft7e2nGN4GwaYRqvvUjHdeGhjv9qOHVLP2/V31j6+YfjYvrz7wLk3X/uDlqZYzPd9jwO68fI6T2+DYSjnN5XpLT97+dn9vFwR8dnr54R0GbP9U26rnFjzfO689PGUbhoG24Nzc3MPL1D9zwl/0wKi0W7Li2eO8rlM929ufa5fpztzl0+cmqhU8W8l4r3R7d3fvMqtHu7swAdxt0TPbkzknt5SIz5PPW412pWQZm9V1Nbds3XP4RvGAijZJWMlmJRwkGsUG+8pd3mk0ogH+dcC8w2hEPcILxZYExAI0GoH0Xtt8zpnkwYp+yR7hFJhJs1fTefi5mPcBUV7bLZlyutw8wlTMqQ5BlA5m1nV7GWmmOvS363FNlxtCm4d9wx71BdRhHK87LyHO4sF89X8I9dIwv4w8B/vyfx1B2EuHQca+io2WRSQrC3kjJ3e+jDN8q7kTfpbPjB0vP483tnD0Cv6pK8tnN7RzygI2mPTkFROv2FPF4iyvuPhf2O6eXzYzaJOVBxANDw91sxoenjQ9mt99Z0opvI2R31VoreCBkW46hEh+6lXQRWyK08I8rkELKg9BbHYJmkfthEZ3nGTWrHogoitOgGvWOKvRBXDNmsdI1tfa5/ROuPT6XRcGEvlqRxYwPO+1rlbh6q+HOIjWF3Cl0biQcLxGBHzwJzPXe5y0XWMQ7cxob4ND+STguYhx0La3wWN3XPh9TRew5W0K+jx+G9Ti8zUZncL8P2doY7JXZwNBAAAAAElFTkSuQmCC",
"header": "Tilføj mulighed for Billy Regnskab",
"public_content": "I Billy gør vi regnskab og bogføring nemt for alle. Vores regnskabsprogram er nemlig bygget til at øgre livet lettere for dig som selvstændig, så du kan bruge mindre tid på regnskab og mere tid på din virksomhed."
}
}
]
# App Install [/v4.3/app_install{?id,merchant_token,install}]
## App Install [GET]
Install apps directly through your third party software. Automatially add MobilePay, Viabill or any other external app directly from your own service.
+ Parameters
+ merchant_token (string) - Merchant Token
+ id (string) - ID from All installed apps
+ install (bool) - true for installed, false for uninstall
+ Response 200 (application/json)
[
{
"success": true,
"time": 1536782210,
"message": "Request performed successfully.",
"code": 0,
"content": {
"id": "dk_billy",
"install": 1
}
}
]
# App list [/v4.3/app_list]
## App list [GET]
List all available apps at Yourpay.
+ Response 200 (application/json)
[
{
"success": true,
"time": 1536782572,
"message": "Request performed successfully.",
"code": 0,
"content": {
"dk_billy": {
"lang": "da-dk",
"name": "Billy",
"category": "Regnskab",
"path": "dk_billy",
"image": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAJsAAACZCAMAAAAPd7i1AAABxVBMVEVMaXE5nuY5nuY5nuY5nuY5nuY5nuY5nuY5nuY5nuY5nuY5nuY5nuY5nuY5nuY5nuY5nuZzX1D/1Mz///9ZWVlZSkeslpKsrKzVta9Wfptlb3U9mt3V1dVPhq5IjsBjY2Pq6upwY1mXl5fz0c6cudn1zMXBpqG1wNb19fVtbW1sZ2KCgoLBwcFjYGCEstxrrN+MjIzqxb5FoeT2zcRtaGeCd3VAltPlvrXgvbZeqOHct63g4OBhc362npmBa2d3r97nzc+Xh4SWfG+hj4usjolSpeOhoaFddojLy8uMf314eHjbytG5mY57Zld4cG5oa2ywkobCw9TOx9LLqJ6NdWfCoZbVsar1y8S2l5GXfXljUU+EbV9aepHKqJ1Lire2trbLrajLqKKQttupvNdEksrTr6VsW1eMdHDBoJpSgqTtxbx8Zljuxr3gurPqw7y5mo6FbmChhoCeg3Z3ZVini354ZVh4Y1+Qem+BipWspqXLr6p4dnWXk5JvhZdYfJasqamTe29tammAbGBxd3z3zcWXrsifhHdta2uXiIVrcHRqaWeeiH9lbnWXi4lta2p7a2CrkYenlJB6amB4amGLfnmah4DUsKb4Twz6AAAAEHRSTlMAMKAgEGDggMDwQHDQsFCQY3Aq6wAAAAlwSFlzAAALEgAACxIB0t1+/AAACTtJREFUeNrNnPdbE0kYxyUEkhCQzQZSCCkkQAIEkAAh9BKpoiIKgtKxe+rpqdd77/3+3tu+O1tnZkv2+4OPD5nyyTtvmd3szoULemoKevwBwh41+luDdRfwVB9sIWxXoKXBi0zW4CecUstFFDCvL0A4qcYGaLSgs2QIdE2NRC3kN44LbytRK/kM0OqaidrJrxuyFwNELdWos64NRI0VqHMtGgXX4Fo0Lcu5Ak0dri7gDjaiURGt3kbCLfLL2VoI9ygoS2yEm1QPrGjAVWzAqrYS7pIky9VbOnAq3sFoNZ5M4caqyOaxjCuRnAkB6p+JpxImDGeZ2Y5kYALg6uN7mIazxtvKB10hHXXNIPHx1xBWBGlqJmSsrplkGfYCx7LcluwPwar/4AjK/7yWREIiDk/GquNxGTIaAibJukIY6j9IQSxqUw3IWO9b1VvdAM3mqw0Zaz2dta0zswMxTbaaMnK4xtqQXU8ahKuHYsNDe2yKrGvVOA83U3txmJRvIp+ppZAk1NeHC1PZYKkOM+4fhy0NTXBsIQlcecYE2cwRyv0RHxSbAJc4CFmgpKVs3HBm0wYCGgIbPaA8BG7ZiYbCFvpMEgK3tg6nSJI8tBHNiO0ozgg0192t+6Mkp/tXkdF+sSgWEtflI1/dmiClmkCH67doTWVwS4ekXBNoTrd1k65XKUv8TQq3NEWqaPQVPNlV6rvdZEpD2YpYSPzEu78qGa0dWLS7jD/cZDchCdNs5VVu3B1SW5DrusWFEAvXFU+YiwU+116dIHW1CWE00e43ud1I0gRbkq8CX42SBnqyZOBpm9LWL/iQTWGypYQweDNBGmtqSY9M9uW+E/ZL9zDYypIqMEVCaeK1xmruKMz+jeihq2VENmC7sUnCavTwlTwX391SNfrEU7GJRlBosUmr1BckkqZ2Xi/dZfPh0ubhE5jEcx2JTbKgb0ZJWyRxzw5ctvv2oJHvPMVkE/fd75N26YUwxwESW1zo98Q2NvJdIRjw2DbtQ+PLAypbkuv13qiNbEI4pJDYUg6YjUo3ZtjsNZvgcWW0uuCE2QSPQ6ynbCebzUaST7HZfrYbjdzSLlnabExhkFXpkVgsNhth1RuLjUDNLulzQv1fXhy0y4I+2+8C02xkfLxNqbHxaq82YWx2Ub3TOvXN+Eb0XmkGkY0uWn+QZGW2qjY+MNfiiZKrp3fdqNt45GSE3Y7EEdnizJJG2qA0FukBLbYI168txiwqBttfpIJtYGAlSmltjf43O9AnfDC4yC9T5aR6TeywwXQ47iyyHTYUbHSKSyKyUUXrX5Ct7zgTlqvQubKhaZRLx9OKDuHObBpk29IqC9psKWbjJrKli2ENTV9SA0tHCxrtCysA239YbE8kbH2ZsLbW0gq0jYJO+6KUjXK4BCJbIvQ35Tyz/CDTYT11IqGFw1G+XYUpDcjXgKF/aM/mAi4a1pd8Wdf0mxf6RDRyqQud7U8mTw0yg4Armsn2tQ0UFYYYo3N/lemg3zocZl2uym7NO5DZOthrGMbjPgadn3WvrIxtkcshgyAb1/qSihOwJWUHne1H9mJ+hB7kE2BgPqsVQTY+/UZANr416Bb0X9a5DeYqMtvX3P6ITqQfAlEpJGKAbVwoCtRHncow6VOwzXJscWS2T7mpqtQon6sGmcQ6A4IVKAFsaq05tgrXHp3tA65nr3w9hNnSwMJFBLYxaYeiNhvf/giZ7VvJEq0AocBPJgZDgU2jnNalnp8RKpicTXCCFDJbt2SJBtSSWToDuKC4E5kFTLqilr0zYlyT5D18tjG5HxcYuLToU+Gs1N2Y0F6TwaXXFDlEcAICn43eJMpK0HQ0WpT8qUClsF7J9u0amPwyx0Br3mdjFrBFgLjTKI+D0s1lr6KSqNW4HgvYYkb1NJOWRimtQbnry0XF9TUSn21eOtOA3kQDMrOxhivqfRuhmOKxDQt9F/WXKCumeKnHpaf190h85iUXzLBV2vSWKNsGBCkXqoNgICudQFzSbYzfF8SZxmW7Duk09OXCtR7ltanOrq9A9xGvG2+YYqOt0JZV2cpmaKOpoVEuR/fpU3O66Q1pUSDJbgy2bdC329LHIF2myBaIH3pUr+orY0ynFdkWeJr5OtLYGcJgO5cFHl27osVORtHoJW5f9v1HWrcceqr8XirLdzvOsr3GKpJ2kxhsZ4D/jKlegn7Zq3ebZmRxULXXImBpnN/aJmUOtC6faLxaMbqJ1NP762/y+xNV8O7ONtbvgDmFHWInEeEWVwX6Hpt4k2s2FlM45zkW2w3SCc1jsQ05wob32+6yE2g3MH8Tv+IA2xAm25kDbCVMtpL9aHns5xzsj9RhbLZhu9EWTDy7slC7SDBksznF5UpmnkeyxHC3tT7oNvWslKbhnkGTPZp7gGU24+e4tjUmbJ97BGWyvQft7e2nGN4GwaYRqvvUjHdeGhjv9qOHVLP2/V31j6+YfjYvrz7wLk3X/uDlqZYzPd9jwO68fI6T2+DYSjnN5XpLT97+dn9vFwR8dnr54R0GbP9U26rnFjzfO689PGUbhoG24Nzc3MPL1D9zwl/0wKi0W7Li2eO8rlM929ufa5fpztzl0+cmqhU8W8l4r3R7d3fvMqtHu7swAdxt0TPbkzknt5SIz5PPW412pWQZm9V1Nbds3XP4RvGAijZJWMlmJRwkGsUG+8pd3mk0ogH+dcC8w2hEPcILxZYExAI0GoH0Xtt8zpnkwYp+yR7hFJhJs1fTefi5mPcBUV7bLZlyutw8wlTMqQ5BlA5m1nV7GWmmOvS363FNlxtCm4d9wx71BdRhHK87LyHO4sF89X8I9dIwv4w8B/vyfx1B2EuHQca+io2WRSQrC3kjJ3e+jDN8q7kTfpbPjB0vP483tnD0Cv6pK8tnN7RzygI2mPTkFROv2FPF4iyvuPhf2O6eXzYzaJOVBxANDw91sxoenjQ9mt99Z0opvI2R31VoreCBkW46hEh+6lXQRWyK08I8rkELKg9BbHYJmkfthEZ3nGTWrHogoitOgGvWOKvRBXDNmsdI1tfa5/ROuPT6XRcGEvlqRxYwPO+1rlbh6q+HOIjWF3Cl0biQcLxGBHzwJzPXe5y0XWMQ7cxob4ND+STguYhx0La3wWN3XPh9TRew5W0K+jx+G9Ti8zUZncL8P2doY7JXZwNBAAAAAElFTkSuQmCC"
}
}
]
# App Update [/v4.3/app_update{?merchant_token,id,app_key,app_value}]
## App Update [GET]
Update Yourpay App data values with new datasets.
+ Parameters
+ merchant_token (string) - Merchant Token
+ id (string) - ID for app to update
+ app_key (string) - Field to update
+ app_value (string) - Value to update field with
+ Response 200 (application/json)
[
{
"success": true,
"time": 1536782703,
"message": "Request performed successfully.",
"code": 0,
"content": {
"app_id": "dk_billy",
"app_key": "yes",
"app_value": "updated"
}
}
]
# Callback count [/v4.3/callback_count{?merchant_token}]
## Callback count [GET]
Retrive sum of callback requests performed.
+ Parameters
+ merchant_token (string) - Merchant Token
+ Response 200 (application/json)
[
{
"success": true,
"time": 1536782784,
"message": "Request performed successfully.",
"code": 0,
"content": {
"count": "0"
}
}
]
# Callback data [/v4.3/callback_data{?merchant_token,id}]
## Callback data [GET]
Retrive a full list of a specific callback we have performed, and the current status.
Id can be optained from callback list
+ Parameters
+ merchant_token (string) - Merchant Token
+ id (int) - Callback ID
+ Response 200 (application/json)
[
{
"success": true,
"time": 1536783042,
"message": "Request performed successfully.",
"code": 0,
"content": {
}
]
# Callback list [/v4.3/callback_list{?merchant_token}]
## Callback list [GET]
Retrive a full list of a specific callback we have performed, and the current status
+ Parameters
+ merchant_token (string) - Merchant Token
+ Response 200 (application/json)
{
"success": true,
"time": 1536783002,
"message": "Request performed successfully.",
"code": 0,
"content": [
{
}
}
# Customer data [/v4.3/customer_data{?merchant_token}]
## Customer data [GET]
Retrive a full set of merchant related data based on your Merchant token. These data can be used for registration into third party integrations.
+ Parameters
+ merchant_token (string) - Merchant Token
+ Response 200 (application/json)
{
"success": true,
"time": 1536783002,
"message": "Request performed successfully.",
"code": 0,
"content": [
{
}
}
# Customer data Update [/v4.3/customer_data_update{?merchant_token,key,value}]
## Customer data Update [GET]
Update certain fields of your Yourpay saved customer data. This includes the fields:
Company Name (cvr_name), address (address), phone (phone), postal (postal), city (city), country (country), logo (url for logo), WSDLcaptureCode (integrationcode)
+ Parameters
+ merchant_token (string) - Merchant Token
+ key (string) - Field to update
+ value (string) - New value for field
+ Response 200 (application/json)
{
"success": true,
"time": 1536783002,
"message": "Request performed successfully.",
"code": 0,
"content": [
{
}
}
# Merchant Account User list [/v4.3/customer_user_list{?merchant_token,user_id}]
## User list [GET]
List all users connected to Merchant Account
+ Parameters
+ merchant_token (string) - Merchant Token
+ user_id (int) - ID of the user requesting the list
+ Response 200 (application/json)
{
"success": true,
"time": 1536783002,
"message": "Request performed successfully.",
"code": 0,
"content": [
{
}
}
# Create User for Merchant Account [/v4.3/customer_user_create{?merchant_token,name,email,password}]
## Create User for Merchant Account [GET]
Create user account for specified merchant account
+ Parameters
+ merchant_token (string) - Merchant Token
+ name (string) - Real name of user
+ email (string) - Email of user
+ password (string) - Password for user
+ Response 200 (application/json)
{
"success": true,
"time": 1536783002,
"message": "Request performed successfully.",
"code": 0,
"content": [
{
}
}
# Delete Merchant User Account [/v4.3/customer_user_delete{?merchant_token,user_id,update_user_id}]
## Delete Merchant User Account [GET]
Delete users access
+ Parameters
+ merchant_token (string) - Merchant Token
+ user_id (int) - User ID provided during login
+ update_user_id (int) - User ID you wish to update
+ Response 200 (application/json)
{
"success": true,
"time": 1536783002,
"message": "Request performed successfully.",
"code": 0,
"content": [
{
}
}
# Customer domain count [/v4.3/customer_domain_count{?merchant_token}]
## Customer data Update [GET]
Retrive a count of all agreements registered a child to a certain account.
+ Parameters
+ merchant_token (string) - Merchant Token
+ Response 200 (application/json)
{
"success": true,
"time": 1536783002,
"message": "Request performed successfully.",
"code": 0,
"content": [
{
}
}
# Customer domain create [/v4.3/customer_domain_create{?merchant_token,website,owner,email}]
## Customer domain create [GET]
Retrive a count of all agreements registered a child to a certain account.
+ Parameters
+ merchant_token (string) - Merchant Token
+ website (string) - URL for the application
+ owner (string) - Domain owner / contact person
+ email (string) - Domain e-mail /contact e-mail
+ Response 200 (application/json)
{
"success": true,
"time": 1536783002,
"message": "Request performed successfully.",
"code": 0,
"content": [
{
}
}
# Customer domain hierachy [/v4.3/customer_domain_hierachy{?merchant_token}]
## Customer domain hierachy [GET]
Retrive full hierachy of account and child account at your Merchant Account
+ Parameters
+ merchant_token (string) - Merchant Token
+ Response 200 (application/json)
{
"success": true,
"time": 1536783002,
"message": "Request performed successfully.",
"code": 0,
"content": [
{
}
}
# Customer domain list [/v4.3/customer_domain_list{?merchant_token}]
## Customer domain list [GET]
Retrive full list child account
+ Parameters
+ merchant_token (string) - Merchant Token
+ Response 200 (application/json)
{
"success": true,
"time": 1536783002,
"message": "Request performed successfully.",
"code": 0,
"content": [
{
}
}
# Customer language update [/v4.3/customer_language_update{?merchant_token,language_code,user_id}]
## Customer language update [GET]
Change which language is shown at the Admininstration account at Yourpay
+ Parameters
+ merchant_token (string) - Merchant Token
+ language_code (enum[string]) - Language choosen for this user account
+ Members
+ `da-dk`
+ `en-gb`
+ `sv-se`
+ `fi-fi`
+ `no-nb`
+ `de-de`
+ `es-es`
+ `fr-fr`
+ user_id (int) - User ID provided during login
+ Response 200 (application/json)
{
"success": true,
"time": 1536783002,
"message": "Request performed successfully.",
"code": 0,
"content": [
{
}
}
# Merchant User Access update [/v4.3/customer_user_access_update{?merchant_token,user_id,update_user_id,access_rights}]
## Merchant User Access update [GET]
Update users access rights
+ Parameters
+ merchant_token (string) - Merchant Token
+ user_id (int) - User ID provided during login
+ update_user_id (int) - User ID you wish to update
+ access_rights (string) - Access rights for the user, comma-seperated
+ Response 200 (application/json)
{
"success": true,
"time": 1536783002,
"message": "Request performed successfully.",
"code": 0,
"content": [
{
}
}
# Customer change password [/v4.3/customer_password_change{?merchant_token,current,password}]
## Customer change password [GET]
Change account password when you are aware of the current password
+ Parameters
+ merchant_token (string) - Merchant Token
+ current (string) - Current password
+ password (string) - New password
+ Response 200 (application/json)
{
"success": true,
"time": 1536783002,
"message": "Request performed successfully.",
"code": 0,
"content": [
{
}
}
# Customer email password request [/v4.3/customer_password_request{?email}]
## Customer email password request [GET]
Change account password, when you are not aware of the current password.
You will receive an e-mail with a reset-password link attached
+ Parameters
+ email (string) - Email registered at Yourpay
+ Response 200 (application/json)
{
"success": true,
"time": 1536783002,
"message": "Request performed successfully.",
"code": 0,
"content": [
{
}
}
# Customer email reset [/v4.3/customer_password_reset{?token,password}]
## Customer email reset [GET]
Reset password based on token from received e-mail
+ Parameters
+ token (string) - Password token sent in e-mail
+ password (string) - New password for the user account
+ Response 200 (application/json)
{
"success": true,
"time": 1536783002,
"message": "Request performed successfully.",
"code": 0,
"content": [
{
}
}
# Generate token [/v4.3/generate_token{?merchant_token,MerchantNumber,ccrg,ShopPlatform,amount,currency,cartid,accepturl,callbackurl,language,customername,time,use3ds}]
## Generate token [GET]
Generate Payment Token, used for forwarding towards Yourpays Payment Window
+ Parameters
+ merchant_token (string) - Merchant Token
+ MerchantNumber (int) - MerchantID of transaction owner
+ ccrg (int,optional) - Rebilling parameter
+ ShopPlatform (string) - Which Shopping platform is being used to perform the payment
+ amount (int) - Amount in lowest currency
+ currency (string) - DKK,SEK,EUR,USD,NOK,GBP etc.
+ cartid (string,optional) - Your order ID
+ accepturl (string) - AcceptURL to where we should redirect the user after completed payment
+ callbackurl (string,optional) - CallbackURL for our IPN
+ language (string,optional) - da-dk,en-gb,sv-se,nb-no
+ customername (string,optional) - Name of consumer
+ time (string,optional) - Unixtimestamp
+ use3ds (int, optional) - 1= true, 0 = false
+ Response 200 (application/json)
{
"success": true,
"time": 1536783002,
"message": "Request performed successfully.",
"code": 0,
"content": [
{
}
}
# Generate token, multiple Receipients [/v4.3/generate_token{?merchant_token,MerchantNumber,ccrg,ShopPlatform,amount,currency,cartid,accepturl,callbackurl,langauge,customername,time,chainedpayment,recipients,merchant2,merchant3,merchant4,amount2,amount3,amount4}]
## Generate token, multiple Receipients [GET]
Split your Yourpay transaction up till multiple receipients. There is not maximum amount of receivers.
+ Parameters
+ merchant_token (string) - Merchant Token
+ MerchantNumber (int) - MerchantID of transaction owner
+ ccrg (int,optional) - Rebilling parameter
+ ShopPlatform (string) - Which Shopping platform is being used to perform the payment
+ amount (int) - Total amount accross all submerchants in lowest currency
+ currency (string) - DKK,SEK,EUR,USD,NOK,GBP etc.
+ cartid (string,optional) - Your order ID
+ accepturl (string) - AcceptURL to where we should redirect the user after completed payment
+ callbackurl (string) - CallbackURL for our IPN
+ langauge (string,optional) - da-dk,en-gb,sv-se,nb-no
+ customername (string,optional) - Name of consumer
+ time (string,optional) - Unixtimestamp
+ chainedpayment (int) - Activating Yourpays ChainedPayment model, Value = 1
+ recipients (int) - Amount of Merchants that should receive a part of the payment
+ merchant2 (int) - MerchantID for 2nd
+ merchant3 (int) - MerchantID for 3rd
+ merchant4 (int) - MerchantID for 4th
+ amount2 (int) - Amount for Merchant 2 in lowest currency
+ amount3 (int) - Amount for Merchant 3 in lowest currency
+ amount4 (int) - Amount for Merchant 4 in lowest currency
+ Response 200 (application/json)
{
"success": true,
"time": 1536783002,
"message": "Request performed successfully.",
"code": 0,
"content": [
{
}
}
# Generate token for Terminals [/v4.3/generate_token_terminal{?merchant_token,serialno,ShopPlatform,amount,currency,cartid,callbackurl,langauge,time}]
## Generate token Terminals [GET]
Generate Payment Token, used for forwarding towards Yourpays Payment Window
+ Parameters
+ merchant_token (string) - Merchant Token
+ serialno (int) - Serial number of terminal device
+ ShopPlatform (string) - POS Application being used for the payment
+ amount (int) - Amount in lowest currency
+ currency (string) - DKK,SEK,EUR,USD,NOK,GBP etc.
+ cartid (string,optional) - Your order ID
+ callbackurl (string) - CallbackURL for our IPN
+ langauge (string,optional) - da-dk,en-gb,sv-se,nb-no
+ time (string,optional) - Unixtimestamp
+ Response 200 (application/json)
{
"success": true,
"time": 1536783002,
"message": "Request performed successfully.",
"code": 0,
"content": [
{
}
}
# Chained Payment [/v4.3/generate_token{?merchant_token,MerchantNumber,ccrg,ShopPlatform,amount,currency,cartid,accepturl,langauge,customername,time,chainedpayment,chainedamount,chainedMerchantNumber,chainedamountThree,chainedMerchantNumberThree}]
## Chained Payment [GET]
Generate Chained Payment Token, used for forwarding towards Yourpays Payment Window
+ Parameters
+ merchant_token (string) - Merchant Token
+ MerchantNumber (int) - MerchantID of transaction owner
+ ccrg (int,optional) - Rebilling parameter
+ ShopPlatform (string) - Which Shopping platform is being used to perform the payment
+ amount (int) - Amount in lowest currency
+ currency (string) - DKK,SEK,EUR,USD,NOK,GBP etc.
+ cartid (string,optional) - Your order ID
+ accepturl (string) - AcceptURL to where we should redirect the user after completed payment
+ langauge (string,optional) - da-dk,en-gb,sv-se,nb-no
+ customername (string,optional) - Name of consumer
+ time (string,optional) - Unixtimestamp
+ chainedpayment (int) - Mandatory, set as 1
+ chainedamount (int) - Amount for second receiver
+ chainedMerchantNumber (string) - MerchantID for second receiver
+ chainedamountThree (int,optional) - Amount for third receiver
+ chainedMerchantNumberThree (int,optional) - MerchantID for third receiver
+ Response 200 (application/json)
{
"success": true,
"time": 1536783002,
"message": "Request performed successfully.",
"code": 0,
"content": [
{
}
}
# KYC Status [/v4.3/KYC_status{?merchant_token}]
## KYC Status [POST]
Gives you status on, how long a merchant is in KYC flow
1 = Bank and id
2 = Compliance
3 = Visa/MasterCard
4 = production ID
5 = ready
+ Parameters
+ merchant_token (string) - Merchant Token
+ Response 200 (application/json)
{
"succes": boolean,
"time": int,
"message": string,
"code": int,
"content": int
}
# Important notifications [/v4.3/important_notifications{?merchant_token}]
## Important notifications [GET]
Important notifications from Yourpay
+ Parameters
+ merchant_token (string) - Merchant Token
+ Response 200 (application/json)
{
"success": boolean,
"time": int,
"message": string,
"code": int,
"content": {
"id": int,
"title": string,
"content": string
}
}
# Important notifications, read [/v4.3/important_notifications{?merchant_token,id}]
## Important notifications, read [GET]
Mark important notifications from Yourpay as read
+ Parameters
+ merchant_token (string) - Merchant Token
+ id (int) - Notification ID
+ Response 200 (application/json)
{
"success": true,
"time": 1536783002,
"message": "Request performed successfully.",
"code": 0,
"content": {}
}
# Language list [/v4.3/language_list]
## Language list [GET]
Languages available at Yourpays administrationpanel
+ Response 200 (application/json)
{
"success": true,
"time": 1536783002,
"message": "Request performed successfully.",
"code": 0,
"content": [
{
}
}
# Login click link [/v4.3/login_clicklink{?clicklink}]
## Login click link [GET]
One time login mechanism to access a merchant account
+ Parameters
+ clicklink (string) - Unique Click link
+ Response 200 (application/json)
{
"success": boolean,
"time": int,
"message": string,
"code": int,
"content": {}
}
# Login merchant token [/v4.3/login_merchant_token{?merchant_token}]
## Login merchant token [GET]
Login using the Merchant Token
+ Parameters
+ merchant_token (string) - Merchant Token
+ Response 200 (application/json)
{
"success": boolean,
"time": int,
"message": string,
"code": int,
"content": {}
}
# Login [/v4.3/login_password{?username,password}]
## Login Username/Password [GET]
Login using username and password
+ Parameters
+ username (string) - Username
+ password (string) - Password
+ Response 200 (application/json)
{
"success": boolean,
"time": int,
"message": string,
"code": int,
"content": {}
}
# Login, Multiple Accounts [/v4.3/login{?username,password}]
## Login for multiple accounts [GET]
Gain access to all your Yourpay accounts, through our new shared Login Mechanism
+ Parameters
+ username (string) - Username
+ password (string) - Password
+ Response 200 (application/json)
{
"success": boolean,
"time": int,
"message": string,
"code": int,
"content": {}
}
# Payment Actions [/v4.3/payment_action{?merchant_token,id,amount}]
## Capture payment [GET]
Use the Payment ID and a positive amount to capture a payment
+ Parameters
+ merchant_token (string) - Merchant Token
+ id (int) - Payment ID
+ amount (int) - Amount to capture
+ Response 200 (application/json)
{
"success": boolean,
"time": int,
"message": string,
"code": int,
"content": {}
}
## Refund payment [GET]
Use the Payment ID and a negative amount to refund a payment
+ Parameters
+ merchant_token (string) - Merchant Token
+ id (int) - Payment ID
+ amount (int) - Negative amount for refund
+ Response 200 (application/json)
{
"success": boolean,
"time": int,
"message": string,
"code": int,
"content": {}
}
# Payment Action List [/v4.3/payment_action_list{?merchant_token,action}]
## Payment Action List [GET]
Retrieve a list of actions performed on a specific payment, defined by action request.
+ Parameters
+ merchant_token (string) - Merchant Token
+ action (string) - capture,refund,released
+ Response 200 (application/json)
{
"success": boolean,
"time": int,
"message": string,
"code": int,
"content": {}
}
# Payment mass actions [/v4.3/payment_action_mass{?merchant_token,id,action}]
## Payment mass actions [GET]
Retrieve a list of actions performed on a specific payment, defined by action request.
+ Parameters
+ merchant_token (string) - Merchant Token
+ action (string) - capture
+ id (string) - Ids to perform mass capture request on
+ Response 200 (application/json)
{
"success": true,
"time": 1536783002,
"message": "Request performed successfully.",
"code": 0,
"content": [
{
}
}
# Payment Count [/v4.3/payment_count{?merchant_token,listtype,test}]
## Payment Count [GET]
Count captured payments, refunded payments and deleted/released payments
+ Parameters
+ merchant_token (string) - Merchant Token
+ listtype (int) - Listtypes, 1 = capture, 2 = delete, 3 = refund
+ test (int,optional) - Remove all test transactions
+ Response 200 (application/json)
{
"success": true,
"time": 1536783002,
"message": "Request performed successfully.",
"code": 0,
"content": [
{
}
}
# Payment data [/v4.3/payment_data{?merchant_token,id}]
## Payment data [GET]
Gain a full copy of all data related to a specific payment
+ Parameters
+ merchant_token (string) - Merchant Token
+ id (int) - Payment ID
+ Response 200 (application/json)
{
"success": true,
"time": 1536783002,
"message": "Request performed successfully.",
"code": 0,
"content": [
{
}
}
# Payment link [/v4.3/payment_link{?merchant_token,mail_body,flag_fee,flag_sms,flag_plain,sms_sender,sms_receiver,mail_subject,alternate_orderid,customer_name,plain_link,link_text}]
## Payment link [GET]
Gain a full copy of all data related to a specific payment
+ Parameters
+ merchant_token (string) - Merchant Token
+ flag_fee (bool) - Flag if the receiver should pay the transaction fee
+ flag_sms (bool) - Flag if it should be sent as a text message
+ flag_plain (bool) - Flag if it should be sent as plain text
+ sms_sender (string) - SMS sender
+ sms_receiver (string) - receipient - mobileno
+ mail_subject (string) - Mail subject
+ mail_body (string) - Body of payment link being sent
+ alternate_orderid (string) - Alternative order ID - if two different is being used
+ customer_name (string) - Customer name
+ plain_link (bool) - If the link should be sent as plain text or masked
+ link_text (string) - If link is masked - the link text
+ Response 200 (application/json)
{
"success": true,
"time": 1536783002,
"message": "Request performed successfully.",
"code": 0,
"content": [
{
}
}
# Payment link count [/v4.3/payment_link_count{?merchant_token}]
## Payment link count [GET]
Retrive amount of payment link requests performed.
+ Parameters
+ merchant_token (string) - Merchant Token
+ Response 200 (application/json)
[
{
"success": true,
"time": 1536782784,
"message": "Request performed successfully.",
"code": 0,
"content": {
"count": "0"
}
}
]
# Payment link data [/v4.3/payment_link_data{?merchant_token,int}]
## Payment link data [GET]
Gain a full copy of all data related to a specific payment link
+ Parameters
+ merchant_token (string) - Merchant Token
+ int (int) - Identifier from Payment list
+ Response 200 (application/json)
[
{
"success": true,
"time": 1536782784,
"message": "Request performed successfully.",
"code": 0,
"content": {
"count": "0"
}
}
]
# Payment link list [/v4.3/payment_link_list{?merchant_token,start,limit}]
## Payment link list [GET]
Retrive amount of payment link requests performed.
+ Parameters
+ merchant_token (string) - Merchant Token
+ start (int,optional) - Start
+ limit (int,optional) - limiter
+ Response 200 (application/json)
[
{
"success": true,
"time": 1536782784,
"message": "Request performed successfully.",
"code": 0,
"content": {
"count": "0"
}
}
]
# Payment link paid [/v4.3/payment_link_paid{?MerchantNumber,id}]
## Payment link paid [GET]
Mark a Payment Link as fully paid
+ Parameters
+ MerchantNumber (int) - Merchant Number
+ id (int) - Payment link ID
+ Response 200 (application/json)
[
{
"success": true,
"time": 1536782784,
"message": "Request performed successfully.",
"code": 0,
"content": {
"count": "0"
}
}
]
# Payment link Template [/v4.3/payment_link_template{?merchant_token,id,state,language,title,sms_sender,email_sender,link_text,consumer_fee,message_title,message_content}]
## Payment link Template [POST]
Update your Payment link template, used in Yourpay Admin for sending out mass payment requests to your customers with unpaid orders.
+ Parameters
+ merchant_token (string) - Merchant Token
+ id (int,optional) - Required if state is UPDATE or DELETE
+ state (enum[string]) - Template action to be performed
+ Members
+ `INSERT`
+ `UPDATE`
+ `DELETE`
+ language (enum[string]) - Template language to be used
+ Members
+ `da-dk`
+ `en-gb`
+ `sv-se`
+ `fi-fi`
+ `no-nb`
+ `de-de`
+ `es-es`
+ `fr-fr`
+ title (string) - Template Title, NOT title of message
+ sms_sender (string) - Can be both text and numeric
+ email_sender (string) - E-mail set as from and reply-to
+ link_text (string) - Text to be written in the e-mail for the user
+ consumer_fee (bool) - Payee of the transaction fee, consumer or merchant
+ message_title (string) - Title of outbound communication
+ message_content (string) - Full text with replacers
+ Response 200 (application/json)
{
"success": true,
"time": 1536783002,
"message": "Request performed successfully.",
"code": 0,
"content": [
{
}
}
# Payment link template list [/v4.3/payment_link_template_list{?merchant_token,language}]
## Payment link template list [GET]
Retrive a list of all payment link templates on the merchant account.
+ Parameters
+ merchant_token (string) - Merchant Token
+ language (enum[string]) - Template language to be used
+ Members
+ `da-dk`
+ `en-gb`
+ `sv-se`
+ `fi-fi`
+ `no-nb`
+ `de-de`
+ `es-es`
+ `fr-fr`
+ Response 200 (application/json)
[
{
"success": true,
"time": 1536782784,
"message": "Request performed successfully.",
"code": 0,
"content": {
"count": "0"
}
}
]
# Payment list [/v4.3/payment_list{?merchant_token,start,limit,listtype,test}]
## Payment list [GET]
Payment list containing all payments for account
+ Parameters
+ merchant_token (string) - Merchant Token
+ listtype (int) - Listtypes, 1 = capture, 2 = delete, 3 = refund
+ start (int,optional) - Limiter start
+ limit (int,optional) - Limit results per request
+ test (int,optional) - Remove all test transactions
+ Response 200 (application/json)
[
{
"success": true,
"time": 1536782784,
"message": "Request performed successfully.",
"code": 0,
"content": {
"count": "0"
}
}
]
# Payment release [/v4.3/payment_release{?merchant_token,id}]
## Payment release [GET]
Release the reservation from a credit- or debitcard.
+ Parameters
+ merchant_token (string) - Merchant Token
+ id (int) - PaymentID
+ Response 200 (application/json)
[
{
"success": true,
"time": 1536782784,
"message": "Request performed successfully.",
"code": 0,
"content": {
"count": "0"
}
}
]
# Payment search [/v4.3/payment_search{?merchant_token,search,type,start,limit}]
## Payment search [GET]
Search through Yourpay for a specific payment
+ Parameters
+ merchant_token (string) - Merchant Token
+ search (string) - Identifier to search for
+ type (string) - Which parameter to search for: payment_id, transaction_id, cardholder or orderid
+ start (int,optional) - Limiter start
+ limit (int,optional) - Limit results per request
+ Response 200 (application/json)
[
{
"success": true,
"time": 1536782784,
"message": "Request performed successfully.",
"code": 0,
"content": {
"count": "0"
}
}
]
# Payment search [/v4.3/payment_search_count{?merchant_token,search,type}]
## Payment Search count [GET]
Retrive sum of search results found.
+ Parameters
+ merchant_token (string) - Merchant Token
+ search (string) - Search container
+ type (int) - 1 = Payment ID, 2 = Transaction ID, 3 = Cardholder
+ Response 200 (application/json)
[
{
"success": true,
"time": 1536782784,
"message": "Request performed successfully.",
"code": 0,
"content": {
"count": "0"
}
}
]
# Payout count [/v4.3/payout_count{?merchant_token}]
## Payout count [GET]
Retrive sum of payouts found found.
+ Parameters
+ merchant_token (string) - Merchant Token
+ Response 200 (application/json)
[
{
"success": true,
"time": 1536782784,
"message": "Request performed successfully.",
"code": 0,
"content": {
"count": "0"
}
}
]
# Payout list [/v4.3/payout_list{?merchant_token}]
## Payout list [GET]
Containing a list of all current and ongoing payments
+ Parameters
+ merchant_token (string) - Merchant Token
+ Response 200 (application/json)
[
{
"success": true,
"time": 1536782784,
"message": "Request performed successfully.",
"code": 0,
"content": {
"count": "0"
}
}
]
# Payout data [/v4.3/payout_data{?merchant_token,id}]
## Payout data [GET]
Payout data containing a specification of transactions on a specified day
+ Parameters
+ merchant_token (string) - Merchant Token
+ id (int) - Date ID
+ Response 200 (application/json)
[
{
"success": true,
"time": 1536782784,
"message": "Request performed successfully.",
"code": 0,
"content": {
"count": "0"
}
}
]
# Payout Release [/v4.3/payout_release{?merchant_token,user_id,id}]
## Payout Release Today [GET]
Do you want to have your settlement release beforehand? Use our Release API, and have the funds released today, for an additional fee.
+ Parameters
+ merchant_token (string) - Merchant Token
+ user_id (int) - User ID
+ id (int) - Payout ID
+ Response 200 (application/json)
[
{
"success": true,
"time": 1536782784,
"message": "Request performed successfully.",
"code": 0,
"content": {
"count": "0"
}
}
]
# Submit CVR [/v4.3/submit_cvr{?merchant_token,cvr,company,website}]
## Submit CVR [GET]
Append CVR-number, Company name and Website
+ Parameters
+ merchant_token (string) - Merchant Token
+ cvr (string) - VAT number for Merchant
+ company (string) - Company name
+ website (string) - Website
+ Response 200 (application/json)
[
{
"success": true,
"time": 1536782784,
"message": "Request performed successfully.",
"code": 0,
"content": {
"count": "0"
}
}
]
# Submit Owners [/v4.3/submit_owners{?merchant_token}]
## Submit Owners [GET]
When all data have been added, use this endpoint to verify that you claims to have completed the required data.
+ Parameters
+ merchant_token (string) - Merchant Token
+ Response 200 (application/json)
[
{
"success": true,
"time": 1536782784,
"message": "Request performed successfully.",
"code": 0,
"content": {
"count": "0"
}
}
]
# Submit Owner [/v4.3/submit_owner{?merchant_token,name,share}]
## Submit Owner [GET]
Update company owners, the owners appended here will be requested their documentation.
It is required by Yourpay all owners above 17.5% is listed.
+ Parameters
+ merchant_token (string) - Merchant Token
+ name (string) - Name of owner
+ share (int) - Rounded numeric value of owner percentage
+ Response 200 (application/json)
[
{
"success": true,
"time": 1536782784,
"message": "Request performed successfully.",
"code": 0,
"content": {
"count": "0"
}
}
]
# Submit bank details [/v4.3/submit_bank{?merchant_token,bank,registration_number,account_number,iban,bic_code,currency,settlement_currency}]
## Submit bank details [GET]
Insert or update your banking details at yourpay
+ Parameters
+ merchant_token (string) - Merchant Token
+ bank (string,optional) - Name of bank
+ registration_number (int,optional) - 4 digit bank registration number (Only Denmark)
+ account_number (int,optional) - 6-10 digit bank account number (Only Denmark)
+ iban (string,optional) - IBAN credentials (International accounts)
+ bic_code (string,optional) - SWIFT (International accounts)
+ currency (int,optional) - 3 digit currency code, ISO 4217
+ settlement_currency (int,optional) - 3 digit currency code, ISO 4217
+ Response 200 (application/json)
[
{
"success": true,
"time": 1536782784,
"message": "Request performed successfully.",
"code": 0,
"content": {
"count": "0"
}
}
]
# Rebilling CCRG [/v4.3/subscriptions_ccrg{?merchant_token,amount,currency,ccrg,orderid,recipients,merchant2,merchant3,merchant4,amount2,amount3,amount4}]
## Rebilling [GET]
Rebilling in V4.3
+ Parameters
+ merchant_token (string) - Merchant Token
+ amount (int) - Amount for capture. 100 = 1, 1000 = 10
+ currency (int) - ISO 4217, 208 for DKK, 978 for EUR
+ ccrg (string) - Unique Card Code, 4 digits (dot) 4 digits (dot) 4 digits
+ orderid (string) - Order ID
+ recipients (int) - Amount of merchants funded through this transaction
+ merchant2 (int) - MerchantID for Merchant 2
+ merchant3 (int) - MerchantID for Merchant 3
+ merchant4 (int) - MerchantID for Merchant 4
+ amount2 (int) - Amount being sent to Merchant 2 in lowest currency
+ amount3 (int) - Amount being sent to Merchant 3 in lowest currency
+ amount4 (int) - Amount being sent to Merchant 4 in lowest currency
+ Response 200 (application/json)
[
{
"success": true,
"time": 1536782784,
"message": "Request performed successfully.",
"code": 0,
"content": {
"count": "0"
}
}
]
# V4 Rebilling [/v4/rebilling_customer{?subscriptioncode,MerchantID,amount,cartid,manual_capture,alternative_currency}]
## V4 Rebilling [POST]
Rebilling in V4
+ Parameters
+ MerchantID (int) - Merchant identifier
+ subscriptioncode (string) - CCRG code from Hosted Payment Window or Process Payment
+ amount (int) - Amount for capture. 100 = 1, 1000 = 10
+ cartid (string,optional) - Order ID
+ manual_capture (int,optional) - If you wish to process this transaction with a manual capture request
+ alternative_currency (string,optional) - 208,978,578 | ISO 4217 etc.
+ Response 200 (application/json)
[
{
"success": true,
"time": 1536782784,
"message": "Request performed successfully.",
"code": 0,
"content": {
"count": "0"
}
}
]
# V4 Rebilling, Multiple receipients [/v4/rebilling_customer{?subscriptioncode,MerchantID,amount,cartid,manual_capture,alternative_currency,recipients,merchant2,merchant3,merchant4,amount2,amount3,amount4}]
## V4 Rebilling [POST]
Split your Yourpay rebilling transaction up till multiple receipients. There is not maximum amount of receivers.
+ Parameters
+ MerchantID (int) - Merchant identifier for global merchant, who owns the rebilling transaction
+ subscriptioncode (string) - CCRG code from Hosted Payment Window or Process Payment
+ amount (int) - Amount for capture. 100 = 1, 1000 = 10
+ cartid (string,optional) - Order ID
+ manual_capture (int,optional) - If you wish to process this transaction with a manual capture request
+ alternative_currency (string,optional) - 208,978,578 | ISO 4217 etc.
+ recipients (int) - Amount of merchants funded through this transaction
+ merchant2 (int) - MerchantID for Merchant 2
+ merchant3 (int) - MerchantID for Merchant 3
+ merchant4 (int) - MerchantID for Merchant 4
+ amount2 (int) - Amount being sent to Merchant 2 in lowest currency
+ amount3 (int) - Amount being sent to Merchant 3 in lowest currency
+ amount4 (int) - Amount being sent to Merchant 4 in lowest currency
+ Response 200 (application/json)
[
{
"success": true,
"time": 1536782784,
"message": "Request performed successfully.",
"code": 0,
"content": {
"count": "0"
}
}
]
# V4 Stop Rebilling [/v4/rebilling_stop{?subscriptioncode,token}]
## V4 Stop Rebilling option [GET]
Disable the Rebilling method for a specified CCRG-key defined in Hosted Payment Window or Process Payment
+ Parameters
+ subscriptioncode (string) - CCRG code from Hosted Payment Window or Process Payment
+ token (string) - Merchant Token
+ Response 200 (application/json)
[
{
"result":1,
"responsecode":1,
"textresponse":"Payment method disabled."
}
]
# Terminal Transaction response [/v4.3/payment_pos_external{?serial,uuid}]
## Terminal Response [GET]
Receive the posting details of the transaction you are handling right now
+ Parameters
+ serial (int) - Terminal Serial No
+ uuid (string) - Unique identifier from the Terminal. If unsecure use the identifier "A0"
+ Response 200 (application/json)
[
{
"success": true,
"time": 1561467979,
"message": "Request performed successfully.",
"code": 0,
"content": {
"pending": "true",
"token": "",
"transid": "0",
"amount": "100",
"callbackurl": "https://www.yourpay.io",
"cartid": "100",
"currency": "DKK",
"langauge": "da-dk",
"merchant_token": "",
"serialno": "",
"ShopPlatform": "Own",
"time": "0",
"state": "0"
}
}
]
# Merchant Invoices [/v4.3/customer_subscriptions{?merchant_token,user_id}]
## Invoices [GET]
Gain a full list of invoices under this account.
+ Parameters
+ merchant_token (string)
+ user_id (int) - User ID for the requesting user
+ Response 200 (application/json)
[
{
success: true,
time: 0,
message: "Request performed successfully.",
code: 0,
content: {
}
}
]
# Merchant Invoice [/v4.3/customer_subscriptions_id{?merchant_token,user_id,id}]
## Invoice [GET]
Get details of a specific invoice
+ Parameters
+ merchant_token (string)
+ user_id (int) - User ID for the requesting user
+ id (int) - Invoice ID
+ Response 200 (application/json)
[
{
success: true,
time: 0,
message: "Request performed successfully.",
code: 0,
content: {
}
}
]
# V4 Create Merchant [/v4/create_merchant{?CompanyVAT,CompanyName,CompanyDomain,CompanyAddress,CompanyPostal,CompanyCity,CompanyPhone,CompanyShop,CompanyDetails,MerchantComments,merchantidCombined,PersonalEmail,PersonalName,psp,CompanyIntegrationKey,client_type}]
## V4 Create Merchant [POST]
Create new Yourpay Merchant
+ Parameters
+ CompanyVAT (string) - VAT number of business. For Danish please write the number from CVR.dk, for international businesses please add the country code in front
+ CompanyName (string) - Company Name
+ CompanyDomain (string,optional) - Company Domain Name for Webshops
+ CompanyAddress (String,optional) - Address of Merchant
+ CompanyPostal (int,optional) - Postcode for Company
+ CompanyCity (String,optional) - City of Merchant
+ CompanyPhone (int,optional) - Phone number for Merchant
+ CompanyShop (String,optional) - Shoppingplatform used by Merchant
+ CompanyDetails (String,optional) - Company Relevant Details
+ MerchantComments (String,optional) - Details relevant for the Merchant onboarding
+ merchantidCombined (String,optional) - Append the Test-MerchantID from your Merchant Heriracy, if this merchant is a child-account to another
+ PersonalEmail (String) - E-mail details for contact
+ PersonalName (String) - Contact name at Merchant
+ psp (int,optional) - Yourpay Partner ID
+ CompanyIntegrationKey (int,optional) - Unique IntegrationKey Method used for specific Partners
+ client_type (int,optional) - If 1 then POS account
+ Response 200 (application/json)
[
{
"result":1,
"responsecode":1,
"textresponse":"Payment method disabled."
}
]
# V4 Upload documentation [/v4/documentation_submit_person_data{?merchant_token,id,documenturl,doctype,documentextension}]
## V4 Upload Owner documentation [POST]
Create new Yourpay Merchant
+ Parameters
+ merchant_token (string) - Merchant Token
+ id (int) - Document identifier from Submit Owner
+ documenturl (string) - Public URL to where we can extract the file
+ doctype (int) - 0 for Passport/Driving license, 1 for Social Security Card
+ documentextension (string) - JPG/PDF/PNG
+ Response 200 (application/json)
[
{
"result":1,
"responsecode":1,
"textresponse":"Payment method disabled."
}
]
# Payment Codes [/v4.3/payment_codes]
## Payment Codes [POST]
Full list of information relevant for the payments, including but not limited Card ID, Payment Method ID etc.
+ Response 200 (application/json)
[
{
"result":1,
"responsecode":1,
"textresponse":"Payment method disabled."
}
]
# Upload Chargeback documentation [/v4.3/chargeback_upload{merchant_token,type,id,url,user_id}]
## Invoices [GET]
Gain a full list of invoices under this account.
+ Parameters
+ merchant_token (string)
+ id (int) - ID of the chargeback
+ url (string) - URL for where the documentation can be copied from
+ user_id (int) - User ID for the uploading user
+ type (enum[string]) - Template language to be used
+ Members
+ `order_summary_file`
+ `invoice_file`
+ `track_and_trace_file`
+ `customer_dialogue_file`
+ Response 200 (application/json)
[
{
success: true,
time: 0,
message: "Request performed successfully.",
code: 0,
content: {
}
}
]
# Issuing: Funding group creation [/v4.3/issuing_card_creation{merchant_token,currency}]
## Activate Funding group [POST]
Use Yourpays card issuing service, by activating a funding group.
+ Parameters
+ merchant_token (string)
+ currency (int) - ISO 4217, 208 = DKK
+ Response 200 (application/json)
[
{
success: true,
time: 0,
message: "Request performed successfully.",
code: 0,
content: {
funding_id: "1",
funding_validator: "ABC123"
}
}
]
# Issuing: Funding group data [/v4.3/issuing_funding_group_data{merchant_token,funding_group_id,funding_validator}]
## Funding group data [POST]
All funding is based upon a in-the-middle storage containing the funds before being sent to the isseud card. This enables the oppotunity for holding a group-controlled funding, that can be sent directly to a specific card.
+ Parameters
+ merchant_token (string)
+ funding_group_id (int) - Funding ID sent from funding creation
+ funding_validator (string) - Funding validator sent from card creation
+ Response 200 (application/json)
[
{
success: true,
time: 0,
message: "Request performed successfully.",
code: 0,
content: {
card_trunked: "",
card_status: "0",
card_type: "debit",
card_scheme: "MASTER",
card_activation: "0",
card_deactivation: "0",
card_funds: "0",
card_currency: "208"
}
}
]
# Issuing: Card creation [/v4.3/issuing_card_creation{merchant_token,funds,currency,type,scheme,card_funding}]
## Activate card [POST]
Use Yourpays card issuing service, by activating a card supported by Yourpay.
+ Parameters
+ merchant_token (string)
+ funds (int) - Funds that should be sent directly to the card upon activation
+ currency (int) - ISO 4217, 208 = DKK
+ type (string) - ENUM for debit or credit
+ scheme (string) - use the Scheme agreed with Yourpay
+ card_funding (int) - 1 for the possiblity only to use funds made available on card, while 2 gains access to all funds in the funding group
+ Response 200 (application/json)
[
{
success: true,
time: 0,
message: "Request performed successfully.",
code: 0,
content: {
cardid: "1",
cardvalidator: "ABC123"
}
}
]
# Issuing: Card deactivation [/v4.3/issuing_card_action{merchant_token,card_id,card_validator,action}]
## Card deactivation [POST]
Activate and deactivate received cards. Action should be set accordingly. "activate" and "deactivate".
+ Parameters
+ merchant_token (string)
+ card_id (int) - Card ID sent from card creation
+ card_validator (string) - Card validator sent from card creation
+ action (string) - "activate" or "deactivate".
+ Response 200 (application/json)
[
{
success: true,
time: 0,
message: "Request performed successfully.",
code: 0,
content: {
card_trunked: "",
card_status: "0",
card_type: "debit",
card_scheme: "MASTER",
card_activation: "0",
card_deactivation: "0",
card_funds: "0",
card_currency: "208"
}
}
]
# Issuing: Card data [/v4.3/issuing_card_data{merchant_token,card_id,card_validator}]
## Card data [POST]
Gain the current data of the issued card
+ Parameters
+ merchant_token (string)
+ card_id (int) - Card ID sent from card creation
+ card_validator (string) - Card validator sent from card creation
+ Response 200 (application/json)
[
{
success: true,
time: 0,
message: "Request performed successfully.",
code: 0,
content: {
card_trunked: "",
card_status: "0",
card_type: "debit",
card_scheme: "MASTER",
card_activation: "0",
card_deactivation: "0",
card_funds: "0",
card_currency: "208"
}
}
]
# Issuing: Card load [/v4.3/issuing_card_load{merchant_token,card_id,card_validator,funding_group_id,funding_group_validator,amount}]
## Card data [POST]
Load funds from the funding group onto the card
+ Parameters
+ merchant_token (string)
+ card_id (int) - Card ID sent from card creation
+ card_validator (string) - Card validator sent from card creation
+ funding_group_id (int) - Funding ID sent from funding creation
+ funding_group_validator (string) - Funding validator sent from card creation
+ amount (int) - Amount in lowest currency
+ Response 200 (application/json)
[
{
success: true,
time: 0,
message: "Request performed successfully.",
code: 0,
content: {
card_trunked: "",
card_status: "0",
card_type: "debit",
card_scheme: "MASTER",
card_activation: "0",
card_deactivation: "0",
card_funds: "0",
card_currency: "208"
}
}
]
# Issuing: Card unload [/v4.3/issuing_card_unload{merchant_token,card_id,card_validator,funding_group_id,funding_group_validator,amount}]
## Card data [POST]
Unload funds from the card into the funding group
+ Parameters
+ merchant_token (string)
+ card_id (int) - Card ID sent from card creation
+ card_validator (string) - Card validator sent from card creation
+ funding_group_id (int) - Funding ID sent from funding creation
+ funding_group_validator (string) - Funding validator sent from card creation
+ amount (int) - Amount in lowest currency
+ Response 200 (application/json)
[
{
success: true,
time: 0,
message: "Request performed successfully.",
code: 0,
content: {
card_trunked: "",
card_status: "0",
card_type: "debit",
card_scheme: "MASTER",
card_activation: "0",
card_deactivation: "0",
card_funds: "0",
card_currency: "208"
}
}
]
# Test Payments [/v4.3/payment_remove_test{?merchant_token,user_id}]
## Remove all test payments [GET]
Remove all test payments from account
+ Parameters
+ merchant_token (string)
+ user_id (int) - User ID for the requesting user
+ Response 200 (application/json)
[
{
success: true,
time: 0,
message: "Request performed successfully.",
code: 0,
content: {
}
}
]
