co.aurasphere.botmill.fb.model.incoming.callback.payment

Class Payment

java.lang.Object

co.aurasphere.botmill.fb.model.incoming.callback.payment.Payment

All Implemented Interfaces:

Serializable

public class Payment
extends Object
implements Serializable

Model for the Payment Callback.

This callback occurs when a persons taps the pay button from the checkout dialog rendered by the BuyButton. It contains the requested user information as well as payment credentials. Depends on the payment provider you use, the payment credential will differ.

You must subscribe to this callback by selecting the messaging_payments field when setting up your webhook.

Stripe/Paypal

After user click on pay, user will be charged directly and the payment will be send to your Stripe/Paypal account. This webhook event will be called once the process succeed. All the requested user information that user entered in the payment dialog will be passed back in the webhook event. The charge_id from Paypal/Stripe will be passed to you for tracking the payment. You need to return HTTP status of 200 once you finished processing the event.

If the payment is a test payment, we will not charge the card but will send a result with dummy fb_payment_id/charge_id to you. You can do test payment with Stripe/Paypal only if your page has payment permission for now. Refers to How to Test Payment for details.

Tokenized Payment

If you are using tokenized payment, when user click on pay, we will send you a single-use Discover virtual card provisioned by PayPal. The card credential will be encrypted by the public key you provided in previous steps. You can then decrypt the tokenized card by following the detail steps here. After you successfully decoded the credential, you can then integrate with your preferred payment provider to charge the card. You need to return HTTP status of 200 once you finished processing the event.
If the payment is a test payment, you will get a dummy tokenized card back with the following dummy information (card_number: 4111111111111111, cvv: 123, expiry month: 11, expiry year: 2020). You can test tokenized payment even if your page/app has not been accepted to beta program. Refers to How to Test Payment for details.

Author:

Donato Rimenti

See Also:

Facebook's Messenger Platform Payment Callback Documentation, Facebook's Messenger Platform Buy Button Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
Payment()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
PaymentAmount	getAmount() Gets the amount.
String	getPayload() Gets the payload.
PaymentCredential	getPaymentCredential() Gets the paymentCredential.
RequestedUserInfo	getRequestedUserInfo() Gets the requestedUserInfo.
String	getShippingOptionId() Gets the shippingOptionId.
int	hashCode()
void	setAmount(PaymentAmount amount) Sets the amount.
void	setPayload(String payload) Sets the payload.
void	setPaymentCredential(PaymentCredential paymentCredential) Sets the paymentCredential.
void	setRequestedUserInfo(RequestedUserInfo requestedUserInfo) Sets the requestedUserInfo.
void	setShippingOptionId(String shippingOptionId) Sets the shippingOptionId.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Payment

public Payment()

Method Detail

getPayload

public String getPayload()

Gets the payload.

Returns:

the payload.

setPayload

public void setPayload(String payload)

Sets the payload.

Parameters:

payload - the payload to set.

getRequestedUserInfo

public RequestedUserInfo getRequestedUserInfo()

Gets the requestedUserInfo.

Returns:

the requestedUserInfo.

setRequestedUserInfo

public void setRequestedUserInfo(RequestedUserInfo requestedUserInfo)

Sets the requestedUserInfo.

Parameters:

requestedUserInfo - the requestedUserInfo to set.

getPaymentCredential

public PaymentCredential getPaymentCredential()

Gets the paymentCredential.

Returns:

the paymentCredential.

setPaymentCredential

public void setPaymentCredential(PaymentCredential paymentCredential)

Sets the paymentCredential.

Parameters:

paymentCredential - the paymentCredential to set.

getAmount

public PaymentAmount getAmount()

Gets the amount.

Returns:

the amount.

setAmount

public void setAmount(PaymentAmount amount)

Sets the amount.

Parameters:

amount - the amount to set.

getShippingOptionId

public String getShippingOptionId()

Gets the shippingOptionId.

Returns:

the shippingOptionId.

setShippingOptionId

public void setShippingOptionId(String shippingOptionId)

Sets the shippingOptionId.

Parameters:

shippingOptionId - the shippingOptionId to set.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object