@@ -12,6 +12,7 @@ description:
1212 Payments hold information about the current state of receiving and/or
1313 refunding money
1414get :
15+ displayName : Query Payments
1516 securedBy : [oauth_2_0: { scopes: ['view_payments:{projectKey}'] }]
1617 description : Retrieves Payments in the Project.
1718 responses :
2021 application/json :
2122 example : !include ../examples/payments.example.json
2223head :
24+ displayName : Check if Payment exists by Query Predicate
2325 securedBy : [oauth_2_0: { scopes: ['view_payments:{projectKey}'] }]
2426 description : Checks if one or more Payments exist for the provided query predicate. Returns a `200 OK` status if any Payments match the query predicate, or [Not Found](/../api/errors#404-not-found) otherwise.
2527 queryParameters :
2628 where? :
2729 type : QueryPredicate[]
2830post :
31+ displayName : Create Payment
2932 securedBy : [oauth_2_0: { scopes: ['manage_payments:{projectKey}'] }]
3033 body :
3134 application/json :
4649 resourceType : Payment
4750 resourceUpdateType : PaymentUpdate
4851 get :
52+ displayName : Get Payment by Key
4953 securedBy : [oauth_2_0: { scopes: ['view_payments:{projectKey}'] }]
5054 description : Retrieves a Payment with the provided `key`.
5155 responses :
5458 application/json :
5559 example : !include ../examples/payment.example.json
5660 head :
61+ displayName : Check if Payment exists by Key
5762 securedBy : [oauth_2_0: { scopes: ['view_payments:{projectKey}'] }]
5863 description : Checks if a Payment exists with the provided `key`. Returns a `200 OK` status if the Payment exists, or [Not Found](/../api/errors#404-not-found) otherwise.
5964 post :
65+ displayName : Update Payment by Key
6066 securedBy : [oauth_2_0: { scopes: ['manage_payments:{projectKey}'] }]
6167 description : Updates a Payment in the Project using one or more [update actions](/../api/projects/payments#update-actions).
6268 body :
6874 application/json :
6975 example : !include ../examples/payment.example.json
7076 delete :
77+ displayName : Delete Payment by Key
7178 is :
7279 - dataErasure
7380 securedBy : [oauth_2_0: { scopes: ['manage_payments:{projectKey}'] }]
8592 resourceType : Payment
8693 resourceUpdateType : PaymentUpdate
8794 get :
95+ displayName : Get Payment by ID
8896 securedBy : [oauth_2_0: { scopes: ['view_payments:{projectKey}'] }]
8997 description : Retrieves a Payment with the provided `id`.
9098 responses :
@@ -93,9 +101,11 @@ post:
93101 application/json :
94102 example : !include ../examples/payment.example.json
95103 head :
104+ displayName : Check if Payment exists by ID
96105 securedBy : [oauth_2_0: { scopes: ['view_payments:{projectKey}'] }]
97106 description : Checks if a Payment exists with the provided `id`. Returns a `200 OK` status if the Payment exists, or [Not Found](/../api/errors#404-not-found) otherwise.
98107 post :
108+ displayName : Update Payment by ID
99109 securedBy : [oauth_2_0: { scopes: ['manage_payments:{projectKey}'] }]
100110 description : Updates a Payment in the Project using one or more [update actions](/../api/projects/payments#update-actions).
101111 body :
@@ -107,6 +117,7 @@ post:
107117 application/json :
108118 example : !include ../examples/payment.example.json
109119 delete :
120+ displayName : Delete Payment by ID
110121 is :
111122 - dataErasure
112123 securedBy : [oauth_2_0: { scopes: ['manage_payments:{projectKey}'] }]
0 commit comments