Receiving a payment notification

When requesting a PaymentRequest from the Hosted Payment System, a url can be specified which will be called in the event of a successful payment.

When nce a payment has been processed by the Hosted Payment System, the OnSuccess url will be posted to with the following data in the request body.

NameDescriptionType
paymentDetails of the payment that has been processedPayment Model
dataThe application specific metadata created when the payment url was createdobject
{
payment :   "id": "string",
            "name": "string",
            "providerReference": "string",
            "amount": 0,
            "timeStamp": "2018-10-22T11:20:31.388Z",
            "statusReason": "string",
            "description": "string",
            "tenant": "string",
            "expectedCompletionDate": "2018-10-22T11:20:31.388Z",
            "dueDate": "2018-10-22T11:20:31.388Z",
            "wallet": {
              "id": "string",
              "name": "string",
              "ownerId": "string",
              "owner": {
                "id": "string",
                "customerType": "string",
                "assetRole": "ISSUER",
                "number": "string",
                "email": "string",
                "thumbnail": "string",
                "displayName": "string",
                "nameDetails": {
                  "nameId": "string",
                  "title": "string",
                  "firstName": "string",
                  "lastName": "string"
                },
                "name": "string",
                "address": {
                  "addressId": "string",
                  "effectiveDate": "2018-10-22T11:20:31.388Z",
                  "address1": "string",
                  "address2": "string",
                  "address3": "string",
                  "town": "string",
                  "postCode": "string"
                },
                "wallets": {
                  "count": 0,
                  "links": {}
                },
                "assets": {
                  "count": 0,
                  "links": {}
                },
                "sources": {
                  "count": 0,
                  "links": {}
                },
                "kycStatus": {
                  "links": {},
                  "status": "Pass",
                  "statusReason": "string",
                  "runDate": "2018-10-22T11:20:31.388Z",
                  "nextKYCDate": "2018-10-22T11:20:31.388Z",
                  "kycType": "Basic"
                },
                "balance": 0,
                "pending": 0,
                "pending_Debits": 0,
                "pending_Credits": 0,
                "assetsOwnedValue": 0,
                "metaData": [
                  {
                    "id": "string",
                    "key": "string",
                    "dataType": "Text",
                    "name": "string",
                    "value": "string",
                    "required": true,
                    "defaultValue": "string"
                  }
                ],
                "links": {},
                "createdDate": "2018-10-22T11:20:31.388Z",
                "createdBy": "string"
              },
              "description": "string",
              "number": "string",
              "status": "Open",
              "statusReason": "string",
              "balance": 0,
              "pending_Debits": 0,
              "pending_Credits": 0,
              "opened": "2018-10-22T11:20:31.388Z",
              "currencyCode": "string",
              "links": {},
              "createdDate": "2018-10-22T11:20:31.388Z",
              "createdBy": "string"
            },
            "source": {
              "id": "string",
              "name": "string",
              "accountNumber": "string",
              "sortCode": "string",
              "type": "string",
              "externalId": "string",
              "cardNumber": "string",
              "token": "string",
              "cvc": 0,
              "expMonth": 0,
              "expYear": 0,
              "cardHolderName": "string",
              "bankName": "string",
              "branchAddress1": "string",
              "branchAddress2": "string",
              "branchAddress3": "string",
              "branchTown": "string",
              "branchPostcode": "string",
              "paymentsOut": 0,
              "paymentsIn": 0,
              "owner": {
                "id": "string",
                "name": "string"
              },
              "links": {},
              "createdDate": "2018-10-22T11:20:31.388Z",
              "createdBy": "string"
            },
            "history": [
              {
                "timestamp": "2018-10-22T11:20:31.388Z",
                "status": "Success",
                "statusReason": "string",
                "providerReference": "string"
              }
            ],
            "status": "Success",
            "links": {},
            "createdDate": "2018-10-22T11:20:31.388Z",
            "createdBy": "string"
          },
	data : {
    	metaDataId_0 1234;
  		metaDataId_1 : "Test Stuff"
  }
}