Get Event Subscriptions
curl --request GET \
--url https://api.yapily.com/notifications/event-subscriptions \
--header 'Authorization: Basic <encoded-value>'import requests
url = "https://api.yapily.com/notifications/event-subscriptions"
headers = {"Authorization": "Basic <encoded-value>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};
fetch('https://api.yapily.com/notifications/event-subscriptions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.yapily.com/notifications/event-subscriptions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.yapily.com/notifications/event-subscriptions"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Basic <encoded-value>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.yapily.com/notifications/event-subscriptions")
.header("Authorization", "Basic <encoded-value>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.yapily.com/notifications/event-subscriptions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'
response = http.request(request)
puts response.read_body{
"meta": {
"tracingId": "<string>",
"count": 123,
"pagination": {
"totalCount": 123,
"self": {
"from": "2023-11-07T05:31:56Z",
"before": "2023-11-07T05:31:56Z",
"limit": 123,
"offset": 123,
"cursor": "<string>"
},
"next": {
"from": "2023-11-07T05:31:56Z",
"before": "2023-11-07T05:31:56Z",
"limit": 123,
"cursor": "<string>"
}
}
},
"data": [
{
"eventTypeId": "payment.status.completed",
"applicationId": "2698db90-6635-4f76-b673-5ce8e2aeda0e",
"created": "28-07-2021 15:47:03",
"notification": {
"type": "WEBHOOK",
"url": "https://httpbin.com/new_endpoint"
}
}
],
"links": {},
"forwardedData": [
{
"headers": {},
"url": "<string>"
}
],
"raw": [
{
"request": {
"method": "<string>",
"url": "<string>",
"requestInstant": "2023-11-07T05:31:56Z",
"headers": {},
"body": {},
"bodyParameters": {},
"startTime": "2023-11-07T05:31:56Z",
"startedAt": "2023-11-07T05:31:56Z"
},
"duration": "<string>",
"headers": {},
"resultCode": 123,
"result": {}
}
],
"paging": {
"apiCall": {},
"data": [
{
"id": "<string>",
"date": "2023-11-07T05:31:56Z",
"bookingDateTime": "2023-11-07T05:31:56Z",
"valueDateTime": "2023-11-07T05:31:56Z",
"amount": 123,
"currency": "<string>",
"transactionAmount": {
"amount": 10,
"currency": "GBP"
},
"grossAmount": {
"amount": 10,
"currency": "GBP"
},
"currencyExchange": {
"sourceCurrency": "<string>",
"targetCurrency": "<string>",
"unitCurrency": "<string>",
"exchangeRate": 123
},
"chargeDetails": {
"chargeAmount": {
"amount": 10,
"currency": "GBP"
}
},
"reference": "<string>",
"statementReferences": [
{
"value": "<string>"
}
],
"description": "<string>",
"transactionInformation": [
"<string>"
],
"addressDetails": {
"addressLine": "<string>"
},
"isoBankTransactionCode": {
"domainCode": {
"code": "UNKNOWN",
"name": "UNKNOWN"
},
"familyCode": {
"code": "UNKNOWN",
"name": "UNKNOWN"
},
"subFamilyCode": {
"code": "UNKNOWN",
"name": "UNKNOWN"
}
},
"proprietaryBankTransactionCode": {
"code": "<string>",
"issuer": "<string>"
},
"balance": {
"balanceAmount": {
"amount": 10,
"currency": "GBP"
}
},
"payeeDetails": {
"name": "<string>",
"accountIdentifications": [
{
"type": "SORT_CODE",
"identification": "<string>"
}
]
},
"payerDetails": {
"name": "<string>",
"accountIdentifications": [
{
"type": "SORT_CODE",
"identification": "<string>"
}
]
},
"merchant": {
"merchantName": "<string>",
"merchantCategoryCode": "<string>"
},
"enrichment": {
"categorisation": {
"categories": [
"<string>"
],
"source": "<string>"
},
"transactionHash": {
"hash": "<string>"
},
"cleansedDescription": "<string>",
"merchant": {
"merchantName": "<string>",
"parentGroup": "<string>"
},
"location": "<string>",
"paymentProcessor": "<string>",
"correctedDate": "2023-11-07T05:31:56Z"
},
"supplementaryData": {},
"transactionMutability": "Mutable"
}
],
"nextCursorHash": "<string>",
"nextLink": "<string>",
"pagingMap": {},
"totalCount": 123
}
}Notifications
Get Event Subscriptions
Get all event subscriptions that your application is subscribed to
Get Event Subscriptions
curl --request GET \
--url https://api.yapily.com/notifications/event-subscriptions \
--header 'Authorization: Basic <encoded-value>'import requests
url = "https://api.yapily.com/notifications/event-subscriptions"
headers = {"Authorization": "Basic <encoded-value>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};
fetch('https://api.yapily.com/notifications/event-subscriptions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.yapily.com/notifications/event-subscriptions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.yapily.com/notifications/event-subscriptions"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Basic <encoded-value>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.yapily.com/notifications/event-subscriptions")
.header("Authorization", "Basic <encoded-value>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.yapily.com/notifications/event-subscriptions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'
response = http.request(request)
puts response.read_body{
"meta": {
"tracingId": "<string>",
"count": 123,
"pagination": {
"totalCount": 123,
"self": {
"from": "2023-11-07T05:31:56Z",
"before": "2023-11-07T05:31:56Z",
"limit": 123,
"offset": 123,
"cursor": "<string>"
},
"next": {
"from": "2023-11-07T05:31:56Z",
"before": "2023-11-07T05:31:56Z",
"limit": 123,
"cursor": "<string>"
}
}
},
"data": [
{
"eventTypeId": "payment.status.completed",
"applicationId": "2698db90-6635-4f76-b673-5ce8e2aeda0e",
"created": "28-07-2021 15:47:03",
"notification": {
"type": "WEBHOOK",
"url": "https://httpbin.com/new_endpoint"
}
}
],
"links": {},
"forwardedData": [
{
"headers": {},
"url": "<string>"
}
],
"raw": [
{
"request": {
"method": "<string>",
"url": "<string>",
"requestInstant": "2023-11-07T05:31:56Z",
"headers": {},
"body": {},
"bodyParameters": {},
"startTime": "2023-11-07T05:31:56Z",
"startedAt": "2023-11-07T05:31:56Z"
},
"duration": "<string>",
"headers": {},
"resultCode": 123,
"result": {}
}
],
"paging": {
"apiCall": {},
"data": [
{
"id": "<string>",
"date": "2023-11-07T05:31:56Z",
"bookingDateTime": "2023-11-07T05:31:56Z",
"valueDateTime": "2023-11-07T05:31:56Z",
"amount": 123,
"currency": "<string>",
"transactionAmount": {
"amount": 10,
"currency": "GBP"
},
"grossAmount": {
"amount": 10,
"currency": "GBP"
},
"currencyExchange": {
"sourceCurrency": "<string>",
"targetCurrency": "<string>",
"unitCurrency": "<string>",
"exchangeRate": 123
},
"chargeDetails": {
"chargeAmount": {
"amount": 10,
"currency": "GBP"
}
},
"reference": "<string>",
"statementReferences": [
{
"value": "<string>"
}
],
"description": "<string>",
"transactionInformation": [
"<string>"
],
"addressDetails": {
"addressLine": "<string>"
},
"isoBankTransactionCode": {
"domainCode": {
"code": "UNKNOWN",
"name": "UNKNOWN"
},
"familyCode": {
"code": "UNKNOWN",
"name": "UNKNOWN"
},
"subFamilyCode": {
"code": "UNKNOWN",
"name": "UNKNOWN"
}
},
"proprietaryBankTransactionCode": {
"code": "<string>",
"issuer": "<string>"
},
"balance": {
"balanceAmount": {
"amount": 10,
"currency": "GBP"
}
},
"payeeDetails": {
"name": "<string>",
"accountIdentifications": [
{
"type": "SORT_CODE",
"identification": "<string>"
}
]
},
"payerDetails": {
"name": "<string>",
"accountIdentifications": [
{
"type": "SORT_CODE",
"identification": "<string>"
}
]
},
"merchant": {
"merchantName": "<string>",
"merchantCategoryCode": "<string>"
},
"enrichment": {
"categorisation": {
"categories": [
"<string>"
],
"source": "<string>"
},
"transactionHash": {
"hash": "<string>"
},
"cleansedDescription": "<string>",
"merchant": {
"merchantName": "<string>",
"parentGroup": "<string>"
},
"location": "<string>",
"paymentProcessor": "<string>",
"correctedDate": "2023-11-07T05:31:56Z"
},
"supplementaryData": {},
"transactionMutability": "Mutable"
}
],
"nextCursorHash": "<string>",
"nextLink": "<string>",
"pagingMap": {},
"totalCount": 123
}
}Authorizations
Use HTTP Basic Authentication with your Application ID as username and Application Secret as password. Manage credentials in the Yapily Console. See Authentication for details.
Headers
The sub-application ID for which all event subscriptions will be returned
Response
Event subscriptions for the application
Was this page helpful?
⌘I