VEverifone
Billing Agreement

Initiate billing agreement

post/billingAgreement/initiate

Request

Request body */*

paymentProviderContractstring required

PayPal Payment Provider Contract UUID

descriptionstring

Agreement description

enableAddressChangeboolean

Indicates whether to show the shipping address but prevent the customer from editing it.

collectShippingAddressboolean

Indicates whether to skip the collection of the shipping address from the customer during the agreement sign-up phase.

allowedCountriesstring[]

An array of legally accepted customer country codes

experienceIdstring

The ID of the experience profile to apply during the agreement approval UI flow.

externalSelectedFundingInstrumentType'CREDIT' | 'PAY_UPON_INVOICE'

The type of financial instrument (FI) that the merchant wants to promote.

returnUrlstring

The URL where the customer is redirected after the customer approves the payment

cancelUrlstring

The URL where the customer is redirected after the customer cancels the payment

Response

Successful

approvalUrlstring required

PayPal approval URL

billingTokenstring required

Billing token

Changes

No recorded changes to this operation across all 1 revision of this API.