POST api/Checkout/webhook
Request Information
URI Parameters
None.
Body Parameters
WebhookPayloadViewModelName | Description | Type | Additional information |
---|---|---|---|
id | string |
None. |
|
type | string |
None. |
|
version | string |
None. |
|
created_on | date |
None. |
|
data | Data |
None. |
|
_links | Links |
None. |
Request Formats
application/json, text/json
Sample:
{ "id": "sample string 1", "type": "sample string 2", "version": "sample string 3", "created_on": "2023-12-03T06:05:03.1708586+00:00", "data": { "id": "sample string 1", "action_id": "sample string 2", "reference": "sample string 3", "amount": 4, "processed_on": "2023-12-03T06:05:03.1708586+00:00", "response_code": "sample string 6", "response_summary": "sample string 7", "balances": { "total_authorized": 1, "total_voided": 2, "available_to_void": 3, "total_captured": 4, "available_to_capture": 5, "total_refunded": 6, "available_to_refund": 7 }, "metadata": { "appversions": [ { "ID": 1, "Platform": "sample string 2", "Version": 1.0 }, { "ID": 1, "Platform": "sample string 2", "Version": 1.0 } ] }, "currency": "sample string 8", "processing": { "acquirer_transaction_id": "sample string 1", "acquirer_reference_number": "sample string 2" }, "event_links": { "payment": "sample string 1", "payment_actions": "sample string 2", "refund": "sample string 3" } }, "_links": { "self": { "href": "sample string 1" }, "subject": { "href": "sample string 1" }, "payment": { "href": "sample string 1" }, "payment_actions": { "href": "sample string 1" }, "refund": { "href": "sample string 1" } } }
application/xml, text/xml
Sample:
<WebhookPayloadViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bankiom.DataLayer.Common"> <_links> <payment> <href>sample string 1</href> </payment> <payment_actions> <href>sample string 1</href> </payment_actions> <refund> <href>sample string 1</href> </refund> <self> <href>sample string 1</href> </self> <subject> <href>sample string 1</href> </subject> </_links> <created_on>2023-12-03T06:05:03.1708586+00:00</created_on> <data> <action_id>sample string 2</action_id> <amount>4</amount> <balances> <available_to_capture>5</available_to_capture> <available_to_refund>7</available_to_refund> <available_to_void>3</available_to_void> <total_authorized>1</total_authorized> <total_captured>4</total_captured> <total_refunded>6</total_refunded> <total_voided>2</total_voided> </balances> <currency>sample string 8</currency> <event_links> <payment>sample string 1</payment> <payment_actions>sample string 2</payment_actions> <refund>sample string 3</refund> </event_links> <id>sample string 1</id> <metadata> <appversions xmlns:d4p1="http://schemas.datacontract.org/2004/07/Bankiom.DataLayer.EF"> <d4p1:AppVersion> <d4p1:ID>1</d4p1:ID> <d4p1:Platform>sample string 2</d4p1:Platform> <d4p1:Version>1</d4p1:Version> </d4p1:AppVersion> <d4p1:AppVersion> <d4p1:ID>1</d4p1:ID> <d4p1:Platform>sample string 2</d4p1:Platform> <d4p1:Version>1</d4p1:Version> </d4p1:AppVersion> </appversions> </metadata> <processed_on>2023-12-03T06:05:03.1708586+00:00</processed_on> <processing> <acquirer_reference_number>sample string 2</acquirer_reference_number> <acquirer_transaction_id>sample string 1</acquirer_transaction_id> </processing> <reference>sample string 3</reference> <response_code>sample string 6</response_code> <response_summary>sample string 7</response_summary> </data> <id>sample string 1</id> <type>sample string 2</type> <version>sample string 3</version> </WebhookPayloadViewModel>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
booleanResponse Formats
application/json, text/json
Sample:
true
application/xml, text/xml
Sample:
<boolean xmlns="http://schemas.microsoft.com/2003/10/Serialization/">true</boolean>