EMS - API Documentation - GET PaymentDetails
- Krog, Karianne
- Sigurd Sagen
- 1 GET Membership Payment Details
- 1.1 External Membership API
- 1.1.1 Overview
- 1.1.2 Resource Information
- 1.1.3 Request Headers
- 1.1.4 Request Parameters
- 1.1.5 Response Codes
- 1.1.6 Response Example
- 1.2 Corporate Sports API
- 1.2.1 Overview
- 1.2.2 Resource Information
- 1.2.3 Request Headers
- 1.2.4 Request Parameters
- 1.2.5 Response Codes
- 1.2.6 Response Example
- 1.1 External Membership API
GET Membership Payment Details
External Membership API
Overview
Method | API Endpoint | Description |
GET | /read/api/Payment/paymentdetails | Returns list of payment information made for club level membership. |
Resource Information
Response Format | JSON |
Requires Authentication | Yes |
Request Headers
| Name | Required | Description | Example |
1 | ClubId | Yes | Club Id for which API is being requested. |
|
2 | Authorization | Yes | This will be the token defining access to on-boarded club. |
|
3 | Ocp-Apim-Subscription-Key | Yes | API management’s subscription key. There will be a separate key for each Integrator. |
|
Request Parameters
| Name | Required | Description | Example |
1 | PersonId | Yes | Person Id for which the request is made |
|
2 | FromDate | Yes | From date range
Possible Value
|
|
3 | ToDate | Yes | End date range
Possible Value
|
|
Response Codes
| Code | Type | Text | Description |
1 | 200 | Success |
|
|
2 | 1022 | Error | PersonId is required. |
|
3 | 1023 | Error | From Date is required. |
|
4 | 1024 | Error | To Date is required. |
|
5 | 1025 | Error | From date should not be of year less than Today’s date year |
|
6 | 1026 | Error | To date should not be greater than From date. |
|
Response Example
{
"totalRecords": 7,
"pageSize": 100,
"currentPage": 1,
"data": [
{
"personId": 9285654,
"paidToOrgId": 20082,
"paymentTypeId": 0,
"paidDate": "2022-03-25T00:00:00",
"periodFrom": "2022-01-01T00:00:00",
"periodTo": "2022-12-31T00:00:00",
"paymentCategory": "Medlemskap",
"fee": 150.000,
"comment": "Test KFK paid for club membership 2021 og 2022?",
"externalReference": "POSTMAN KFK"
},
{
"personId": 9285654,
"paidToOrgId": 20082,
"paymentTypeId": 0,
"paidDate": "2022-03-25T00:00:00",
"periodFrom": "2022-01-01T00:00:00",
"periodTo": "2022-12-31T00:00:00",
"paymentCategory": "Medlemskap",
"fee": 150.000,
"comment": "Test KFK paid for club membership 2021 og 2022?",
"externalReference": "POSTMAN KFK"
},
{
"personId": 9285654,
"paidToOrgId": 20082,
"paymentTypeId": 0,
"paidDate": "2021-01-25T00:00:00",
"periodFrom": "2021-01-01T00:00:00",
"periodTo": "2021-12-31T00:00:00",
"paymentCategory": "Medlemskap",
"fee": 100.000,
"comment": "Test KFK paid for club membership 2021",
"externalReference": "POSTMAN KFK"
},
{
"personId": 9285654,
"paidToOrgId": 20082,
"paymentTypeId": 0,
"paidDate": "2021-01-25T00:00:00",
"periodFrom": "2022-01-01T00:00:00",
"periodTo": "2022-12-31T00:00:00",
"paymentCategory": "Medlemskap",
"fee": 100.000,
"comment": "Test KFK paid for club membership 2021",
"externalReference": "POSTMAN KFK"
},
{
"personId": 9285654,
"paidToOrgId": 20082,
"paymentTypeId": 0,
"paidDate": "2021-01-25T00:00:00",
"periodFrom": "2023-01-01T00:00:00",
"periodTo": "2023-12-31T00:00:00",
"paymentCategory": "Medlemskap",
"fee": 100.000,
"comment": "Test KFK paid for club membership 2023",
"externalReference": "POSTMAN KFK"
},
{
"personId": 9285654,
"paidToOrgId": 20082,
"paymentTypeId": 0,
"paidDate": "2021-01-25T00:00:00",
"periodFrom": "2021-01-01T00:00:00",
"periodTo": "2021-12-31T00:00:00",
"paymentCategory": "Medlemskap",
"fee": 150.000,
"comment": "Test KFK paid for club membership 2021",
"externalReference": "POSTMAN KFK"
},
{
"personId": 9285654,
"paidToOrgId": 20082,
"paymentTypeId": 0,
"paidDate": "2021-01-25T00:00:00",
"periodFrom": "2022-01-01T00:00:00",
"periodTo": "2022-10-31T00:00:00",
"paymentCategory": "Medlemskap",
"fee": 150.000,
"comment": "Test KFK paid for club membership 2021 og 2022?",
"externalReference": "POSTMAN KFK"
}
]
}Corporate Sports API
Overview
Method | API Endpoint | Description |
GET | /read/api/Payment/paymentdetails | Returns list of payment information made for Corporate Sports club level membership. |
Resource Information
Response Format | JSON |
Requires Authentication | Yes |
Request Headers
| Name | Required | Description | Example |
1 | OgId | Yes | Club Id for which API is being requested. Pass Corporate Sport club’s ID here to get payment details for the membership of corporate sports club. |
|
2 | Authorization | Yes | This will be the token defining access to on-boarded club. |
|
3 | Ocp-Apim-Subscription-Key | Yes | API management’s subscription key. There will be a separate key for each Integrator. |
|
4 | OrgTypeId | Yes | 5 or 15 |
|
Request Parameters
| Name | Required | Description | Example |
1 | PersonId | Yes | Person Id for whom the request is made |
|
2 | FromDate | Yes | From date range
Possible Value
|
|
3 | ToDate | Yes | End date range
Possible Value
|
|
Response Codes
| Code | Type | Text |
1 | 200 | Success |
|
2 | 1022 | Error | PersonId is required. |
3 | 1023 | Error | From Date is required. |
4 | 1024 | Error | To Date is required. |
5 | 1025 | Error | From date should not be of year less than Today’s date year |
6 | 1026 | Error | To date should not be greater than From date. |
Response Example
{
"totalRecords": 1,
"pageSize": 100,
"currentPage": 1,
"data": [
{
"personId": 9298186,
"paidToOrgId": 580411,
"paymentTypeId": 0,
"paidDate": "2022-03-25T00:00:00",
"periodFrom": "2022-01-01T00:00:00",
"periodTo": "2022-12-31T00:00:00",
"paymentCategory": "Medlemskap",
"fee": 150.000,
"comment": "Test KFK paid for club membership 2021 og 2022?",
"externalReference": "POSTMAN KFK"
}
]
}