Sign in
Payment method requests

Add payment method request

Create a payment method request for the specified customer or company account to securely collect a payment method without charging the guest immediately. An optional email notification is sent to the account's email address or a specified override address. Note this operation supports Portfolio Access Tokens.

post/api/connector/v1/paymentMethodRequests/add

Request body

ClientTokenstring required

Token identifying the client application.

AccessTokenstring required

Access token of the client application.

Clientstring required

Name and version of the client application.

EnterpriseIdstring uuid nullable

Unique identifier of the enterprise. Required when using Portfolio Access Tokens, ignored otherwise.

AccountIdstring uuid required

Unique identifier of the account (Customer or Company) to which the payment method request is issued.

ExpirationUtcstring date-time required

Date and time of the payment method request's expiration in ISO 8601 format.

Descriptionstring required

Description of the payment method request displayed to the customer.

Notesstring nullable

Payment method request's internal notes.

PaymentMethodsPaymentMethodRequestPaymentMethodsEnum[] required

Collectable payment methods.

Emailstring email nullable

Account email address for sending the payment method request. If not provided, uses the email from the customer profile.

EmailsToSendPaymentMethodRequestEmailTypesEnum[] nullable

Email notifications to send. If not specified, all emails will be sent. To disable all emails send an empty list. Additional email types may be added in the future.

Response

OK

PaymentMethodRequestIdstring uuid required

Unique identifier of the created payment method request.

Changes

No recorded changes to this endpoint across all 10 revisions of this API.