Skip to main content

Gift Aid API

Create Gift Aid Declaration#

Create a new Gift Aid Declaration as part a new Payment. All writable fields on Gift Aid Declaration can be included in the CreateGiftAidDeclaration block.

Example Request

    {        "SuccessURL":"http://success.com",        "FailureURL":"http://failure.com",        "Payer":{            "Contact": {},            "ContactId": "0032p00002djAK9AAM",            "ContactUpdate":"None"        },        "PackageActions": {            "PaymentHub-GiftAid": {              "CreateGiftAidDeclaration": {                "dateMade": "2019-12-15",                "startDate": "2021-01-01",                "endDate": "2021-12-31",                "houseNameOrNumber": "12",                "postalCode": "L68 0AQ",                "overseas": true,                "acquisitionMethod":"Written"              }            }          },        "SourceConnector":{            "Name":"PaymentHub"        }    }

Close All Gift Aid Declaration#

Close all gift aid declarations (i.e. stop Gift Aid) as part of a new Payment.

Example Request

    {        "SuccessURL":"http://success.com",        "FailureURL":"http://failure.com",        "Payer":{            "ContactId": "0032p00002djA0dAAE",            "Contact": {}        },        "PackageActions": {            "PaymentHub-GiftAid": {              "CloseAllGiftAidDeclarations": {                "closeDate": "2019-12-15",                "closeReason":"Unemployed",                "comments":"Free text"              }            }          },                "SourceConnector":{            "Name":"PaymentHub"        }    }