Payer account details

If enabled for your merchant or partner account, Vyne will provide details of the payer's account upon confirmation of funds received.

Webhook notifications

When the status of a payment is updated, Vyne will send a digitally signed POST request to the specified callback URL. Make sure you have set up a callback URL.

🚧

Be aware

In order to protect the transfer of consumer data this webhook call requires the receiving server to have a valid, un-expired, and un-revoked SSL certificate, signed by a Certificate Authority (CA) with Online Certificate Status Protocol (OCSP) responders configured.

Many CAs such as LetsEncrypt or DigiCert provide certificates with OCSP responders configured. Check your configuration with you CA for more information - this DigiCert tool can help you determine your OCSP status.

Webhook

cURL

--header 'x-signature=h4DnIgww/Qw0NhMFlzgQuLKpvhVgJGm5ZSImO7wh7MewUX3AJYa06fwh9naN1Zp7h9OopRbVR3oY8L0PzDmirXyX1QM3eRZIkSjAZs+S9vx7D2ETH0WGk3ByJ28i3j6Q3Be3G5PEx91llVgTsOyYTdKVykzh/b8azI+5fr45PMe6mOKVjb8hoBsMJP9n+jQWQ8NnkR9h4iCxxqULFsY+oXu08dFFMPfnyc2Lp7rA66kLZVU7w4XS3rrNxoWV65Z75lvB8wAefWkR9KdFE8kWdZpAqdG+nC78EEZOo3fMoW+RuNKP57rw0yjC0Xmh8fActzTVyKcBlhum+/fTBc8rCbeoFKoHBiXQ+mcTKTdTveVEe2P95jtet6C2AMI0grRo7N45kMPT2IhyFxe4WUtafkpkJhTCu65QliGlQwKnebCQYB4uQUmvTQ8vli8FKjomeGis4KYOkQMA1YAatVF00IThbVVKO3QafVGUfn3Sue6EdNPT8UW8DiQ2UPsAYCI8N+M0YyebQZ48NqAv6Rp0Kz/srxiJc7YiWhLIgmoFe5Kfz+HWrIIZknH66HRhK3AFYocSliWtOH9p6YwaDNZ/M7giW7zjNpjWyRq7uoPLFD9OYZgaC+4vIreL3KTx/eCVHx0yqNajVSYAuMExwrPxoctklGAjuWHEFIRtm6wXqE0='
--header 'x-signature-keyId=718c7272-4e33-466b-8ad8-28fa2c95193f'

JSON

{
  "type": "PAYER_DETAILS",
  "paymentId": "628eeb4cc58f60a4",
  "merchant": "4c5539c128022dea",
  "payerName": "Joe Bloggs",
  "accountDetails": {
    "accountNo": "63849203",
    "sortCode": "001111",
    "accountType": "SCAN"
  },
  "timestamp": 1654694419857
}

The accountDetails object supports different account types.

JSON

{
  "type": "PAYER_DETAILS",
  "paymentId": "628eeb4cc58f60a4",
  "merchant": "4c5539c128022dea",
  "payerName": "Jane Bloggs",
  "accountDetails": {
    "iban": "LT34 3250 0909 3475 7655",
    "accountType": "IBAN"
  },
  "timestamp": 1654694419857
}

JSON

{
  "type": "PAYER_DETAILS",
  "paymentId": "1ac613c7ca3eca52",
  "merchant": "4c5539c128022dea",
  "payerName": "Mike Bloggs",
  "accountDetails": {
      "accountNo": "63849203",
      "sortCode": "001111",
      "accountType": "SCAN"
  },
  "timestamp": 1654694419857
}

Parameter	Description
type	A constant type for the payment status notification.
paymentId	16 digit alphanumeric unique payment identifier
merchant	16 digit alphanumeric unique merchant identifier (for partner accounts)
timestamp	Exact date when the webhook notification was sent represented by a UNIX epoch time in milliseconds.
payerName	The name on the account used by the payer.
accountDetails	Object containing the payer's account details.

accountDetails

Parameter	Description
accountNo	Payer's account number (GBP payments only)
sortCode	Payer's sort code (GBP payments only)
iban	Payer's IBAN (EUR payments only)
accountType	The type of account details. Available values are SCAN (GBP payments) and IBAN (EUR payments).