Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Data Flow

...

 How to set up webhook in the Stripe Dashboard

How to populate Base URL on Gateway Account

o   Go to Setup and search All Sites on Quick Find

o   Copy the URL of the site that is accessible by Guest users.

o   Once copied, paste the URL on the base URL of the Gateway Account

o   When the gateway account is being saved, the Webhook Endpoint URL will get the base URL and concat the remaining text and its gateway account ID.

While we want Stripe to do the heavy lifting of the payment processing, you want to know what has happened, and have it recorded in your Salesforce org, so that you can maintain it as your single source of truth. To do this, you will utilise webhooks from Stripe. Every time an event occurs in Stripe, if you have set up the webhooks correctly, you will receive all the necessary data into Salesforce, ready for PosiPay to update your records.

Info

Please note that to avoid creating duplicate Gateway Events and to ensure successful Gateway Transaction and Gift Transaction processes, there should be only one webhook endpoint per Gateway Account in your org.

How to set up webhooks in the Stripe Dashboard

Go to Developers > Webhooks > Add endpoint.

...

When the Add endpoint is clicked, the image below will be shown

...

.

  • Endpoint URL = Get the Webhook Endpoint URl from your Gateway Account record.

  • Listen to = Events on you account

  • Select events to listen to = Refer to the screenshots below for the adding of events.

...

Choose which Stripe Events to listen to

You must select which events to listen to for each Stripe object. There are 3 objects that PosiPay needs to listen to. Each object has different events, so carefully select only what is needed. Wherever possible, do not select all events available.

...

Invoice Status

...

 

data.object.status

...

  1. Charge

    Image Removedimage-20240904-073805.pngImage Added

  2. Invoice

...

  1. Payouts

...

Invoices

...

Fundraising Extension uses invoices for gift transaction scheduled payments. PosiPayments needs to have a facility to listen to any invoice events.

The payload is sent out to salesforce from the stripe webhook.

...

Invoice payments can:

Request payment on specific future dates Automatically charge a payment

Payouts

After the payment, several things can happen. If the payment succeeds normally, you can focus on payout options from Stripe, sending email receipts, and triggering workflows to fulfill the customer’s order. When it’s more complicated, Stripe provides guidance for things like declined cards, refunds, disputes, and fraud. More about payouts here

How to configure payouts on your dashboard

 Go to Balances and click Manage. See the sample screenshot below.

...

When the Manage payout schedule is clicked, a user can select either manual or automatic.

...

More details about the payout schedule are here.

Gateway Event Mapping (Stripe → Salesforce)

Gateway Invoice Field

Response Field

Notes

Event ID

id (Event)

 

Raw Request

 

Full JSON body

Webhook Event Object

 

data.object.object

 

Gateway Account

 

data.object.metadata.gateway_id

 

Gateway Transaction Mapping (Stripe → Salesforce)

Gateway Invoice Field

Response Field

Notes

Payment Intent ID

data.object.charges.data.payment_ intent

 

Charge ID

data.object.latest_charge

 

Balance Transaction ID

 

data.object.charges.data.balance_ transaction

 

Amount

 

data.object.amount

 

Transaction Currency

 

data.object.currency

 

Payment Type

data.object.charges.data.payment_ method_details.type

If the type is “card”, the Payment Type is set to “Cards”.

If the type is “au_becs_debit”, the Payment Type is set to “Bank Debits”.

Transaction Status

 

data.object.status

If the status is “succeeded”, the Transaction Status is set to “Success”.

If the status is “processing”, the Transaction Status is set to “Pending”.

Otherwise, Transaction Status is set to “Failed”.

Payment Date

created

 

Decline Code

 

data.object.last_payment_error.de cline_code

  This field is hidden in the page layout if empty.

Result Code

data.object.last_payment_error.co de

  This field is hidden in the page layout if empty.

Result Message

data.object.last_payment_error.me ssage

  This field is hidden in the page layout if empty.

Gateway Invoice Mapping (Stripe → Salesforce)

...

Gateway Invoice Field

...

Response Field

...

Notes

...

Invoice ID

...

data.object.id (Event)

...

 

...

Payment Intent ID

...

 

data.object.payment_intent

...

 

...

Amount Paid

...

 

data.object.amount_paid

...

 

  1. Please note: If PosiPay version is 92 and above please do not include the invoice.created and invoice.updated event.

...

  1. Payouts

...

  1. Payment

  • payment_intent.canceled

...

  • payment_method.attached

    image-20241206-021022.pngImage Added
  • payment_method.automatically_updated

    image-20241206-021233.pngImage Added

  • payment_method.updated

    image-20241206-021321.pngImage Added

  1. Customer

  • customer.created

    image-20241206-015101.pngImage Added
  • customer.updated

    image-20241206-020515.pngImage Added

Next place to go: Step 5 - Schedule an Invoice