Payment Request Events
Payment Request Events are webhook notifications from GETTRX One that provide real-time updates on the status of payment requests. These events ensure you have visibility into each step of the payment lifecycle, from initiation to completion, enabling you to manage payment processing efficiently and respond proactively to status changes.
Subscribing to these events allows your system to automate workflows, notify stakeholders, or trigger custom actions based on the current status of a payment request.
Key Payment Request Webhook Events
Payment Request Succeeded (payment_request.succeeded)
Occurs when a payment has been successfully processed. This is the final status in the payment lifecycle, confirming that the transaction was completed without issues.
{
account: "acm_66b3230bd3f69300019e01ba",
attemptId: "wha_6750289481fe0d9f09390ab7",
created: "1733306513",
"data": {
"object": {
"charges": [
{
id: "ch_6750288bc3cc4b0d634a3861",
amount: 104,
amountCaptured: 104,
amountRefunded: 0,
lastPaymentError: null,
"billingDetails": {
"address": {
city: null,
country: "US",
line1: null,
line2: null,
postalCode: "85284",
state: null
},
email: null,
name: null,
phone: null
},
captured: true,
created: 1733306511,
currency: "usd",
customer: null,
description: "order(id:71|referenceCode:999) client(email:[email protected]|name:John Doe)",
failureCode: null,
failureMessage: null,
metadata: null,
onBehalfOf: "acm_66b3230bd3f69300019e01ba",
"outcome": {
networkStatus: "approved_by_network",
networkAuthorizationCode: "TAS494",
sellerMessage: "Payment complete.",
type: "authorized",
reason: null
},
paid: true,
paymentRequest: "pr_6750288bc3cc4b0d634a3860",
paymentMethod: "pm_6750288fc3cc4b0d634a3862",
"paymentMethodDetails": {
"card": {
brand: "visa",
"checks": {
addressLine1Check: null,
addressPostalCodeCheck: "pass",
cvcCheck: "pass"
},
expMonth: "12",
expYear: "28",
fingerprint: null,
last4: "5439",
"wallet": {
type: null,
applePayData: null,
googlePayData: null
}
},
usBankAccount: null,
type: "card",
metadata: null,
"billingDetails": {
"address": {
city: null,
country: "US",
line1: null,
line2: null,
postalCode: "85284",
state: null
},
email: null,
name: null,
phone: null
},
customer: null,
"mandate": {
"customerAcceptance": {
"online": {
ipAddress: "156.241.138.777",
userAgent: "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/131.0.0.0 Safari/537.36"
},
acceptedAt: "1733306506",
type: "online"
},
"paymentMethodDetails": {
type: "card"
},
status: "active",
type: "single_use",
displayedBySdk: false
},
setupBy: "pr_6750288bc3cc4b0d634a3860",
object: "payment_method"
},
receiptEmail: "[email protected]",
refunded: false,
"shipping": {
address: null,
name: null,
phone: null
},
statementDescriptor: null,
statementDescriptorSuffix: null,
terminalId: "88800000282601",
status: "succeeded",
capturedAt: 1733306511,
displayType: "sale",
refunds: null,
"splitFeeAmounts": [],
object: "charge"
}
],
"latestCharge": {
refunds: null,
customer: null,
"paymentMethodDetails": {
"mandate": {
"customerAcceptance": {
"online": {
ipAddress: "176.241.138.207",
userAgent: "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/131.0.0.0 Safari/537.36"
},
acceptedAt: "1733306506",
type: "online"
},
"paymentMethodDetails": {
type: "card"
},
status: "active",
type: "single_use",
displayedBySdk: false
},
"card": {
brand: "visa",
checks: null,
expMonth: "12",
expYear: "28",
fingerprint: null,
last4: "5439",
"wallet": {
type: null,
applePayData: null,
googlePayData: null
}
},
usBankAccount: null,
type: "card",
metadata: null,
"billingDetails": {
"address": {
city: null,
country: "US",
line1: null,
line2: null,
postalCode: "85284",
state: null
},
email: null,
name: null,
phone: null
},
customer: null,
setupBy: "pr_6750288bc3cc4b0d634a3860",
object: "payment_method"
},
id: "ch_6750288bc3cc4b0d634a3861",
amount: 104,
amountCaptured: 104,
amountRefunded: 0,
lastPaymentError: null,
"billingDetails": {
"address": {
city: null,
country: "US",
line1: null,
line2: null,
postalCode: "85284",
state: null
},
email: null,
name: null,
phone: null
},
captured: true,
created: 1733306511,
currency: "usd",
description: "order(id:71|referenceCode:999) client(email:[email protected]|name:John Doe)",
failureCode: null,
failureMessage: null,
metadata: null,
onBehalfOf: "acm_66b3230bd3f69300019e01ba",
"outcome": {
networkStatus: "approved_by_network",
networkAuthorizationCode: "TAS494",
sellerMessage: "Payment complete.",
type: "authorized",
reason: null
},
paid: true,
paymentRequest: "pr_6750288bc3cc4b0d634a3860",
paymentMethod: "pm_6750288fc3cc4b0d634a3862",
receiptEmail: "[email protected]",
refunded: false,
"shipping": {
address: null,
name: null,
phone: null
},
statementDescriptor: null,
statementDescriptorSuffix: null,
terminalId: "88800000282601",
status: "succeeded",
capturedAt: 1733306511,
displayType: "sale",
"splitFeeAmounts": [],
object: "charge"
},
customer: null,
id: "pr_6750288bc3cc4b0d634a3860",
amount: 104,
amountCapturable: 0,
"amountDetails": {
"tax": {
amount: null
}
},
amountReceived: 104,
captureMethod: "automatic",
created: 1733306511,
currency: "usd",
description: "order(id:71|referenceCode:999) client(email:[email protected]|name:John Doe)",
lastPaymentError: null,
"metadata": {
info: null
},
onBehalfOf: "acm_66b3230bd3f69300019e01ba",
paymentMethod: null,
paymentToken: "pt_6750288ac3cc4b0d634a385f",
receiptEmail: "[email protected]",
setupFutureUsage: null,
offSession: null,
"shipping": {
address: null,
name: null,
phone: null
},
statementDescriptor: null,
statementDescriptorSuffix: null,
status: "succeeded",
displayStatus: "succeeded",
canceled: false,
canceledAt: null,
cancelReason: null,
"splitFeeAmounts": [],
level2: false,
purchaseOrder: null,
"offSessionDetails": {
billingType: null,
paymentCount: null,
currentPaymentCount: null
},
object: "payment_request"
}
},
id: "evt_67502891778c0c7274a68803",
object: "event",
"request": {},
type: "payment_request.succeeded"
}
Payment Request Failed (payment_request.failed)
Occurs when a payment attempt fails due to reasons such as insufficient funds, network issues, or declined authorization. Use this event to notify merchants or customers of the failure and suggest corrective actions.
{
account: "acm_66b3230bd3f69300019e01ba",
attemptId: "wha_674471aa4c323c738955673b",
created: "1732538789",
"data": {
"object": {
"charges": [
{
id: "ch_674471a23b01f277bc6d23f7",
amount: 10.4,
amountCaptured: 0,
amountRefunded: 0,
lastPaymentError: null,
"billingDetails": {
"address": {
city: null,
country: "US",
line1: null,
line2: null,
postalCode: "12345",
state: null
},
email: null,
name: null,
phone: null
},
captured: false,
created: 1732538788,
currency: "usd",
customer: null,
description: "order(id:6|referenceCode:null) client(email:[email protected]|name:John Doe)",
failureCode: "card_decline",
failureMessage: "Your card's security code is invalid.",
metadata: null,
onBehalfOf: "acm_66b3230bd3f69300019e01ba",
"outcome": {
networkStatus: "declined_by_network",
networkAuthorizationCode: null,
sellerMessage: "The CVV code provided is invalid or does not match what is on file. The customer must provide the correct CVV.",
type: "issuer_declined",
reason: "invalid_cvv"
},
paid: false,
paymentRequest: "pr_674471a23b01f277bc6d23f6",
paymentMethod: "pm_674471a43b01f277bc6d23f8",
"paymentMethodDetails": {
"card": {
brand: "visa",
"checks": {
addressLine1Check: null,
addressPostalCodeCheck: null,
cvcCheck: "fail"
},
expMonth: "11",
expYear: "25",
fingerprint: null,
last4: "4242",
"wallet": {
type: null,
applePayData: null,
googlePayData: null
}
},
usBankAccount: null,
type: "card",
metadata: null,
"billingDetails": {
"address": {
city: null,
country: "US",
line1: null,
line2: null,
postalCode: "12345",
state: null
},
email: null,
name: null,
phone: null
},
customer: null,
"mandate": {
"customerAcceptance": {
"online": {
ipAddress: "94.230.204.215",
userAgent: "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/130.0.0.0 Safari/537.36"
},
acceptedAt: "1732538785",
type: "online"
},
"paymentMethodDetails": {
type: "card"
},
status: "active",
type: "single_use",
displayedBySdk: false
},
setupBy: "pr_674471a23b01f277bc6d23f6",
object: "payment_method"
},
receiptEmail: "[email protected]",
refunded: false,
shipping: null,
statementDescriptor: null,
statementDescriptorSuffix: null,
terminalId: "88800000282601",
status: "failed",
capturedAt: null,
displayType: "sale",
refunds: null,
"splitFeeAmounts": [],
object: "charge"
}
],
latestCharge: null,
customer: null,
id: "pr_674471a23b01f277bc6d23f6",
amount: 10.4,
amountCapturable: 0,
"amountDetails": {
"tax": {
amount: null
}
},
amountReceived: 0,
captureMethod: "automatic",
created: 1732538788,
currency: "usd",
description: "order(id:6|referenceCode:null) client(email:[email protected]|name:John Doe)",
"lastPaymentError": {
charge: "ch_674471a23b01f277bc6d23f7",
code: "card_decline",
declineCode: "invalid_cvv",
message: "Your card's security code is invalid.",
"outcome": {
networkStatus: "declined_by_network",
networkAuthorizationCode: null,
sellerMessage: "The CVV code provided is invalid or does not match what is on file. The customer must provide the correct CVV.",
type: "issuer_declined",
reason: "invalid_cvv"
},
"paymentMethod": {
id: "pm_674471a43b01f277bc6d23f8",
"billingDetails": {
"address": {
city: null,
country: "US",
line1: null,
line2: null,
postalCode: "12345",
state: null
},
email: null,
name: null,
phone: null
},
"card": {
brand: "visa",
"checks": {
addressLine1Check: null,
addressPostalCodeCheck: null,
cvcCheck: "fail"
},
expMonth: "11",
expYear: "2025",
fingerprint: null,
last4: "4242",
wallet: null
},
usBankAccount: null,
created: 1732538788,
customer: null,
"metadata": {
info: null
},
type: "card",
mandate: "mand_674471a4ea6fb9643fb13a9c",
object: "payment_method"
},
type: "payment_error",
terminalId: "88800000282601"
},
"metadata": {
info: null
},
onBehalfOf: "acm_66b3230bd3f69300019e01ba",
paymentMethod: null,
paymentToken: null,
receiptEmail: "[email protected]",
setupFutureUsage: null,
offSession: null,
shipping: null,
statementDescriptor: null,
statementDescriptorSuffix: null,
status: "requires_payment_method",
displayStatus: "failed",
canceled: false,
canceledAt: null,
cancelReason: null,
"splitFeeAmounts": [],
level2: false,
purchaseOrder: null,
"offSessionDetails": {
billingType: null,
paymentCount: null,
currentPaymentCount: null
},
object: "payment_request"
}
},
id: "evt_674471a5ea6fb9643fb13a9d",
object: "event",
"request": {},
type: "payment_request.failed"
}
Payment Request Canceled (payment_request.canceled)
Occurs when a payment request is canceled, either by the merchant, customer, or system. This event is useful for updating order statuses or triggering refunds if necessary.
{
account: "acm_65f48b068b8d6912fe07f302",
attemptId: "wha_6751e45b51b332980ef3a107",
created: "1733379166",
"data": {
"object": {
"charges": [
{
id: "ch_675144571b260933080d909a",
amount: 60.15,
amountCaptured: 0,
amountRefunded: 60.15,
lastPaymentError: null,
"billingDetails": {
"address": {
city: "Willmsland",
country: "LI",
line1: "463 Zboncak Cliffs Apt. 392",
line2: "920 Wisoky Center Suite 300",
postalCode: "68584",
state: "SC"
},
email: "[email protected]",
name: "John Doe",
phone: null
},
captured: false,
created: 1733379160,
currency: "usd",
customer: "cus_66e34169c4cbbf37be2f3997",
description: "withdrawal transaction at Lubowitz Inc using card ending with ***(...2468) for GBP 524.57 in account ***74806039",
failureCode: null,
failureMessage: null,
metadata: null,
onBehalfOf: "acm_65f48b068b8d6912fe07f302",
"outcome": {
networkStatus: "approved_by_network",
networkAuthorizationCode: "TAS961",
sellerMessage: "Payment complete.",
type: "authorized",
reason: null
},
paid: true,
paymentRequest: "pr_675144571b260933080d9099",
paymentMethod: "pm_66eb0cf98c00f56bd4e83724",
"paymentMethodDetails": {
"card": {
brand: "unknown",
"checks": {
addressLine1Check: null,
addressPostalCodeCheck: null,
cvcCheck: null
},
expMonth: "06",
expYear: "25",
fingerprint: null,
last4: "5439",
"wallet": {
type: null,
applePayData: null,
googlePayData: null
}
},
usBankAccount: null,
type: "card",
metadata: null,
"billingDetails": {
"address": {
city: "Willmsland",
country: "LI",
line1: "463 Zboncak Cliffs Apt. 392",
line2: "920 Wisoky Center Suite 300",
postalCode: "68584",
state: "SC"
},
email: "[email protected]",
name: "John Doe",
phone: null
},
customer: "cus_66e34169c4cbbf37be2f3997",
"mandate": {
"customerAcceptance": {
"online": {
ipAddress: null,
userAgent: null
},
acceptedAt: "1733358072",
type: "offline"
},
"paymentMethodDetails": {
type: "card"
},
status: "active",
type: "single_use",
displayedBySdk: false
},
setupBy: "setr_66eb0cfd8c00f56bd4e83726",
object: "payment_method"
},
receiptEmail: null,
refunded: true,
shipping: null,
statementDescriptor: null,
statementDescriptorSuffix: null,
terminalId: "88800000282601",
status: "canceled",
capturedAt: null,
displayType: "authorization",
"refunds": [
{
id: "re_6751445c1b260933080d90a4",
amount: 60.15,
charge: "ch_675144571b260933080d909a",
currency: "USD",
description: null,
metadata: null,
paymentRequest: "pr_675144571b260933080d9099",
reason: "fraudulent",
reasonNotes: "invoice transaction at Schimmel, Mayert and Schiller using card ending with ***(...0742) for BDT 243.35 in account ***88225758",
status: "succeeded",
created: "1733379165",
type: "online_return",
displayType: "reversal",
object: "refund"
}
],
"splitFeeAmounts": [],
object: "charge"
}
],
"latestCharge": {
"refunds": [
{
id: "re_6751445c1b260933080d90a4",
amount: 60.15,
charge: "ch_675144571b260933080d909a",
currency: "USD",
description: null,
metadata: null,
paymentRequest: "pr_675144571b260933080d9099",
reason: "fraudulent",
reasonNotes: "invoice transaction at Schimmel, Mayert and Schiller using card ending with ***(...0742) for BDT 243.35 in account ***88225758",
status: "succeeded",
created: "1733379165",
type: "online_return",
displayType: "reversal",
object: "refund"
}
],
customer: "cus_66e34169c4cbbf37be2f3997",
"paymentMethodDetails": {
"mandate": {
"customerAcceptance": {
"online": {
ipAddress: null,
userAgent: null
},
acceptedAt: "1733358072",
type: "offline"
},
"paymentMethodDetails": {
type: "card"
},
status: "active",
type: "single_use",
displayedBySdk: false
},
"card": {
brand: "unknown",
checks: null,
expMonth: "06",
expYear: "25",
fingerprint: null,
last4: "5439",
"wallet": {
type: null,
applePayData: null,
googlePayData: null
}
},
usBankAccount: null,
type: "card",
metadata: null,
"billingDetails": {
"address": {
city: "Willmsland",
country: "LI",
line1: "463 Zboncak Cliffs Apt. 392",
line2: "920 Wisoky Center Suite 300",
postalCode: "68584",
state: "SC"
},
email: "[email protected]",
name: "John Doe",
phone: null
},
customer: "cus_66e34169c4cbbf37be2f3997",
setupBy: "setr_66eb0cfd8c00f56bd4e83726",
object: "payment_method"
},
id: "ch_675144571b260933080d909a",
amount: 60.15,
amountCaptured: 0,
amountRefunded: 60.15,
lastPaymentError: null,
"billingDetails": {
"address": {
city: "Willmsland",
country: "LI",
line1: "463 Zboncak Cliffs Apt. 392",
line2: "920 Wisoky Center Suite 300",
postalCode: "68584",
state: "SC"
},
email: "[email protected]",
name: "Royce",
phone: null
},
captured: false,
created: 1733379160,
currency: "usd",
description: "withdrawal transaction at Lubowitz Inc using card ending with ***(...2468) for GBP 524.57 in account ***74806039",
failureCode: null,
failureMessage: null,
metadata: null,
onBehalfOf: "acm_65f48b068b8d6912fe07f302",
"outcome": {
networkStatus: "approved_by_network",
networkAuthorizationCode: "TAS961",
sellerMessage: "Payment complete.",
type: "authorized",
reason: null
},
paid: true,
paymentRequest: "pr_675144571b260933080d9099",
paymentMethod: "pm_66eb0cf98c00f56bd4e83724",
receiptEmail: null,
refunded: true,
shipping: null,
statementDescriptor: null,
statementDescriptorSuffix: null,
terminalId: "88800000282601",
status: "canceled",
capturedAt: null,
displayType: "authorization",
"splitFeeAmounts": [],
object: "charge"
},
"customer": {
id: "cus_66e34169c4cbbf37be2f3997",
"address": {
city: "North Calebfield",
country: "CM",
line1: "229 Kiera Coves Apt. 375",
line2: "687 Jenkins Springs Apt. 731",
postalCode: "73768",
state: "New Hampshire"
},
created: 1726169449,
description: "creator, person",
email: "[email protected]",
invoicePrefix: "D817FED4",
"invoiceSettings": {
customFields: null,
defaultPaymentMethod: "pm_675143b41b260933080d8f7f",
footer: null
},
name: "John Doe",
nextInvoiceSequence: null,
phone: "RS 7365694582",
deleted: false,
"shipping": {
"address": {
city: "North Sonya",
country: "US",
line1: "",
line2: "",
postalCode: "",
state: "US-CA"
},
name: "John Doe",
phone: "MX 3312501832"
},
object: "customer"
},
id: "pr_675144571b260933080d9099",
amount: 60.15,
amountCapturable: 60.15,
"amountDetails": {
"tax": {
amount: null
}
},
amountReceived: 0,
captureMethod: "manual",
created: 1733379160,
currency: "usd",
description: "withdrawal transaction at Lubowitz Inc using card ending with ***(...2468) for GBP 524.57 in account ***74806039",
lastPaymentError: null,
"metadata": {
info: null
},
onBehalfOf: "acm_65f48b068b8d6912fe07f302",
paymentMethod: null,
paymentToken: null,
receiptEmail: null,
setupFutureUsage: "off_session",
offSession: null,
shipping: null,
statementDescriptor: null,
statementDescriptorSuffix: null,
status: "requires_capture",
displayStatus: "canceled",
canceled: true,
canceledAt: 1733379165,
cancelReason: "fraudulent",
"splitFeeAmounts": [],
level2: false,
purchaseOrder: null,
"offSessionDetails": {
billingType: null,
paymentCount: null,
currentPaymentCount: null
},
object: "payment_request"
}
},
id: "evt_6751445e891a560145e266d5",
object: "event",
"request": {},
type: "payment_request.canceled"
}
Payment Request Requires Capture (payment_request.requires_capture)
Occurs when a payment has been authorized but requires a manual capture to complete the transaction. Use this event to automate capture processes or alert merchants to take action.
{
account: "acm_65f48b068b8d6912fe07f302",
attemptId: "wha_6751e4a358a6f9b75a1e82d8",
created: "1733379304",
"data": {
"object": {
"charges": [
{
id: "ch_675144e61b260933080d917b",
amount: 67.28,
amountCaptured: 0,
amountRefunded: 0,
lastPaymentError: null,
"billingDetails": {
"address": {
city: "Willmsland",
country: "LI",
line1: "463 Zboncak Cliffs Apt. 392",
line2: "920 Wisoky Center Suite 300",
postalCode: "68584",
state: "SC"
},
email: "[email protected]",
name: "Royce",
phone: null
},
captured: false,
created: 1733379303,
currency: "usd",
customer: "cus_66e34169c4cbbf37be2f3997",
description: "deposit transaction at John's Shoe Store using card ending with ***(...2952) for NAD 611.05 in account ***10913007",
failureCode: null,
failureMessage: null,
metadata: null,
onBehalfOf: "acm_65f48b068b8d6912fe07f302",
"outcome": {
networkStatus: "approved_by_network",
networkAuthorizationCode: "TAS080",
sellerMessage: "Payment complete.",
type: "authorized",
reason: null
},
paid: true,
paymentRequest: "pr_675144e61b260933080d917a",
paymentMethod: "pm_66eb0cf98c00f56bd4e83724",
"paymentMethodDetails": {
"card": {
brand: "visa",
"checks": {
addressLine1Check: "fail",
addressPostalCodeCheck: "fail",
cvcCheck: null
},
expMonth: "06",
expYear: "25",
fingerprint: null,
last4: "5439",
"wallet": {
type: null,
applePayData: null,
googlePayData: null
}
},
usBankAccount: null,
type: "card",
metadata: null,
"billingDetails": {
"address": {
city: "Willmsland",
country: "LI",
line1: "463 Zboncak Cliffs Apt. 392",
line2: "920 Wisoky Center Suite 300",
postalCode: "68584",
state: "SC"
},
email: "[email protected]",
name: "John Doe",
phone: null
},
customer: "cus_66e34169c4cbbf37be2f3997",
"mandate": {
"customerAcceptance": {
"online": {
ipAddress: null,
userAgent: null
},
acceptedAt: "1733358072",
type: "offline"
},
"paymentMethodDetails": {
type: "card"
},
status: "active",
type: "single_use",
displayedBySdk: false
},
setupBy: "setr_66eb0cfd8c00f56bd4e83726",
object: "payment_method"
},
receiptEmail: null,
refunded: false,
shipping: null,
statementDescriptor: null,
statementDescriptorSuffix: null,
terminalId: "88800000282601",
status: "succeeded",
capturedAt: null,
displayType: "authorization",
refunds: null,
"splitFeeAmounts": [],
object: "charge"
}
],
"latestCharge": {
refunds: null,
customer: "cus_66e34169c4cbbf37be2f3997",
"paymentMethodDetails": {
"mandate": {
"customerAcceptance": {
"online": {
ipAddress: null,
userAgent: null
},
acceptedAt: "1733358072",
type: "offline"
},
"paymentMethodDetails": {
type: "card"
},
status: "active",
type: "single_use",
displayedBySdk: false
},
"card": {
brand: "visa",
checks: null,
expMonth: "06",
expYear: "25",
fingerprint: null,
last4: "5439",
"wallet": {
type: null,
applePayData: null,
googlePayData: null
}
},
usBankAccount: null,
type: "card",
metadata: null,
"billingDetails": {
"address": {
city: "Willmsland",
country: "LI",
line1: "463 Zboncak Cliffs Apt. 392",
line2: "920 Wisoky Center Suite 300",
postalCode: "68584",
state: "SC"
},
email: "[email protected]",
name: "John Doe",
phone: null
},
customer: "cus_66e34169c4cbbf37be2f3997",
setupBy: "setr_66eb0cfd8c00f56bd4e83726",
object: "payment_method"
},
id: "ch_675144e61b260933080d917b",
amount: 67.28,
amountCaptured: 0,
amountRefunded: 0,
lastPaymentError: null,
"billingDetails": {
"address": {
city: "Willmsland",
country: "LI",
line1: "463 Zboncak Cliffs Apt. 392",
line2: "920 Wisoky Center Suite 300",
postalCode: "68584",
state: "SC"
},
email: "[email protected]",
name: "John Doe",
phone: null
},
captured: false,
created: 1733379303,
currency: "usd",
description: "deposit transaction at John's Shoe Store using card ending with ***(...2952) for NAD 611.05 in account ***10913007",
failureCode: null,
failureMessage: null,
metadata: null,
onBehalfOf: "acm_65f48b068b8d6912fe07f302",
"outcome": {
networkStatus: "approved_by_network",
networkAuthorizationCode: "TAS080",
sellerMessage: "Payment complete.",
type: "authorized",
reason: null
},
paid: true,
paymentRequest: "pr_675144e61b260933080d917a",
paymentMethod: "pm_66eb0cf98c00f56bd4e83724",
receiptEmail: null,
refunded: false,
shipping: null,
statementDescriptor: null,
statementDescriptorSuffix: null,
terminalId: "88800000282601",
status: "succeeded",
capturedAt: null,
displayType: "authorization",
"splitFeeAmounts": [],
object: "charge"
},
"customer": {
id: "cus_66e34169c4cbbf37be2f3997",
"address": {
city: "North Calebfield",
country: "CM",
line1: "229 Kiera Coves Apt. 375",
line2: "687 Jenkins Springs Apt. 731",
postalCode: "73768",
state: "New Hampshire"
},
created: 1726169449,
description: "creator, person",
email: "[email protected]",
invoicePrefix: "D817FED4",
"invoiceSettings": {
customFields: null,
defaultPaymentMethod: "pm_675143b41b260933080d8f7f",
footer: null
},
name: "John Doe",
nextInvoiceSequence: null,
phone: "RS 7365694582",
deleted: false,
"shipping": {
"address": {
city: "North Sonya",
country: "US",
line1: "",
line2: "",
postalCode: "",
state: "US-CA"
},
name: "Alvin Osinski",
phone: "MX 3312501832"
},
object: "customer"
},
id: "pr_675144e61b260933080d917a",
amount: 67.28,
amountCapturable: 67.28,
"amountDetails": {
"tax": {
amount: null
}
},
amountReceived: 0,
captureMethod: "manual",
created: 1733379303,
currency: "usd",
description: "deposit transaction at Bruen and Sons using card ending with ***(...2952) for NAD 611.05 in account ***10913007",
lastPaymentError: null,
"metadata": {
info: null
},
onBehalfOf: "acm_65f48b068b8d6912fe07f302",
paymentMethod: null,
paymentToken: null,
receiptEmail: null,
setupFutureUsage: "off_session",
offSession: null,
shipping: null,
statementDescriptor: null,
statementDescriptorSuffix: null,
status: "requires_capture",
displayStatus: "requires_capture",
canceled: false,
canceledAt: null,
cancelReason: null,
"splitFeeAmounts": [],
level2: false,
purchaseOrder: null,
"offSessionDetails": {
billingType: null,
paymentCount: null,
currentPaymentCount: null
},
object: "payment_request"
}
},
id: "evt_675144e8891a560145e268c3",
object: "event",
"request": {},
type: "payment_request.requires_capture"
}
Payment Request Processing (payment_request.processing)
Occurs when a payment request has started processing. This status helps track the initial phase of the transaction and can be used to update customers or merchants on the progress.
{
account: "acm_65f48b068b8d6912fe07f302",
attemptId: "wha_6751e4a22a06f5114ff24336",
created: "1733379310",
"data": {
"object": {
"charges": [
{
id: "ch_675144ed1b260933080d9189",
amount: 26.04,
amountCaptured: 26.04,
amountRefunded: null,
lastPaymentError: null,
"billingDetails": {
"address": {
city: "Magdalenside",
country: "LK",
line1: "5783 Princess Street Suite 963",
line2: "2700 Hillside Suite 278",
postalCode: "60525",
state: "MO"
},
email: "[email protected]",
name: "John Doe",
phone: "+522614100790"
},
captured: false,
created: 1733379309,
currency: "usd",
customer: "cus_66e34169c4cbbf37be2f3997",
description: "deposit transaction at John's Shoe Store using card ending with ***(...9514) for BIF 184.45 in account ***19058456",
failureCode: null,
failureMessage: null,
metadata: null,
onBehalfOf: "acm_65f48b068b8d6912fe07f302",
"outcome": {
networkStatus: "approved_by_network",
networkAuthorizationCode: null,
sellerMessage: "Payment complete.",
type: "authorized",
reason: null
},
paid: false,
paymentRequest: "pr_675144ed1b260933080d9188",
paymentMethod: "pm_66ede841259c4151e6bf5dcd",
"paymentMethodDetails": {
card: null,
"usBankAccount": {
accountHolderType: "company",
accountType: "savings",
last4: "5945",
routingNumber: "121000358",
fingerPrint: null
},
type: "us_bank_account",
metadata: null,
"billingDetails": {
"address": {
city: "Magdalenside",
country: "LK",
line1: "5783 Princess Street Suite 963",
line2: "2700 Hillside Suite 278",
postalCode: "60525",
state: "MO"
},
email: "[email protected]",
name: "John Doe",
phone: "+522614100790"
},
customer: "cus_66e34169c4cbbf37be2f3997",
"mandate": {
"customerAcceptance": {
"online": {
ipAddress: null,
userAgent: null
},
acceptedAt: "1726867521",
type: "offline"
},
"paymentMethodDetails": {
type: "us_bank_account"
},
status: "active",
type: "single_use",
displayedBySdk: false
},
setupBy: "setr_66ede841259c4151e6bf5dcf",
object: "payment_method"
},
receiptEmail: null,
refunded: null,
shipping: null,
statementDescriptor: null,
statementDescriptorSuffix: null,
terminalId: null,
status: "pending",
capturedAt: null,
displayType: "sale",
refunds: null,
"splitFeeAmounts": [],
object: "charge"
}
],
"latestCharge": {
refunds: null,
customer: "cus_66e34169c4cbbf37be2f3997",
"paymentMethodDetails": {
"mandate": {
"customerAcceptance": {
"online": {
ipAddress: null,
userAgent: null
},
acceptedAt: "1726867521",
type: "offline"
},
"paymentMethodDetails": {
type: "us_bank_account"
},
status: "active",
type: "single_use",
displayedBySdk: false
},
card: null,
"usBankAccount": {
accountHolderType: "company",
accountType: "savings",
last4: "5945",
routingNumber: "121000358",
fingerPrint: null
},
type: "us_bank_account",
metadata: null,
"billingDetails": {
"address": {
city: "Magdalenside",
country: "LK",
line1: "5783 Princess Street Suite 963",
line2: "2700 Hillside Suite 278",
postalCode: "60525",
state: "MO"
},
email: "[email protected]",
name: "John Doe",
phone: "+522614100790"
},
customer: "cus_66e34169c4cbbf37be2f3997",
setupBy: "setr_66ede841259c4151e6bf5dcf",
object: "payment_method"
},
id: "ch_675144ed1b260933080d9189",
amount: 26.04,
amountCaptured: 26.04,
amountRefunded: null,
lastPaymentError: null,
"billingDetails": {
"address": {
city: "Magdalenside",
country: "LK",
line1: "5783 Princess Street Suite 963",
line2: "2700 Hillside Suite 278",
postalCode: "60525",
state: "MO"
},
email: "[email protected]",
name: "Kimberly",
phone: "+522614100790"
},
captured: false,
created: 1733379309,
currency: "usd",
description: "deposit transaction at John's Shoe Store using card ending with ***(...9514) for BIF 184.45 in account ***19058456",
failureCode: null,
failureMessage: null,
metadata: null,
onBehalfOf: "acm_65f48b068b8d6912fe07f302",
"outcome": {
networkStatus: "approved_by_network",
networkAuthorizationCode: null,
sellerMessage: "Payment complete.",
type: "authorized",
reason: null
},
paid: false,
paymentRequest: "pr_675144ed1b260933080d9188",
paymentMethod: "pm_66ede841259c4151e6bf5dcd",
receiptEmail: null,
refunded: null,
shipping: null,
statementDescriptor: null,
statementDescriptorSuffix: null,
terminalId: null,
status: "pending",
capturedAt: null,
displayType: "sale",
"splitFeeAmounts": [],
object: "charge"
},
"customer": {
id: "cus_66e34169c4cbbf37be2f3997",
"address": {
city: "North Calebfield",
country: "CM",
line1: "229 Kiera Coves Apt. 375",
line2: "687 Jenkins Springs Apt. 731",
postalCode: "73768",
state: "New Hampshire"
},
created: 1726169449,
description: "creator, person",
email: "[email protected]",
invoicePrefix: "D817FED4",
"invoiceSettings": {
customFields: null,
defaultPaymentMethod: "pm_675143b41b260933080d8f7f",
footer: null
},
name: "John Doe",
nextInvoiceSequence: null,
phone: "RS 7365694582",
deleted: false,
"shipping": {
"address": {
city: "North Sonya",
country: "US",
line1: "",
line2: "",
postalCode: "",
state: "US-CA"
},
name: "John Doe",
phone: "MX 3312501832"
},
object: "customer"
},
id: "pr_675144ed1b260933080d9188",
amount: 26.04,
amountCapturable: null,
"amountDetails": {
"tax": {
amount: null
}
},
amountReceived: 26.04,
captureMethod: "automatic",
created: 1733379309,
currency: "usd",
description: "deposit transaction at John Doe using card ending with ***(...9514) for BIF 184.45 in account ***19058456",
lastPaymentError: null,
"metadata": {
info: null
},
onBehalfOf: "acm_65f48b068b8d6912fe07f302",
paymentMethod: null,
paymentToken: null,
receiptEmail: null,
setupFutureUsage: "off_session",
offSession: null,
shipping: null,
statementDescriptor: null,
statementDescriptorSuffix: null,
status: "pending",
displayStatus: "processing",
canceled: false,
canceledAt: null,
cancelReason: null,
"splitFeeAmounts": [],
level2: false,
purchaseOrder: null,
"offSessionDetails": {
billingType: null,
paymentCount: null,
currentPaymentCount: null
},
object: "payment_request"
}
},
id: "evt_675144ee891a560145e268d5",
object: "event",
"request": {},
type: "payment_request.processing"
}
Best Practices for Payment Request Events
Monitor Transaction Status:
Use payment_request.succeeded and payment_request.failed to confirm completed payments or handle failed transactions proactively.
Automate Actions:
Trigger order fulfillment workflows when you receive payment_request.succeeded. Notify customers or retry payments automatically when payment_request.failed is received.
Support Authorization Workflows:
Integrate payment_request.requires_capture into your system to streamline manual or automated capture processes.
Use this event for transactions that require delayed settlement.
Keep Customers Informed:
Leverage payment_request.processing to provide real-time updates to customers, enhancing transparency and trust.
By subscribing to these events, you gain granular control over the payment lifecycle, improving operational efficiency and customer satisfaction.
Updated 3 months ago