Skip to content

Create a new Braintree payment method.

Request

Creates the Braintree payment method with the associated vaulted nonce, for the authenticated user.

Security
CookieBlaizeSession or JwtQuery or JwtHeaderXBlaizeJwt or JwtHeaderXZephrJwt or JwtBearer or JwtCookie
Headers
cookiestringrequired

The session cookie.

Example:`blaize_session=...` (string)
Bodyapplication/json
payment_method_noncestring

The vaulted nonce associated with the new payment method.

Example:"aa583cb8...and other characters...3a43796ef8e5"
{ "payment_method_nonce": "aa583cb8...and other characters...3a43796ef8e5" }

Responses

OK. A new Braintree payment method has been created for the authenticated user.

Headers
any
Bodyapplication/json
tokenstringrequired

The token identifier for this payment method.

Example:"8m2kc5g"
defaultbooleanrequired

If this the default payment method for this user.

card_typestring

In the case of a card payment method, the type of the card.

Example:"Visa"
card_holder_namestring

In the case of a credit card payment method, the name of the card holder.

Example:"John Rambo"
card_number_maskedstring

In the case of a card payment method, the masked card number, compliant with PCI security standards.

Example:"654321******0987"
expiration_datestring

In the case of a card payment method, the expiration date, in the format of MM/YY or MM/YYYY.

Example:"07/22"
expiredboolean

In the case of a card payment method, if the card has expired.

expiring_soonboolean

In the case of a card payment method, if the card will expire within the configured number of days.

in_useboolean

Indicates if this payment method is used by any subscriptions that have not been finalised and would be cancelled if this payment method is deleted.

last_4string

In the case of a card payment method, the last four digits of the card number.

Example:"1111"
noncestringrequired

A nonce that can be used for other payment method operations.

Example:"086128f3-04c2-069e-78d2-3f4de98508e5"
typestringrequired

The payment method type.

Example:"CreditCard"
zipcodestring

In the case of a card payment method, the zip code associated with the card.

Example:"123456"
Response
{ "token": "8m2kc5g", "default": false, "card_type": "Visa", "card_holder_name": "John Rambo", "card_number_masked": "654321******0987", "expiration_date": "07/22", "expired": false, "expiring_soon": false, "in_use": false, "last_4": "1111", "nonce": "086128f3-04c2-069e-78d2-3f4de98508e5", "type": "CreditCard", "zipcode": "123456" }