RSL Payment API

ChargePayment

Braintree transaction operations

The following routes are available for this service:
POST	/payments/charge	Perform charge transaction	Performs a charge transaction on a PaymentMethodToken

**ChargePayment** Parameters:
Name	Parameter	Data Type	Required	Description
PaymentMethodToken	body	string	No	Token representing a vaulted payment method
PaymentMethodNonce	body	string	No	One time token representing a payment method that is not vaulted
StoreInVaultOnSuccess	body	bool	No	Whether the payment method should be vaulted on successful payment when using a nonce
CardholderName	body	string	No	Card holder name when storing a credit card with a nonce
PayPalPayeeEmail	body	string	No	Payee email to use for PayPal payment. When not provided, the default payee configured in Braintree will be used
ReferenceNumber	body	string	Yes	Unique transaction number for the new payment transaction.
Amount	body	number	No	Amount to be charged.
TransactionSource	body	TransactionSource?	No	Specifies the source of the transaction

**TransactionSource** Enum:
Name	Value
Unscheduled	unscheduled
Recurring	recurring
Recurring_first	recurring_first
CIT

**Payment** Parameters:
Name	Parameter	Data Type	Required
Amount	form	decimal?	No
ReferenceNumber	form	string	No
TransactionId	form	string	No
IsSuccess	form	bool?	No
TransactionStatus	form	TransactionStatus?	No
ProcessorResponseCode	form	string	No
ProcessorResponseText	form	string	No
GatewayRejectionReason	form	GatewayRejectionReason?	No
CreatedAt	form	DateTime	No
Disputes	form	List<Dispute>	No
CreditCard	form	CreditCard	No
PayPalDetails	form	PayPalDetails	No
GooglePay	form	GooglePayDetails	No
ApplePay	form	ApplePayDetails	No
SettlementBatchId	form	string	No
PaymentInstrumentType	form	PaymentInstrumentType	No
ResponseStatusType	form	ResponseStatusType	No
ProcessorDeclineType	form	ProcessorDeclineType?	No
VoidTransactionId	form	string	No
VoidProcessorResponseCode	form	string	No
ProcessedWithNetworkToken	form	bool?	No
AcquirerReferenceNumber	form	string	No
Retried	form	bool?	No
AchReturnCode	form	string	No
MerchantAccountId	form	string	No
Token	form	string	No

**TransactionStatus** Enum:
authorization_expired
authorized
authorizing
failed
gateway_rejected
processor_declined
settled
settling
submitted_for_settlement
voided
unrecognized
settlement_confirmed
settlement_declined
settlement_pending
failed_to_submit
submitting_to_braintree
timeout

**GatewayRejectionReason** Enum:
application_incomplete
avs
avs_and_cvv
cvv
duplicate
excessive_retry
fraud
risk_threshold
three_d_secure
token_issuance
unrecognized

**Dispute** Parameters:
Name	Parameter	Data Type	Required
Amount	form	decimal?	No
CurrencyIsoCode	form	string	No
DateOpened	form	DateTime?	No
DateWon	form	DateTime?	No
Id	form	string	No
Kind	form	DisputeKind	No
Reason	form	DisputeReason	No
PreDisputeProgram	form	PreDisputeProgram	No
ReceivedDate	form	DateTime?	No
ReplyByDate	form	DateTime?	No
Status	form	DisputeStatus	No
CaseNumber	form	string	No
PayPalMessages	form	List<DisputePayPalMessage>	No
ProtectionLevel	form	DisputeProtectionLevel	No

**DisputeKind** Enum:
chargeback
pre_arbitration
retrieval
unrecognized

**DisputeReason** Enum:
cancelled_recurring_transaction
credit_not_processed
duplicate
fraud
general
invalid_account
not_recognized
product_not_received
product_unsatisfactory
transaction_amount_differs
retrieval

**PreDisputeProgram** Enum:
none
unrecognized
visa_rdr

**DisputeStatus** Enum:
open
lost
won
unrecognized
accepted
auto_accepted
disputed
expired

**DisputePayPalMessage** Parameters:
Name	Parameter	Data Type	Required
Message	form	string	No
Sender	form	string	No
SentAt	form	DateTime?	No

**DisputeProtectionLevel** Enum:
effortless_cbp
standard_cbp
no_protection

**CreditCard** Parameters:
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

**CreditCardDebit** Enum:
yes
no
unknown

**PayPalDetails** Parameters:
Name	Parameter	Data Type	Required
RefundId	form	string	No
CaptureId	form	string	No
SellerProtectionStatus	form	string	No
PayerStatus	form	string	No
PayerLastName	form	string	No
PayerFirstName	form	string	No
PayerId	form	string	No
PayeeEmail	form	string	No
PayeeId	form	string	No
Token	form	string	No
AuthorizationId	form	string	No
PaymentId	form	string	No
PayerEmail	form	string	No
TransactionFeeAmount	form	decimal	No
TransactionFeeCurrencyIsoCode	form	string	No
Description	form	string	No
BillingAgreementId	form	string	No
TaxId	form	string	No
TaxIdType	form	string	No

**GooglePayDetails** Parameters:
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

**ApplePayDetails** Parameters:
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

**PaymentInstrumentType** Enum:
unknown
paypal_account
credit_card
android_pay_card
apple_pay_card

**ResponseStatusType** Enum:
Unknown
Success
Fail
SoftFail

**ProcessorDeclineType** Enum:
Unknown
Soft
Hard

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /payments/charge HTTP/1.1 
Host: azs-dev-payment-web.azurewebsites.net 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	paymentMethodToken: String,
	paymentMethodNonce: String,
	storeInVaultOnSuccess: False,
	cardholderName: String,
	payPalPayeeEmail: String,
	referenceNumber: String,
	amount: 0,
	transactionSource: unscheduled
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	amount: 0,
	referenceNumber: String,
	transactionId: String,
	isSuccess: False,
	transactionStatus: authorization_expired,
	processorResponseCode: String,
	processorResponseText: String,
	gatewayRejectionReason: application_incomplete,
	createdAt: 0001-01-01,
	disputes: 
	[
		{
			amount: 0,
			currencyIsoCode: String,
			dateOpened: 0001-01-01,
			dateWon: 0001-01-01,
			id: String,
			kind: chargeback,
			reason: cancelled_recurring_transaction,
			preDisputeProgram: none,
			receivedDate: 0001-01-01,
			replyByDate: 0001-01-01,
			status: open,
			caseNumber: String,
			payPalMessages: 
			[
				{
					message: String,
					sender: String,
					sentAt: 0001-01-01
				}
			],
			protectionLevel: effortless_cbp
		}
	],
	creditCard: 
	{
		cardType: String,
		expirationMonth: String,
		expirationYear: String,
		bin: String,
		lastFour: String,
		uniqueNumberIdentifier: String,
		cardholderName: String,
		token: String,
		isNetworkTokenized: False,
		debit: yes
	},
	payPalDetails: 
	{
		refundId: String,
		captureId: String,
		sellerProtectionStatus: String,
		payerStatus: String,
		payerLastName: String,
		payerFirstName: String,
		payerId: String,
		payeeEmail: String,
		payeeId: String,
		token: String,
		authorizationId: String,
		paymentId: String,
		payerEmail: String,
		transactionFeeAmount: 0,
		transactionFeeCurrencyIsoCode: String,
		description: String,
		billingAgreementId: String,
		taxId: String,
		taxIdType: String
	},
	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
	},
	settlementBatchId: String,
	paymentInstrumentType: unknown,
	responseStatusType: Unknown,
	processorDeclineType: Unknown,
	voidTransactionId: String,
	voidProcessorResponseCode: String,
	processedWithNetworkToken: False,
	acquirerReferenceNumber: String,
	retried: False,
	achReturnCode: String,
	merchantAccountId: String,
	token: String
}