Skip to content

Commit 8e5b51d

Browse files
HenrietteBossenHenrietteBossen
authored
Merge pull request #150 from MobilePayDev/revert-149-HenrietteBossen-patch-3
Revert "Update subscriptions.yaml"
2 parents 0c88288 + 9964602 commit 8e5b51d

File tree

1 file changed

+359
-0
lines changed

1 file changed

+359
-0
lines changed

‎openapi/subscriptions.yaml

+359
Original file line numberDiff line numberDiff line change
@@ -1239,6 +1239,101 @@ paths:
12391239
security:
12401240
- Bearer:
12411241
- subscriptions
1242+
/api/providers/{providerid}/agreements/{agreementid}/oneoffpayments:
1243+
post:
1244+
tags:
1245+
- Subscriptions
1246+
summary: Request one-off payment on an existing agreement.
1247+
parameters:
1248+
- name: providerid
1249+
in: path
1250+
required: true
1251+
schema:
1252+
type: string
1253+
format: uuid
1254+
- name: agreementid
1255+
in: path
1256+
required: true
1257+
schema:
1258+
type: string
1259+
format: uuid
1260+
- name: CorrelationId
1261+
in: header
1262+
description: CorrelationId used for logging
1263+
schema:
1264+
type: string
1265+
requestBody:
1266+
content:
1267+
application/json-patch+json:
1268+
schema:
1269+
$ref: '#/components/schemas/RestAPI.Models.Merchant.RequestOneOffPaymentRequest'
1270+
application/json:
1271+
schema:
1272+
$ref: '#/components/schemas/RestAPI.Models.Merchant.RequestOneOffPaymentRequest'
1273+
text/json:
1274+
schema:
1275+
$ref: '#/components/schemas/RestAPI.Models.Merchant.RequestOneOffPaymentRequest'
1276+
application/*+json:
1277+
schema:
1278+
$ref: '#/components/schemas/RestAPI.Models.Merchant.RequestOneOffPaymentRequest'
1279+
responses:
1280+
'202':
1281+
description: One off payment request accepted.
1282+
content:
1283+
text/plain:
1284+
schema:
1285+
$ref: '#/components/schemas/RestAPI.Models.Merchant.CreateOneOffPaymentResponse'
1286+
application/json:
1287+
schema:
1288+
$ref: '#/components/schemas/RestAPI.Models.Merchant.CreateOneOffPaymentResponse'
1289+
text/json:
1290+
schema:
1291+
$ref: '#/components/schemas/RestAPI.Models.Merchant.CreateOneOffPaymentResponse'
1292+
'400':
1293+
description: Something's wrong with request body.
1294+
content:
1295+
text/plain:
1296+
schema:
1297+
$ref: '#/components/schemas/RestAPI.ActionFilters.Models.Error'
1298+
application/json:
1299+
schema:
1300+
$ref: '#/components/schemas/RestAPI.ActionFilters.Models.Error'
1301+
text/json:
1302+
schema:
1303+
$ref: '#/components/schemas/RestAPI.ActionFilters.Models.Error'
1304+
'401':
1305+
description: Api key is wrong or not provided.
1306+
'404':
1307+
description: Agreement not found.
1308+
'409':
1309+
description: Request didn't meet all business requirements.
1310+
'412':
1311+
description: Request didn't meet all business requirements.
1312+
content:
1313+
text/plain:
1314+
schema:
1315+
$ref: '#/components/schemas/RestAPI.ActionFilters.Models.Error'
1316+
application/json:
1317+
schema:
1318+
$ref: '#/components/schemas/RestAPI.ActionFilters.Models.Error'
1319+
text/json:
1320+
schema:
1321+
$ref: '#/components/schemas/RestAPI.ActionFilters.Models.Error'
1322+
'500':
1323+
description: General server or application error.
1324+
content:
1325+
text/plain:
1326+
schema:
1327+
$ref: '#/components/schemas/RestAPI.ActionFilters.Models.Error'
1328+
application/json:
1329+
schema:
1330+
$ref: '#/components/schemas/RestAPI.ActionFilters.Models.Error'
1331+
text/json:
1332+
schema:
1333+
$ref: '#/components/schemas/RestAPI.ActionFilters.Models.Error'
1334+
security:
1335+
- Bearer:
1336+
- subscriptions
12421337
get:
12431338
tags:
12441339
- Subscriptions
@@ -1559,6 +1654,270 @@ paths:
15591654
security:
15601655
- Bearer:
15611656
- subscriptions
1657+
/api/providers/{providerid}/payments/{paymentid}/attachment:
1658+
get:
1659+
tags:
1660+
- Subscriptions
1661+
summary: Get payment attachment details.
1662+
parameters:
1663+
- name: providerid
1664+
in: path
1665+
required: true
1666+
schema:
1667+
type: string
1668+
format: uuid
1669+
- name: paymentid
1670+
in: path
1671+
required: true
1672+
schema:
1673+
type: string
1674+
format: uuid
1675+
- name: CorrelationId
1676+
in: header
1677+
description: CorrelationId used for logging
1678+
schema:
1679+
type: string
1680+
responses:
1681+
'200':
1682+
description: Success
1683+
content:
1684+
text/plain:
1685+
schema:
1686+
$ref: '#/components/schemas/RestAPI.Models.Payments.GetPaymentAttachmentResponse'
1687+
application/json:
1688+
schema:
1689+
$ref: '#/components/schemas/RestAPI.Models.Payments.GetPaymentAttachmentResponse'
1690+
text/json:
1691+
schema:
1692+
$ref: '#/components/schemas/RestAPI.Models.Payments.GetPaymentAttachmentResponse'
1693+
'400':
1694+
description: Something's wrong with request body.
1695+
content:
1696+
text/plain:
1697+
schema:
1698+
$ref: '#/components/schemas/RestAPI.ActionFilters.Models.Error'
1699+
application/json:
1700+
schema:
1701+
$ref: '#/components/schemas/RestAPI.ActionFilters.Models.Error'
1702+
text/json:
1703+
schema:
1704+
$ref: '#/components/schemas/RestAPI.ActionFilters.Models.Error'
1705+
'401':
1706+
description: Api key is wrong or not provided.
1707+
'403':
1708+
description: Payment doesn't belong to provider
1709+
'404':
1710+
description: Payment or attachment doesn't exists
1711+
'409':
1712+
description: Domain error response
1713+
'500':
1714+
description: General server or application error.
1715+
content:
1716+
text/plain:
1717+
schema:
1718+
$ref: '#/components/schemas/RestAPI.ActionFilters.Models.Error'
1719+
application/json:
1720+
schema:
1721+
$ref: '#/components/schemas/RestAPI.ActionFilters.Models.Error'
1722+
text/json:
1723+
schema:
1724+
$ref: '#/components/schemas/RestAPI.ActionFilters.Models.Error'
1725+
security:
1726+
- Bearer:
1727+
- subscriptions
1728+
put:
1729+
tags:
1730+
- Subscriptions
1731+
summary: Update payment attachment.
1732+
parameters:
1733+
- name: providerid
1734+
in: path
1735+
required: true
1736+
schema:
1737+
type: string
1738+
format: uuid
1739+
- name: paymentid
1740+
in: path
1741+
required: true
1742+
schema:
1743+
type: string
1744+
format: uuid
1745+
- name: CorrelationId
1746+
in: header
1747+
description: CorrelationId used for logging
1748+
schema:
1749+
type: string
1750+
requestBody:
1751+
content:
1752+
application/json-patch+json:
1753+
schema:
1754+
$ref: '#/components/schemas/RestAPI.Models.Payments.UpdatePaymentAttachmentRequest'
1755+
application/json:
1756+
schema:
1757+
$ref: '#/components/schemas/RestAPI.Models.Payments.UpdatePaymentAttachmentRequest'
1758+
text/json:
1759+
schema:
1760+
$ref: '#/components/schemas/RestAPI.Models.Payments.UpdatePaymentAttachmentRequest'
1761+
application/*+json:
1762+
schema:
1763+
$ref: '#/components/schemas/RestAPI.Models.Payments.UpdatePaymentAttachmentRequest'
1764+
responses:
1765+
'204':
1766+
description: Attachment created
1767+
'400':
1768+
description: Something's wrong with request body.
1769+
content:
1770+
text/plain:
1771+
schema:
1772+
$ref: '#/components/schemas/RestAPI.ActionFilters.Models.Error'
1773+
application/json:
1774+
schema:
1775+
$ref: '#/components/schemas/RestAPI.ActionFilters.Models.Error'
1776+
text/json:
1777+
schema:
1778+
$ref: '#/components/schemas/RestAPI.ActionFilters.Models.Error'
1779+
'401':
1780+
description: Api key is wrong or not provided.
1781+
'403':
1782+
description: Payment doesn't belong to provider
1783+
'404':
1784+
description: Payment or attachment doesn't exists
1785+
'409':
1786+
description: Domain error response
1787+
'500':
1788+
description: General server or application error.
1789+
content:
1790+
text/plain:
1791+
schema:
1792+
$ref: '#/components/schemas/RestAPI.ActionFilters.Models.Error'
1793+
application/json:
1794+
schema:
1795+
$ref: '#/components/schemas/RestAPI.ActionFilters.Models.Error'
1796+
text/json:
1797+
schema:
1798+
$ref: '#/components/schemas/RestAPI.ActionFilters.Models.Error'
1799+
security:
1800+
- Bearer:
1801+
- subscriptions
1802+
delete:
1803+
tags:
1804+
- Subscriptions
1805+
summary: Delete payment attachment.
1806+
parameters:
1807+
- name: providerid
1808+
in: path
1809+
required: true
1810+
schema:
1811+
type: string
1812+
format: uuid
1813+
- name: paymentid
1814+
in: path
1815+
required: true
1816+
schema:
1817+
type: string
1818+
format: uuid
1819+
- name: CorrelationId
1820+
in: header
1821+
description: CorrelationId used for logging
1822+
schema:
1823+
type: string
1824+
responses:
1825+
'204':
1826+
description: Payment attachment was delete
1827+
'400':
1828+
description: Something's wrong with request body.
1829+
content:
1830+
text/plain:
1831+
schema:
1832+
$ref: '#/components/schemas/RestAPI.ActionFilters.Models.Error'
1833+
application/json:
1834+
schema:
1835+
$ref: '#/components/schemas/RestAPI.ActionFilters.Models.Error'
1836+
text/json:
1837+
schema:
1838+
$ref: '#/components/schemas/RestAPI.ActionFilters.Models.Error'
1839+
'401':
1840+
description: Api key is wrong or not provided.
1841+
'403':
1842+
description: Payment doesn't belong to provider
1843+
'409':
1844+
description: Domain error response
1845+
'500':
1846+
description: General server or application error.
1847+
content:
1848+
text/plain:
1849+
schema:
1850+
$ref: '#/components/schemas/RestAPI.ActionFilters.Models.Error'
1851+
application/json:
1852+
schema:
1853+
$ref: '#/components/schemas/RestAPI.ActionFilters.Models.Error'
1854+
text/json:
1855+
schema:
1856+
$ref: '#/components/schemas/RestAPI.ActionFilters.Models.Error'
1857+
security:
1858+
- Bearer:
1859+
- subscriptions
1860+
/api/providers/{providerid}/payments/{paymentid}/attachment/pdf:
1861+
get:
1862+
tags:
1863+
- Subscriptions
1864+
summary: Get payment attachment file.
1865+
parameters:
1866+
- name: providerid
1867+
in: path
1868+
required: true
1869+
schema:
1870+
type: string
1871+
format: uuid
1872+
- name: paymentid
1873+
in: path
1874+
required: true
1875+
schema:
1876+
type: string
1877+
format: uuid
1878+
- name: CorrelationId
1879+
in: header
1880+
description: CorrelationId used for logging
1881+
schema:
1882+
type: string
1883+
responses:
1884+
'200':
1885+
description: Success
1886+
'400':
1887+
description: Something's wrong with request body.
1888+
content:
1889+
text/plain:
1890+
schema:
1891+
$ref: '#/components/schemas/RestAPI.ActionFilters.Models.Error'
1892+
application/json:
1893+
schema:
1894+
$ref: '#/components/schemas/RestAPI.ActionFilters.Models.Error'
1895+
text/json:
1896+
schema:
1897+
$ref: '#/components/schemas/RestAPI.ActionFilters.Models.Error'
1898+
'401':
1899+
description: Api key is wrong or not provided.
1900+
'403':
1901+
description: Payment doesn't belong to provider
1902+
'404':
1903+
description: Payment or attachment doesn't exists
1904+
'409':
1905+
description: Domain error response
1906+
'500':
1907+
description: General server or application error.
1908+
content:
1909+
text/plain:
1910+
schema:
1911+
$ref: '#/components/schemas/RestAPI.ActionFilters.Models.Error'
1912+
application/json:
1913+
schema:
1914+
$ref: '#/components/schemas/RestAPI.ActionFilters.Models.Error'
1915+
text/json:
1916+
schema:
1917+
$ref: '#/components/schemas/RestAPI.ActionFilters.Models.Error'
1918+
security:
1919+
- Bearer:
1920+
- subscriptions
15621921
/api/providers/{providerid}/agreements/{agreementid}/payments/{paymentid}/refunds:
15631922
get:
15641923
tags:

0 commit comments

Comments
 (0)