Import PayPal payment method

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Use this operation to import an existing PayPal Mandate to a PayPal payment method.
Provide the following in the import request: token_id, token_type.

The token_type supports the following values:

  • VAULT - in case the token_id was created using the PayPal vault method
  • BILLING_AGREEMENT - in case the token_id is the ID of an existing billing agreement

If successful, a reference to the new payment method is returned.

Errors

Error code HTTP codeDescription
56400Multiple agreements
55404Agreement not found
Body Params
string
^[a-zA-Z0-9_\.\-@]*$

Optional reference given to the created payment method. Max length 64 with allowable characters [a-zA-Z0-9_.-@].

customer
object

Create customer object

string
^[a-zA-Z0-9_\.\-@]*$

Customer reference to an existing customer. Either this argument or customer must be provided.

string
required
length ≥ 1
^[a-zA-Z0-9_\.\-@]*$

The vault ID or the billing agreement ID, depending on the token type, of the payment method to be imported

string
enum
required
length ≥ 1

The type of token used in the previous integration

Allowed:
Responses

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json