Events

Our event publishing system allows you to subscribe to certain events on the JustiFi platform. Once subscribed, your application will be notified anytime those events occur, so you can react accordingly in real time. We support two event-delivery mechanisms; you can receive them via webhooks or directly to an AWS Eventbridge event bus. This service is available to you whether you're operating as a Seller yourself, or as a Platform with multiple Sellers. As a Platform, you can subscribe to all of your Sellers' events.

We will publish the following events:

payment.created
payment.succeeded
payment.failed
payment.pending
payment.authorized
payment.captured
payment.refunded
payment.refund.updated
payment.dispute.created
payment.dispute.closed
payment_method.created
payment_method.updated
payment_intent.attached
payment_intent.created
payment_intent.requires_capture
payment_intent.succeeded
payout.created
payout.paid
payout.failed
seller_account.updated
sub_account.updated
application_fee_rate.created
application_fee_rate.updated

PaymentsWebhook

Received for the following events: payment.created, payment.succeeded, payment.failed, payment.pending, payment.authorized, payment.captured

Request

Request Body schema: application/json

id	string event unique id
idempotency_key	string or null idempotency key for request, when available
request_id	string or null id for request, when available
account_id	string sub account id for event
account_type	string live or test account
platform_account_id	string or null platform account id for event, when available
	object or object
version	string version of the event payload
event_name	string name of the event (ex: payment.succeed, sub_account.updated)

Responses

200

Return a 200 status to indicate that the data was received successfully. You must respond within 5 seconds.

Request samples

Payload

application/json

{"id": "evt_123xyz",
"account_id": "acc_123xyz",
"account_type": "test",
"platform_account_id": "acc_987zyx",
"idempotency_key": "string",
"request_id": "req_123",
"version": "v1",
"data": {"id": "py_xyz",
"account_id": "acc_123xyz",
"amount_disputed": 0,
"amount_refunded": 0,
"amount_returned": 0,
"amount": 10000,
"amount_refundable": 10000,
"application_fee_rate_id": "afr_123xyz",
"balance": 99850,
"capture_strategy": "automatic",
"captured": true,
"created_at": "2021-01-01T12:00:00Z",
"currency": "usd",
"description": "my order xyz",
"disputed": false,
"error_code": null,
"error_description": null,
"fee_amount": 150,
"financial_transaction_id": "ft_123xyz",
"is_test": true,
"metadata": { },
"payment_intent_id": "pi_xyz",
"refunded": false,
"returned": false,
"status": "succeeded",
"updated_at": "2021-01-01T12:00:00Z",
"payment_method": {"card": {"id": "pm_123xyz",
"acct_last_four": "4242",
"brand": "visa",
"name": "Sylvia Fowles",
"token": "pm_123xyz",
"metadata": { },
"created_at": "2021-01-01T12:00:00Z",
"updated_at": "2021-01-01T12:00:00Z"
},
"customer_id": null,
"signature": "123abc"
},
"application_fee": {"id": "fee_123xyz",
"amount": 150,
"currency": "usd",
"created_at": "2021-01-01T12:00:00Z",
"updated_at": "2021-01-01T12:00:00Z"
},
"refunds": [ ],
"disputes": [ ]
},
"event_name": "payment.created"
}

Payment IntentsWebhook

Received for the following events: payment_intent.attached, payment_intent.created, payment_intent.requires_capture, payment_intent.succeeded

Request

Request Body schema: application/json

id	string event unique id
idempotency_key	string or null idempotency key for request, when available
request_id	string or null id for request, when available
account_id	string sub account id for event
account_type	string live or test account
platform_account_id	string or null platform account id for event, when available
	object or object
version	string version of the event payload
event_name	string name of the event (ex: payment.succeed, sub_account.updated)

Responses

200

Return a 200 status to indicate that the data was received successfully. You must respond within 5 seconds.

Request samples

Payload

application/json

{"id": "evt_123xyz",
"account_id": "acc_123xyz",
"account_type": "test",
"platform_account_id": "acc_987zyx",
"idempotency_key": "string",
"request_id": "req_123",
"version": "v1",
"data": {"id": "pi_xyz",
"account_id": "acc_123xyz",
"amount": 10000,
"currency": "usd",
"description": "my order xyz",
"last_error": null,
"metadata": { },
"status": "succeeded",
"payment_method": {"customer_id": null,
"signature": "123abc",
"card": {"id": "pm_123xyz",
"name": "Sylvia Fowles",
"acct_last_four": "4242",
"brand": "visa",
"token": "pm_123xyz",
"month": "5",
"year": "2042",
"metadata": { },
"address_line1_check": "pass",
"address_postal_code_check": "pass"
},
"created_at": "2021-01-01T12:00:00Z",
"updated_at": "2021-01-01T12:00:00Z"
}
},
"event_name": "payment_intent.succeeded"
}

Payment MethodsWebhook

Received for the following events: payment_method.created, payment_method.updated

Request

Request Body schema: application/json

id	string event unique id
idempotency_key	string or null idempotency key for request, when available
request_id	string or null id for request, when available
account_id	string sub account id for event
account_type	string live or test account
platform_account_id	string or null platform account id for event, when available
	object or object
version	string version of the event payload
event_name	string name of the event (ex: payment.succeed, sub_account.updated)

Responses

200

Return a 200 status to indicate that the data was received successfully. You must respond within 5 seconds.

Request samples

Payload

application/json

{"id": "evt_123xyz",
"account_id": "acc_123xyz",
"account_type": "test",
"platform_account_id": "acc_456abc",
"idempotency_key": "30abie390hjag49h",
"request_id": "req_100abc",
"version": "v1",
"data": {"signature": "9fxy123",
"customer_id": "cust_987zyx",
"card": {"id": "pm_123xyz",
"name": "Sylvia Fowles",
"acct_last_four": "4242",
"brand": "visa",
"token": "pm_123xyz",
"month": "5",
"year": "2042",
"metadata": { },
"address_line1_check": "pass",
"address_postal_code_check": "pass"
}
},
"event_name": "payment_method.created"
}

RefundsWebhook

Received for the following events: payment.refunded, payment.refund.updated

Request

Request Body schema: application/json

id	string event unique id
idempotency_key	string or null idempotency key for request, when available
request_id	string or null id for request, when available
account_id	string sub account id for event
account_type	string live or test account
platform_account_id	string or null platform account id for event, when available
	object the attributes for the object
version	string version of the event payload
event_name	string name of the event (ex: payment.succeed, sub_account.updated)

Responses

200

Return a 200 status to indicate that the data was received successfully. You must respond within 5 seconds.

Request samples

Payload

application/json

{"id": "evt_123xyz",
"idempotency_key": "string",
"request_id": "string",
"account_id": "acc_123xyz",
"account_type": "test",
"platform_account_id": "acc_123xyz",
"data": {"id": "re_xyz",
"payment_id": "py_xyz",
"amount": 100,
"description": "customer canceled their order",
"reason": "duplicate",
"status": "succeeded",
"metadata": { },
"created_at": "2021-01-01T12:00:00Z",
"updated_at": "2021-01-01T12:00:00Z"
},
"version": "v1",
"event_name": "string"
}

DisputesWebhook

Received for the following events: payment.dispute.created, payment.dispute.closed

Request

Request Body schema: application/json

id	string event unique id
idempotency_key	string or null idempotency key for request, when available
request_id	string or null id for request, when available
account_id	string sub account id for event
account_type	string live or test account
platform_account_id	string or null platform account id for event, when available
	object the attributes for the object
version	string version of the event payload
event_name	string name of the event (ex: payment.succeed, sub_account.updated)

Responses

200

Return a 200 status to indicate that the data was received successfully. You must respond within 5 seconds.

Request samples

Payload

application/json

{"id": "evt_123xyz",
"idempotency_key": "string",
"request_id": "string",
"account_id": "acc_123xyz",
"account_type": "test",
"platform_account_id": "acc_123xyz",
"data": {"id": "dp_xyz",
"amount": 100,
"currency": "usd",
"payment_id": "py_xyz",
"reason": "fraudulent",
"status": "won",
"metadata": { },
"created_at": "2021-01-01T12:00:00Z",
"updated_at": "2021-01-01T12:00:00Z"
},
"version": "v1",
"event_name": "string"
}

PayoutsWebhook

Received for the following events: payout.created, payout.paid, payout.failed

Request

Request Body schema: application/json

id	string event unique id
idempotency_key	string or null idempotency key for request, when available
request_id	string or null id for request, when available
account_id	string sub account id for event
account_type	string live or test account
platform_account_id	string or null platform account id for event, when available
	object the attributes for the object
version	string version of the event payload
event_name	string name of the event (ex: payment.succeed, sub_account.updated)

Responses

200

Return a 200 status to indicate that the data was received successfully. You must respond within 5 seconds.

Request samples

Payload

application/json

{"id": "evt_123xyz",
"idempotency_key": "string",
"request_id": "string",
"account_id": "acc_123xyz",
"account_type": "test",
"platform_account_id": "acc_123xyz",
"data": {"id": "po_xyz",
"account_id": "449e7a5c-69d3-4b8a-aaaf-5c9b713ebc65",
"amount": 100000,
"bank_account": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"full_name": "string",
"bank_name": "string",
"account_number_last4": 1111,
"routing_number": "string",
"country": "US",
"currency": "usd",
"nickname": "string",
"account_type": "checking"
},
"currency": "usd",
"delivery_method": "standard",
"description": "string",
"deposits_at": "2021-01-01T12:00:00Z",
"fees_total": 5000,
"refunds_count": 5,
"refunds_total": 10000,
"payments_count": 50,
"payments_total": 110000,
"payout_type": "ach cc",
"other_total": 100,
"status": "paid",
"metadata": {"customer_payout_id": "cp_12345"
},
"created_at": "2021-01-01T12:00:00Z",
"updated_at": "2021-01-01T12:00:00Z"
},
"version": "v1",
"event_name": "string"
}

Sub AccountsWebhook

Received for the following events: sub_account.updated. This is published when an account's status changes.

Request

Request Body schema: application/json

id	string event unique id
idempotency_key	string or null idempotency key for request, when available
request_id	string or null id for request, when available
account_id	string sub account id for event
account_type	string live or test account
platform_account_id	string or null platform account id for event, when available
	object the attributes for the object
version	string version of the event payload
event_name	string name of the event (ex: payment.succeed, sub_account.updated)

Responses

200

Return a 200 status to indicate that the data was received successfully. You must respond within 5 seconds.

Request samples

Payload

application/json

{"id": "evt_123xyz",
"idempotency_key": "string",
"request_id": "string",
"account_id": "acc_123xyz",
"account_type": "test",
"platform_account_id": "acc_123xyz",
"data": {"id": "acc_xyz",
"name": "The Shire Haberdashery",
"account_type": "live",
"status": "enabled",
"currency": "usd",
"platform_account_id": "acc_xyz",
"application_fee_rates": [ ],
"processing_ready": false,
"payout_ready": false,
"related_accounts": {"live_account_id": "acc_xyz",
"test_account_id": "acc_xyz"
},
"created_at": "2021-01-01T12:00:00Z",
"updated_at": "2021-01-01T12:00:00Z"
},
"version": "v1",
"event_name": "string"
}

Application Fee RatesWebhook

Received for the following events: application_fee_rate.created, application_fee_rate.updated

Request

Request Body schema: application/json

id	string event unique id
idempotency_key	string or null idempotency key for request, when available
request_id	string or null id for request, when available
account_id	string sub account id for event
account_type	string live or test account
platform_account_id	string or null platform account id for event, when available
	object the attributes for the object
version	string version of the event payload
event_name	string name of the event (ex: payment.succeed, sub_account.updated)

Responses

200

Return a 200 status to indicate that the data was received successfully. You must respond within 5 seconds.

Request samples

Payload

application/json

{"id": "evt_123xyz",
"idempotency_key": "string",
"request_id": "string",
"account_id": "acc_123xyz",
"account_type": "test",
"platform_account_id": "acc_123xyz",
"data": {"id": "afr_123xyz",
"transaction_fee": 50,
"currency": "usd",
"basis_point_rate": 250,
"rate_type": "cc",
"created_at": "2021-01-01T12:00:00Z",
"updated_at": "2021-01-01T12:00:00Z",
"effective_start": "2021-01-01T12:00:00Z",
"effective_end": "2021-01-01T12:00:00Z"
},
"version": "v1",
"event_name": "string"
}

➔ Next to EventBridge (AWS) Delivery