Skip to main content

Online payments

PayPal Show agreement details

Last updated: 30-Mar-2022
Rate this article:

Overview

Shows details for a billing agreement, by the ID that was created in PayPal Initiate billing agreement.

Required fields

  • billingAgreementID - billing agreement ID in params 
  • ppcUid - PayPal Payment Provider Contract UUID in query

Optional fields

There are no optional fields.

Here is an example of a GET request that can be used for getting billing agreement details.

curl -v -X GET '<SERVER URL>/billingAgreement/<Agreement Id>?ppcUid=<PPC Id>' \
-H 'Authorization: Bearer <Access Token>'

Response code example

{
    "id": "B-1WW844612B6208426",
    "state": "INACTIVE",
    "description": "Stored PayPal account with The Partner merchant",
    "merchant": {
        "payeeInfo": {
            "email": "buyer@business.example.com"
        }
    },
    "payer": {
        "payerInfo": {
            "email": "payer@business.example.com",
            "firstName": "John",
            "lastName": "Doe",
            "payerId": "VJRXDDV4UWZ2W"
        }
    },
    "plan": {
        "merchantPreferences": {}
    },
    "createTime": "2021-03-03T11:56:27.000Z",
    "updateTime": "2021-03-03T11:56:27.000Z"
}
Rate this article:

Need help?

Do you have a question? On our Support page you will find a list with answers to frequently asked questions.
Did not find the answer you are looking for? Please contact us. We are happy to help.

Logo of Verifone