For the complete documentation index, see llms.txt. This page is also available as Markdown.

PayPal Create billing agreement

Creating a billing agreement using a token, that was created in Initiate Billing Agreement API.

Required fields

  • billingToken - PayPal agreement token that was created in Initiate billing agreement

  • ppcUid - PayPal Payment Provider Contract UUID

Here is an example of request that can be used for creating a billing agreement.

curl -v -X POST '<SERVER URL>/billingAgreement/create' \
-H 'Authorization: Bearer <Access Token>' \
-H 'Content-Type: application/json' \
-d '{
    "billingToken":"BA-7P980893LY950894R",
    "paymentProviderContract":"<PPC ID>"
}'

Response code example

{
    "agreementId": "B-1WW844616B620123"
}

Response Fields

  • agreementId - The billing agreement ID that should be sent for authorizing and capturing the funds.

This agreement ID should be saved by the merchant on their server, so that they can send it for authorizing and capturing the transactions.

Last updated

Was this helpful?