POST api/pay/ZestWebHook

Request Information

URI Parameters

None.

Body Parameters

ZestWebHookRequestObject
NameDescriptionTypeAdditional information
domain

string

None.

status

boolean

None.

reference

string

None.

amount

string

None.

message

Object

None.

paidAt

Collection of integer

None.

createdAt

Collection of integer

None.

channel

string

None.

currency

string

None.

ipAddress

string

None.

maskedPan

string

None.

paymentAttempts

Collection of PaymentAttemptWebhook

None.

fees

FeesWebHook

None.

customer

CustomerWebHook

None.

metadata

Object

None.

cardId

Object

None.

Request Formats

application/json, text/json

Sample:
{
  "domain": "sample string 1",
  "status": true,
  "reference": "sample string 3",
  "amount": "sample string 4",
  "message": {},
  "paidAt": [
    1,
    2
  ],
  "createdAt": [
    1,
    2
  ],
  "channel": "sample string 6",
  "currency": "sample string 7",
  "ipAddress": "sample string 8",
  "maskedPan": "sample string 9",
  "paymentAttempts": [
    {
      "paymentToken": "sample string 1",
      "message": {},
      "transactionStatus": "sample string 3",
      "paymentCompleted": true,
      "transactionRef": "sample string 5",
      "cardId": {}
    },
    {
      "paymentToken": "sample string 1",
      "message": {},
      "transactionStatus": "sample string 3",
      "paymentCompleted": true,
      "transactionRef": "sample string 5",
      "cardId": {}
    }
  ],
  "fees": {
    "transactionFee": 1.1,
    "settlementFee": {}
  },
  "customer": {
    "firstName": "sample string 1",
    "lastName": "sample string 2",
    "email": "sample string 3",
    "createdDate": [
      1,
      2
    ]
  },
  "metadata": {},
  "cardId": {}
}

application/xml, text/xml

Sample:
<ZestWebHookRequestObject xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Auth.DataLayer.Models.DTO.Zest">
  <amount>sample string 4</amount>
  <cardId />
  <channel>sample string 6</channel>
  <createdAt xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>1</d2p1:long>
    <d2p1:long>2</d2p1:long>
  </createdAt>
  <currency>sample string 7</currency>
  <customer>
    <createdDate xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:long>1</d3p1:long>
      <d3p1:long>2</d3p1:long>
    </createdDate>
    <email>sample string 3</email>
    <firstName>sample string 1</firstName>
    <lastName>sample string 2</lastName>
  </customer>
  <domain>sample string 1</domain>
  <fees>
    <settlementFee />
    <transactionFee>1.1</transactionFee>
  </fees>
  <ipAddress>sample string 8</ipAddress>
  <maskedPan>sample string 9</maskedPan>
  <message />
  <metadata />
  <paidAt xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>1</d2p1:long>
    <d2p1:long>2</d2p1:long>
  </paidAt>
  <paymentAttempts>
    <PaymentAttemptWebhook>
      <cardId />
      <message />
      <paymentCompleted>true</paymentCompleted>
      <paymentToken>sample string 1</paymentToken>
      <transactionRef>sample string 5</transactionRef>
      <transactionStatus>sample string 3</transactionStatus>
    </PaymentAttemptWebhook>
    <PaymentAttemptWebhook>
      <cardId />
      <message />
      <paymentCompleted>true</paymentCompleted>
      <paymentToken>sample string 1</paymentToken>
      <transactionRef>sample string 5</transactionRef>
      <transactionStatus>sample string 3</transactionStatus>
    </PaymentAttemptWebhook>
  </paymentAttempts>
  <reference>sample string 3</reference>
  <status>true</status>
</ZestWebHookRequestObject>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.