RSL Payment API

<back to all web services

FindPaymentMethod

Obtain a vaulted payment method from BrainTree

The following routes are available for this service:
GET/paymentmethods/{PaymentMethodToken}Generates BrainTree client token Generates a client token from BrainTree
FindPaymentMethod Parameters:
NameParameterData TypeRequiredDescription
PaymentMethodTokenpathstringNoPayment method token
PaymentMethod Parameters:
NameParameterData TypeRequiredDescription
PaymentMethodTokenformstringNoPayment method token
CreditCardformCreditCardNoThe payment method credit card
PayPalAccountformPayPalAccountNoThe payment method paypal account
GooglePayformGooglePayDetailsNoThe payment method GooglePay
ApplePayformApplePayDetailsNoThe payment method ApplePay
PaymentInstrumentTypeformPaymentInstrumentTypeNo
CreditCard Parameters:
NameParameterData TypeRequiredDescription
CardTypeformstringNoThe type of the credit card. Possible values: American Express, Carte Blanche, China UnionPay, Diners Club Discover, JCB, Laser, Maestro, MasterCard, Solo, Switch, Visa, Unknown
ExpirationMonthformstringNo
ExpirationYearformstringNo
BinformstringNoThe first 6 digits of the credit card, known as the Bank Identification Number.
LastFourformstringNoThe last 4 digits of the credit card number
UniqueNumberIdentifierformstringNo
CardholderNameformstringNo
TokenformstringNoThe payment method token
IsNetworkTokenizedformbool?No
DebitformCreditCardDebitNo
CreditCardDebit Enum:
yes
no
unknown
PayPalAccount Parameters:
NameParameterData TypeRequiredDescription
TokenformstringNoThe payment method token
EmailformstringNoThe email address belonging to the Paypal account
BillingAgreementIdformstringNoThe unique identifier of the vaulted payment flow agreement between the customer's PayPal account and RSL PayPal business account
CreatedAtformDateTimeNoThe date/time the payment method was created
PayerIdformstringNoThe ID belonging to the PayPal account
RevokedAtformDateTime?NoThe date/time the payment method was revoked
GooglePayDetails Parameters:
NameParameterData TypeRequiredDescription
SourceCardTypeformstringNo
CustomerIdformstringNo
ExpirationMonthformstringNo
ExpirationYearformstringNo
BinformstringNoThe first 6 digits of the credit card, known as the Bank Identification Number.
GoogleTransactionIdformstringNo
SourceCardLast4formstringNoThe last 4 digits of the credit card number
CardholderNameformstringNo
TokenformstringNoThe payment method token
IsNetworkTokenizedformbool?No
ApplePayDetails Parameters:
NameParameterData TypeRequiredDescription
CardTypeformstringNo
CustomerIdformstringNo
ExpirationMonthformstringNo
ExpirationYearformstringNo
BinformstringNoThe first 6 digits of the credit card, known as the Bank Identification Number.
LastFourformstringNoThe last 4 digits of the credit card number
CardholderNameformstringNo
TokenformstringNoThe payment method token
PaymentInstrumentType Enum:
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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
HTTP/1.1 200 OK
Content-Type: application/json
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-01T00:00:00.0000000","payerId":"String","revokedAt":"0001-01-01T00:00:00.0000000"},"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"}