Gateway Invoice API

 

Untitled_2024-03-18_23-56-22.png

This API will only do the callouts to the stripe system and not create a single gateway invoice record upon execution. When an invoice is created in the Stripe system, a webhook will pass an event (with the complete invoice details) to PosiPay. PosiPay will translate the raw JSON response from the event data and create its gateway invoice record in Salesforce.

Gateway Invoice (Attributes)

Gateway Invoice Field

Response Field

Gateway Invoice Field

Response Field

Amount Paid

amount_paid(Invoice)

Invoice ID

 id (Invoice)

Invoice Status

status(Invoice)

Payment Intent ID

payment_intent(Invoice)

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

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

 

Invoice Status

 data.object.status

If the status is “paid”, the Invoice Status is set to “Paid”.