Platform

Subscribe to webhook events for platform report status changes.

The following webhook events are available for your Payments for Platforms integration.

Event	Description
platform_report.completed	Creation of Platform report completed.
platform_report.failed	Creation of Platform report failed.

Payload examples

platform_report.completed

JSON

1{
2    "account_id": "acct_uDiPm2anMfKm6dpr8e07Rw",
3    "created_at": "2023-02-22T05:37:00+0000",
4    "data": Object{...},
5    "id": "evt_xShZWsLbMoOvhp3rzVf3JA",
6    "name": "platform_report.completed",
7    "source_id": "5bce2af8-e81e-4424-975c-c506d250d367",
8    "version": "2019-09-09",
9}

data is the Platform report object from Get Platform report API.

JSON

1{
2    "download_url": "https://storage.googleapis.com/fs-asia-southeast1-demo/5bce2af8-e81e-4424-975c-c506d250d367?X-Goog-Algorithm=GOOG4-RSA-SHA256&X-Goog-Credential=fileservice-sa%40platform-preprod-eeadfea1.iam.gserviceaccount.com%2F20230222%2Fauto%2Fstorage%2Fgoog4_request&X-Goog-Date=20230222T053700Z&X-Goog-Expires=60&X-Goog-SignedHeaders=host&X-Goog-Signature=8ed00ba8d531270380ca51da410c96d05ff0232f85f241665dda9b62e42eadf2fa0eed55c379131300d119c032751914323ef63ed2bb250cffab524fd200e943c98b35e1b27aa5a61f814abae8815d8ee387db668c0daf3cf27b9efb83d0020248e2fff76dff88176c2cf46cf3f165825b959bba97138d0aa306007990e88262e193d8e704c3ad60d9fc90ffc1cfd9c5df337fa556aabc994fb4ef6688c4a0e3f53d30314e68a9bd9de1e16af7c05934254a0b959430832f67bf602cdffbc18c646b35b7ac771855428694ee906f4c034d961cec382cf914104c993477a3e42d8cda98ee408a86aacdcef71035fd94e345709e55a1eb49cbd97b0bb84bbb0932",
3    "download_url_expires_at": "2023-02-22T05:38:00+0000",
4    "file_format": "CSV",
5    "file_name": "test_report",
6    "from_created_at": "2023-01-01T00:00:00+0000",
7    "id": "5bce2af8-e81e-4424-975c-c506d250d367",
8    "status": "COMPLETED",
9    "to_created_at": "2023-01-02T00:00:00+0000",
10    "type": "TRANSACTION_RECON_REPORT"
11}

platform_report.failed

JSON

1{
2    "account_id": "acct_uDiPm2anMfKm6dpr8e07Rw",
3    "created_at": "2023-02-22T05:37:58+0000",
4    "data": Object{...},
5    "id": "evt_a9EyGRFbNdmsmEvdjAThEQ",
6    "name": "platform_report.failed",
7    "source_id": "7c70a48b-8130-4926-a3e2-4e862560530f",
8    "version": "2019-09-09",
9}

data is the Platform report object from Get Platform report API.

JSON

1{
2    "failed_reason": "SYSTEM_FAILURE",
3    "file_format": "CSV",
4    "file_name": "test_report",
5    "from_created_at": "2023-01-01T00:00:00+0000",
6    "id": "7c70a48b-8130-4926-a3e2-4e862560530f",
7    "status": "FAILED",
8    "to_created_at": "2023-01-02T00:00:00+0000",
9    "type": "TRANSACTION_RECON_REPORT"
10}

Was this page helpful?