GET | /paymentmethods/{PaymentMethodToken} | Generates BrainTree client token | Generates a client token from BrainTree |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
PaymentMethodToken | path | string | No | Payment method token |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
PaymentMethodToken | form | string | No | Payment method token |
CreditCard | form | CreditCard | No | The payment method credit card |
PayPalAccount | form | PayPalAccount | No | The payment method paypal account |
GooglePay | form | GooglePayDetails | No | The payment method GooglePay |
ApplePay | form | ApplePayDetails | No | The payment method ApplePay |
PaymentInstrumentType | form | PaymentInstrumentType | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CardType | form | string | No | The type of the credit card. Possible values: American Express, Carte Blanche, China UnionPay, Diners Club Discover, JCB, Laser, Maestro, MasterCard, Solo, Switch, Visa, Unknown |
ExpirationMonth | form | string | No | |
ExpirationYear | form | string | No | |
Bin | form | string | No | The first 6 digits of the credit card, known as the Bank Identification Number. |
LastFour | form | string | No | The last 4 digits of the credit card number |
UniqueNumberIdentifier | form | string | No | |
CardholderName | form | string | No | |
Token | form | string | No | The payment method token |
IsNetworkTokenized | form | bool? | No | |
Debit | form | CreditCardDebit | No |
yes |
no |
unknown |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Token | form | string | No | The payment method token |
form | string | No | The email address belonging to the Paypal account | |
BillingAgreementId | form | string | No | The unique identifier of the vaulted payment flow agreement between the customer's PayPal account and RSL PayPal business account |
CreatedAt | form | DateTime | No | The date/time the payment method was created |
PayerId | form | string | No | The ID belonging to the PayPal account |
RevokedAt | form | DateTime? | No | The date/time the payment method was revoked |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
SourceCardType | form | string | No | |
CustomerId | form | string | No | |
ExpirationMonth | form | string | No | |
ExpirationYear | form | string | No | |
Bin | form | string | No | The first 6 digits of the credit card, known as the Bank Identification Number. |
GoogleTransactionId | form | string | No | |
SourceCardLast4 | form | string | No | The last 4 digits of the credit card number |
CardholderName | form | string | No | |
Token | form | string | No | The payment method token |
IsNetworkTokenized | form | bool? | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CardType | form | string | No | |
CustomerId | form | string | No | |
ExpirationMonth | form | string | No | |
ExpirationYear | form | string | No | |
Bin | form | string | No | The first 6 digits of the credit card, known as the Bank Identification Number. |
LastFour | form | string | No | The last 4 digits of the credit card number |
CardholderName | form | string | No | |
Token | form | string | No | The payment method token |
unknown |
paypal_account |
credit_card |
android_pay_card |
apple_pay_card |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /paymentmethods/{PaymentMethodToken} HTTP/1.1 Host: azs-dev-payment-web.azurewebsites.net Accept: text/jsv
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { paymentMethodToken: String, creditCard: { cardType: String, expirationMonth: String, expirationYear: String, bin: String, lastFour: String, uniqueNumberIdentifier: String, cardholderName: String, token: String, isNetworkTokenized: False, debit: yes }, payPalAccount: { token: String, email: String, billingAgreementId: String, createdAt: 0001-01-01, payerId: String, revokedAt: 0001-01-01 }, googlePay: { sourceCardType: String, customerId: String, expirationMonth: String, expirationYear: String, bin: String, googleTransactionId: String, sourceCardLast4: String, cardholderName: String, token: String, isNetworkTokenized: False }, applePay: { cardType: String, customerId: String, expirationMonth: String, expirationYear: String, bin: String, lastFour: String, cardholderName: String, token: String }, paymentInstrumentType: unknown }