List of Webhook Events
Each business flow in Finix (e.g creating an authorization, creating an identity, provisioning a merchant, refunding a debit, etc.) has several events that triggers webhooks.
This table details the business flow when given an entity and type:
entity |
type |
Description |
|---|---|---|
application |
created |
An Application was created. This is only sent to Core customers. |
application |
updated |
An Application was updated. This is only sent to Core customers. |
application_profile |
created |
An Application Profile was created. This is only sent to Core customers. |
application_profile |
updated |
An Application Profile was updated. This is only sent to Core customers. |
authorization |
created |
An authorization was created. It still needs to be captured. |
authorization |
updated |
An authorization was updated. If it was captured, you are sent an event for the corresponding transfer that was created. For voids, the void_state will be PENDING. |
balance_transfer |
created |
A Balance Transfer was created. This is only sent to Core customers. |
balance_transfer |
updated |
A Balance Transfer was updated. This is only sent to Core customers. |
compliance_form |
created |
A Compliance Form was created. You need to get your user to complete the compliance form |
compliance_form |
updated |
A Compliance Form has been updated. Commonly sent when the form has been completed. |
dispute |
created |
A Dispute was created. A chargeback dispute was started. |
dispute |
updated |
A Dispute was updated. Usually this occurs when the dispute's state has changed. |
evidence |
created |
An evidence file was uploaded. |
evidence |
updated |
An evidence file was updated. Usually, the state of the evidence has changed. |
external_link |
created |
An external_link was created. You need to have your user upload a file via the link. |
external_link |
updated |
An external_link was updated. Usually sent when the external_link has expired. |
fee |
created |
A custom fee was created. This occurs as part of subscription billing. |
fee |
updated |
A custom fee was updated. |
fee_profile |
created |
A Fee Profile was created. This happens as part of creating a merchant. |
fee_profile |
updated |
A Fee Profile was updated. |
file |
created |
A File was created. It still needs a document to be uploaded to Finix. |
file |
updated |
A File was updated. Usually send when a document was uploaded. |
identity |
created |
An Identity was created. Usually occurs during onboarding or when processing a payment. |
identity |
updated |
An Identity was updated. |
instrument |
created |
A Payment Instrument was created. The payment_instrument.type tells you what type of payment instrument was created. |
instrument |
updated |
A Payment Instrument was updated. |
instrument_update |
created |
An instrument update batch file was uploaded. |
instrument_update |
updated |
An Instrument Update was updated. Usually this is the state to SUCCEEDED or FAILED. |
merchant |
created |
A Merchant was created and is PROVISIONING. |
merchant |
updated |
A Merchant was updated. Typically, this happens to PROVISIONING Merchants during the onboarding process. The Merchant's onboarding_state will let you know if the Merchant is APPROVED, REJECTED, or UPDATE_REQUESTED. |
merchant |
underwritten |
A Merchant was underwritten and APPROVED, and is ready to start accepting payments. |
merchant_profile |
created |
A Merchant Profile was created. This happens as part of creating a merchant. |
merchant_profile |
updated |
A Merchant Profile was updated. This happens when the tags were updated. |
onboarding_form |
created |
An onboarding_form was created. This lets you know a seller has begun onboarding. |
onboarding_form |
updated |
An onboarding_form was updated. This lets you know the seller has completed the onboarding_form. |
payout_profile |
created |
The payout settings of a Merchant were changed or updated. |
risk_profile |
created |
A risk_profile was created. Usually this happens when a merchant_profile is created. |
risk_profile |
updated |
A risk_profile was updated. This happens when the tags were updated. |
settlement |
accruing_started |
A Settlement has started accruing transactions. |
settlement |
created |
A Settlement was closed. settlements.total_amount and settlements.net_amount tells you the total of the payout. |
settlement |
updated |
A Settlement is awaiting approval. |
transfer |
created |
A transfer was created. The transfer.type and transfer.state tell you what type of transfer occurred and whether it is PENDING or SUCCEEDED. |
transfer |
updated |
A transfer was updated. The transfer tells you the snapshot of the transfer at that moment of time. |
verification |
created |
A verification was created. The verification.state will tell you if the request was APPROVED or REJECTED. |
verification |
updated |
A verification was updated. This commonly happens when provisioning merchants and verifying payment instruments. |
Sample Payloads
Every activity in Finix triggers several events. e.g. Capturing a Transfer can lead from anywhere between five to ten events getting delivered.
Below is a list of example events and the activities in Finix that triggered them. While you may receive several events, keep an eye out for an event that looks like any example below to confirm the related activity occurred or completed in Finix.
Authorization Created
The event that gets sent when an Authorization is created.
{
"type": "updated",
"entity": "authorization",
"occurred_at": "2020-04-26T22:58 :30.584",
"_embedded": {
"authorizations": [
{
"idempotency_id": null,
"amount": 100,
"trace_id": "db10f58f-b56b-4a38-bec2-7fd46e5569f4",
"raw": null,
"created_at": "2020-04-26T22:58:30.41Z",
"source": "PI5JEJTNwLzZ8rMMFV9QkaHz",
"merchant": "MUeDVrf2ahuKc9Eg5TeZugvs",
"merchant_identity": "IDdpvBpQ9m6D3JDCRq9UDB2E",
"tags": {
"order_number": "21DFASJSAKAS"
},
"3ds_redirect_url": null,
"void_state": "UNATTEMPTED",
"transfer": null,
"expires_at": "2020-05-03T22:58:30.41Z",
"application": "APkBUdiWzBjUAkfnbkirXs6d",
"updated_at": "2020-04-26T22:58:30.52Z",
"is_void": false,
"messages": [],
"currency": "USD",
"id": "AUWgEWUiRvi5PCeBaPHcfti",
"state": "SUCCEEDED"
}
]
}
}Authorization Captured
The event that gets sent when an Authorization gets captured. The event has authorizations.transfer populated:
-
type: updated -
entity: authorization -
_embedded.authorizations[0].transfer: {{transfer_id}}
{
"type": "updated",
"entity": "authorization",
"occurred_at": "2020-04-26T23:00:23.467",
"_embedded": {
"authorizations": [
{
"idempotency_id": null,
"amount": 100,
"trace_id": "db10f58f-b56b-4a38-bec2-7fd46e5569f4",
"raw": null,
"created_at": "2020-04-26T22:58:30.41Z",
"source": "PI5JEJTNwLzZ8rMMFV9QkaHz",
"merchant": "MUeDVrf2ahuKc9Eg5TeZugvs",
"merchant_identity": "IDdpvBpQ9m6D3JDCRq9UDB2E",
"tags": {
"order_number": "21DFASJSAKAS"
},
"3ds_redirect_url": null,
"void_state": "UNATTEMPTED",
"transfer": "TRL2VyFmBBLKcR5nqbhcHRQ",
"expires_at": "2020-05-03T22:58:30.41Z",
"application": "APkBUdiWzBjUAkfnbkirXs6d",
"updated_at": "2020-04-26T23:00:23.05Z",
"is_void": false,
"messages": [],
"currency": "USD",
"id": "AUWgEWUiRvi5PCeBaPHcfti",
"state": "SUCCEEDED"
}
]
}
}Authorization Voided
The event that gets sent when an authorization is voided.
{
"type": "updated",
"entity": "authorization",
"occurred_at": "2020-04-26T23:04:04.585",
"_embedded": {
"authorizations": [
{
"idempotency_id": null,
"amount": 100,
"trace_id": "894b3aaa-f839-4b73-9664-2605c5c952ba",
"raw": null,
"created_at": "2020-04-26T23:03:12.76Z",
"source": "PI5JEJTNwLzZ8rMMFV9QkaHz",
"merchant": "MUeDVrf2ahuKc9Eg5TeZugvs",
"merchant_identity": "IDdpvBpQ9m6D3JDCRq9UDB2E",
"tags": {
"order_number": "21DFASJSAKAS"
},
"3ds_redirect_url": null,
"void_state": "PENDING",
"transfer": null,
"expires_at": "2020-05-03T23:03:12.76Z",
"application": "APkBUdiWzBjUAkfnbkirXs6d",
"updated_at": "2020-04-26T23:04:04.52Z",
"is_void": true,
"messages": [],
"currency": "USD",
"id": "AUJKRcCGbLVQAGrAt5FY4wy",
"state": "SUCCEEDED"
}
]
}
}Authorization with an EMV Card (Card Present)
The events that get sent when an authorization` gets created with an EMV card.
Identity Created
The event you receive when an Identity gets created. The new Identity gets used to create the Payment Instrument for the EMV card.
{
"type": "created",
"entity": "identity",
"occurred_at": "2020-04-29T20:31:03.097",
"_embedded": {
"identitys": [
{
"application": "APiDZzAY28F2uSz47L88EuPk",
"updated_at": "2020-04-29T20:31:03.01Z",
"created_at": "2020-04-29T20:31:03.01Z",
"id": "IDd76bhnKyKTjzbqwd939WnV",
"entity": {
"title": null,
"first_name": null,
"last_name": null,
"email": null,
"business_name": null,
"business_type": null,
"doing_business_as": null,
"phone": null,
"business_phone": null,
"personal_address": null,
"business_address": null,
"mcc": null,
"dob": null,
"max_transaction_amount": 0,
"amex_mid": null,
"discover_mid": null,
"url": null,
"annual_card_volume": 0,
"has_accepted_credit_cards_previously": false,
"incorporation_date": null,
"principal_percentage_ownership": null,
"short_business_name": null,
"ownership_type": null,
"tax_authority": null,
"tax_id_provided": false,
"business_tax_id_provided": false,
"default_statement_descriptor": null
},
"identity_roles": [],
"tags": {}
}
]
}
}Payment Instrument Created
The event you receive when a Payment Instrument gets created for an EMV card.
{
"type": "created",
"entity": "instrument",
"occurred_at": "2020-04-29T20:31:03.284",
"_embedded": {
"instruments": [
{
"application": "APiDZzAY28F2uSz47L88EuPk",
"updated_at": "2020-04-29T20:31:03.23Z",
"identity": "IDd76bhnKyKTjzbqwd939WnV",
"fingerprint": "FPR5w2uCguRwhbtWmcJmirkhf",
"created_at": "2020-04-29T20:31:03.23Z",
"currency": "USD",
"id": "PIaZwAfmK2YBX9bUT44uvCLa",
"instrument_type": "PAYMENT_CARD_PRESENT",
"type": "PAYMENT_CARD_PRESENT",
"tags": {}
}
]
}
}Authorization Created
The event you receive when an Authorization gets created.
{
"type": "created",
"entity": "authorization",
"occurred_at": "2020-04-29T20:31:17.059",
"_embedded": {
"authorizations": [
{
"idempotency_id": null,
"amount": 1000,
"trace_id": "FNX7jwSr5QhQdR2E4PZkLxYTW",
"raw": null,
"created_at": "2020-04-29T20:31:03.39Z",
"source": "PIaZwAfmK2YBX9bUT44uvCLa",
"merchant": "MUeDVrf2ahuKc9Eg5TeZugvs",
"merchant_identity": "IDd76bhnKyKTjzbqwd939WnV",
"tags": {},
"3ds_redirect_url": null,
"void_state": "UNATTEMPTED",
"transfer": null,
"expires_at": "2020-05-06T20:31:03.39Z",
"application": "APiDZzAY28F2uSz47L88EuPk",
"updated_at": "2020-04-29T20:31:16.99Z",
"is_void": false,
"messages": [],
"currency": "USD",
"id": "AUuf31ZzUArRnv7R8MpU5PbZ",
"state": "SUCCEEDED",
"device": "DV4b5w1TNAkBu9RTgXU7C19b"
}
]
}
}Authorization Captured
The event you receive when an authorization gets captured.
{
"type": "updated",
"entity": "authorization",
"occurred_at": "2020-04-29T20:31:32.406",
"_embedded": {
"authorizations": [
{
"idempotency_id": null,
"amount": 1000,
"trace_id": "FNX7jwSr5QhQdR2E4PZkLxYTW",
"raw": null,
"created_at": "2020-04-29T20:31:03.39Z",
"source": "PIaZwAfmK2YBX9bUT44uvCLa",
"merchant": "MUeDVrf2ahuKc9Eg5TeZugvs",
"merchant_identity": "IDd76bhnKyKTjzbqwd939WnV",
"tags": {},
"3ds_redirect_url": null,
"void_state": "UNATTEMPTED",
"transfer": "TRdo2Br3gvYKTbiPWwaPvXzR",
"expires_at": "2020-05-06T20:31:03.39Z",
"application": "APiDZzAY28F2uSz47L88EuPk",
"updated_at": "2020-04-29T20:31:25.24Z",
"is_void": false,
"messages": [],
"currency": "USD",
"id": "AUuf31ZzUArRnv7R8MpU5PbZ",
"state": "SUCCEEDED",
"device": "DV4b5w1TNAkBu9RTgXU7C19b"
}
]
}
}Transfer Created
The event you receive when a Transfer gets created for a captured Authorization.
{
"type": "created",
"entity": "transfer",
"occurred_at": "2020-04-29T20:31:32.289",
"_embedded": {
"transfers": [
{
"idempotency_id": null,
"amount": 30,
"trace_id": "FNX6h3WF8UsnEb4dSDu4D2aRf",
"fee": 0,
"destination": null,
"raw": null,
"created_at": "2020-04-29T20:31:31.47Z",
"source": null,
"fee_type": "CARD_FIXED",
"merchant": "MU7cXuKj2xx41hhZZi6bZ13A",
"merchant_identity": "IDd76bhnKyKTjzbqwd939WnV",
"type": "FEE",
"tags": {},
"statement_descriptor": null,
"ready_to_settle_at": "2020-04-29T20:31:30.78Z",
"application": "APiDZzAY28F2uSz47L88EuPk",
"updated_at": "2020-04-29T20:31:31.68Z",
"subtype": "PLATFORM_FEE",
"messages": [],
"currency": "USD",
"id": "TRdo2Br3gvYKTbiPWwaPvXzR",
"state": "PENDING"
}
]
}
}Transfer Updated
The event you receive when a Transfer gets updated to SUCCEEDED.
{
"type": "updated",
"entity": "transfer",
"occurred_at": "2020-04-29T20:31:31.733",
"_embedded": {
"transfers": [
{
"idempotency_id": null,
"amount": 30,
"trace_id": "FNX6h3WF8UsnEb4dSDu4D2aRf",
"fee": 0,
"destination": null,
"raw": null,
"created_at": "2020-04-29T20:31:31.47Z",
"source": null,
"fee_type": "CARD_FIXED",
"merchant": "MU7cXuKj2xx41hhZZi6bZ13A",
"merchant_identity": "IDd76bhnKyKTjzbqwd939WnV",
"type": "FEE",
"tags": {},
"statement_descriptor": null,
"ready_to_settle_at": "2020-04-29T20:31:30.78Z",
"application": "APiDZzAY28F2uSz47L88EuPk",
"updated_at": "2020-04-29T20:31:31.68Z",
"subtype": "PLATFORM_FEE",
"messages": [],
"currency": "USD",
"id": "TRdo2Br3gvYKTbiPWwaPvXzR",
"state": "SUCCEEDED"
}
]
}
}Authorization with Non-EMV Card (Card Present)
The events that get sent when an Authorization gets created with a non-EMV card.
Identity Created
The event you receive when an Identity gets created. The new Identity gets used to create the Payment Instrument for the non-EMV card.
{
"type": "created",
"entity": "identity",
"occurred_at": "2020-04-29T20:28:32.926",
"_embedded": {
"identitys": [
{
"application": "APiDZzAY28F2uSz47L88EuPk",
"updated_at": "2020-04-29T20:28:32.88Z",
"created_at": "2020-04-29T20:28:32.88Z",
"id": "ID5ah4iYJqYjoVSwfxmjSjgC",
"entity": {
"title": null,
"first_name": null,
"last_name": null,
"email": null,
"business_name": null,
"business_type": null,
"doing_business_as": null,
"phone": null,
"business_phone": null,
"personal_address": null,
"business_address": null,
"mcc": null,
"dob": null,
"max_transaction_amount": 0,
"amex_mid": null,
"discover_mid": null,
"url": null,
"annual_card_volume": 0,
"has_accepted_credit_cards_previously": false,
"incorporation_date": null,
"principal_percentage_ownership": null,
"short_business_name": null,
"ownership_type": null,
"tax_authority": null,
"tax_id_provided": false,
"business_tax_id_provided": false,
"default_statement_descriptor": null
},
"identity_roles": [ ],
"tags": {}
}
]
}
}Payment Instrument Created
The event you receive when a Payment Instrument gets created for a non-EMV card.
{
"type": "created",
"entity": "instrument",
"occurred_at": "2020-04-29T20:28:33.034",
"_embedded": {
"instruments": [
{
"application": "APiDZzAY28F2uSz47L88EuPk",
"updated_at": "2020-04-29T20:28:32.99Z",
"identity": "ID5ah4iYJqYjoVSwfxmjSjgC",
"fingerprint": "FPR5w2uCguRwhbtWmcJmirkhf",
"created_at": "2020-04-29T20:28:32.99Z",
"currency": "USD",
"id": "PI9JbewhasbLg4rZeMWd47C7",
"instrument_type": "PAYMENT_CARD_PRESENT",
"type": "PAYMENT_CARD_PRESENT",
"tags": {}
}
]
}
}Authorization Created
The event you receive when an Authorization gets created.
{
"type": "created",
"entity": "authorization",
"occurred_at": "2020-04-29T20:28:48.413",
"_embedded": {
"authorizations": [
{
"idempotency_id": null,
"amount": 1000,
"trace_id": "FNXmMdKcPXFrhj9UdCCdDYmW9",
"raw": null,
"created_at": "2020-04-29T20:28:33.12Z",
"source": "PI9JbewhasbLg4rZeMWd47C7",
"merchant": "MUeDVrf2ahuKc9Eg5TeZugvs",
"merchant_identity": "IDgk8BqH6Kp176UF7KsQecio",
"tags": {},
"3ds_redirect_url": null,
"void_state": "UNATTEMPTED",
"transfer": null,
"expires_at": "2020-05-06T20:28:33.12Z",
"application": "APiDZzAY28F2uSz47L88EuPk",
"updated_at": "2020-04-29T20:28:48.36Z",
"is_void": false,
"messages": [],
"currency": "USD",
"id": "AUqAgQJY4s7KVj7qnBU3QzAQ",
"state": "SUCCEEDED",
"device": "DV4b5w1TNAkBu9RTgXU7C19b"
}
]
}
}Authorization Captured
The event you receive when an authorization gets captured.
{
"type": "updated",
"entity": "authorization",
"occurred_at": "2020-04-29T20:29:03.524",
"_embedded": {
"authorizations": [
{
"idempotency_id": null,
"amount": 1000,
"trace_id": "FNXmMdKcPXFrhj9UdCCdDYmW9",
"raw": null,
"created_at": "2020-04-29T20:28:33.12Z",
"source": "PI9JbewhasbLg4rZeMWd47C7",
"merchant": "MUeDVrf2ahuKc9Eg5TeZugvs",
"merchant_identity": "IDgk8BqH6Kp176UF7KsQecio",
"tags": {},
"3ds_redirect_url": null,
"void_state": "UNATTEMPTED",
"transfer": "TRsUwkcqkcnuVyNxmuSHz8A3",
"expires_at": "2020-05-06T20:28:33.12Z",
"application": "APiDZzAY28F2uSz47L88EuPk",
"updated_at": "2020-04-29T20:28:55.01Z",
"is_void": false,
"messages": [],
"currency": "USD",
"id": "AUqAgQJY4s7KVj7qnBU3QzAQ",
"state": "SUCCEEDED",
"device": "DV4b5w1TNAkBu9RTgXU7C19b"
}
]
}
}Transfer Created
The event you receive when a Transfer gets created for a captured Authorization.
{
"type": "created",
"entity": "transfer",
"occurred_at": "2020-04-29T20:29:03.301",
"_embedded": {
"transfers": [
{
"idempotency_id": null,
"amount": 1700,
"trace_id": "FNXmMdKcPXFrhj9UdCCdDYmW9",
"fee": 10,
"destination": null,
"raw": null,
"created_at": "2020-04-29T20:28:54.99Z",
"source": "PI9JbewhasbLg4rZeMWd47C7",
"merchant": "MU7cXuKj2xx41hhZZi6bZ13A",
"merchant_identity": "IDgk8BqH6Kp176UF7KsQecio",
"type": "DEBIT",
"tags": {},
"statement_descriptor": "FIN*FINIX",
"ready_to_settle_at": "2020-04-29T20:29:00.79Z",
"application": "APiDZzAY28F2uSz47L88EuPk",
"updated_at": "2020-04-29T20:29:00.78Z",
"subtype": "API",
"messages": [],
"currency": "USD",
"id": "TRsUwkcqkcnuVyNxmuSHz8A3",
"state": "PENDING",
"device": "DV4b5w1TNAkBu9RTgXU7C19b"
}
]
}
}Transfer Updated
The event you receive when a Transfer gets updated to SUCCEEDED.
{
"type": "updated",
"entity": "transfer",
"occurred_at": "2020-04-29T20:29:01.668",
"_embedded": {
"transfers": [
{
"idempotency_id": null,
"amount": 1700,
"trace_id": "FNXmMdKcPXFrhj9UdCCdDYmW9",
"fee": 10,
"destination": null,
"raw": null,
"created_at": "2020-04-29T20:28:54.99Z",
"source": "PI9JbewhasbLg4rZeMWd47C7",
"merchant": "MU7cXuKj2xx41hhZZi6bZ13A",
"merchant_identity": "IDgk8BqH6Kp176UF7KsQecio",
"type": "DEBIT",
"tags": {},
"statement_descriptor": "FIN*FINIX",
"ready_to_settle_at": "2020-04-29T20:29:00.79Z",
"application": "APiDZzAY28F2uSz47L88EuPk",
"updated_at": "2020-04-29T20:29:00.78Z",
"subtype": "API",
"messages": [],
"currency": "USD",
"id": "TRsUwkcqkcnuVyNxmuSHz8A3",
"state": "SUCCEEDED",
"device": "DV4b5w1TNAkBu9RTgXU7C19b"
}
]
}
}Capture Authorization (Card Present)
The events you receive when an Authorizations gets captured.
Transfer Updated
The event you receive details the Transfer that got created for the captured Authorization.
{
"type": "created",
"entity": "transfer",
"occurred_at": "2020-04-29T20:31:32.348",
"_embedded": {
"transfers": [
{
"idempotency_id": null,
"amount": 1700,
"trace_id": "FNX7jwSr5QhQdR2E4PZkLxYTW",
"fee": 10,
"destination": null,
"raw": null,
"created_at": "2020-04-29T20:31:25.22Z",
"source": "PIaZwAfmK2YBX9bUT44uvCLa",
"merchant": "MU7cXuKj2xx41hhZZi6bZ13A",
"merchant_identity": "IDgk8BqH6Kp176UF7KsQecio",
"type": "DEBIT",
"tags": {},
"statement_descriptor": "FIN*FINIX",
"ready_to_settle_at": "2020-04-29T20:31:30.56Z",
"application": "APiDZzAY28F2uSz47L88EuPk",
"updated_at": "2020-04-29T20:31:30.55Z",
"subtype": "API",
"messages": [],
"currency": "USD",
"id": "TR6XwvJApMTzNQaPxBWWSxFU",
"state": "PENDING",
"device": "DV4b5w1TNAkBu9RTgXU7C19b"
}
]
}
}Transfer Updated
The event you receive when a Transfer gets updated to SUCCEEDED.
{
"type": "updated",
"entity": "transfer",
"occurred_at": "2020-04-29T20:31:30.669",
"_embedded": {
"transfers": [
{
"idempotency_id": null,
"amount": 1700,
"trace_id": "FNX7jwSr5QhQdR2E4PZkLxYTW",
"fee": 10,
"destination": null,
"raw": null,
"created_at": "2020-04-29T20:31:25.22Z",
"source": "PIaZwAfmK2YBX9bUT44uvCLa",
"merchant": "MU7cXuKj2xx41hhZZi6bZ13A",
"merchant_identity": "IDgk8BqH6Kp176UF7KsQecio",
"type": "DEBIT",
"tags": {},
"statement_descriptor": "FIN*FINIX",
"ready_to_settle_at": "2020-04-29T20:31:30.56Z",
"application": "APiDZzAY28F2uSz47L88EuPk",
"updated_at": "2020-04-29T20:31:30.55Z",
"subtype": "API",
"messages": [],
"currency": "USD",
"id": "TR6XwvJApMTzNQaPxBWWSxFU",
"state": "SUCCEEDED",
"device": "DV4b5w1TNAkBu9RTgXU7C19b"
}
]
}
}Identity Created for a Buyer
The event you receive when an Identity gets created for a buyer.
{
"type": "created",
"entity": "identity",
"occurred_at": "2020-04-26T20:58:46.298",
"_embedded": {
"identitys": [
{
"application": "APkBUdiWzBjUAkfnbkirXs6d",
"updated_at": "2020-04-26T20:58:46.25Z",
"created_at": "2020-04-26T20:58:46.25Z",
"id": "IDe5JkBhBeW3ZEvzqWc8kmXd",
"entity": {
"title": null,
"first_name": "Joe",
"last_name": "Jon",
"email": "therock@gmail.com",
"business_name": null,
"business_type": null,
"doing_business_as": null,
"phone": "7145677613",
"business_phone": null,
"personal_address": {
"line1": "741 Douglass St",
"line2": "Apartment 7",
"city": "San Mateo",
"region": "CA",
"postal_code": "94114",
"country": "USA"
},
"business_address": null,
"mcc": null,
"dob": null,
"max_transaction_amount": 0,
"amex_mid": null,
"discover_mid": null,
"url": null,
"annual_card_volume": 0,
"has_accepted_credit_cards_previously": false,
"incorporation_date": null,
"principal_percentage_ownership": null,
"short_business_name": null,
"ownership_type": null,
"tax_authority": null,
"tax_id_provided": false,
"business_tax_id_provided": false,
"default_statement_descriptor": null
},
"identity_roles": [],
"tags": {
"key": "value"
}
}
]
}
}Identity Created for a Merchant
The event you receive when an Identity gets created for a merchant.
{
"type": "created",
"entity": "identity",
"occurred_at": "2020-04-26T21:06:11.343",
"_embedded": {
"identitys": [
{
"application": "APkBUdiWzBjUAkfnbkirXs6d",
"updated_at": "2020-04-26T21:06:11.27Z",
"created_at": "2020-04-26T21:06:11.27Z",
"id": "IDdpvBpQ9m6D3JDCRq9UDB2E",
"entity": {
"title": "CEO",
"first_name": "John",
"last_name": "Smith",
"email": "user@example.org",
"business_name": "Lees Sandwiches",
"business_type": "INDIVIDUAL_SOLE_PROPRIETORSHIP",
"doing_business_as": "Lees Sandwiches",
"phone": "1234567890",
"business_phone": "+1 (408) 756-4497",
"personal_address": {
"line1": "741 Douglass St",
"line2": "Apartment 7",
"city": "San Mateo",
"region": "CA",
"postal_code": "94114",
"country": "USA"
},
"business_address": {
"line1": "741 Douglass St",
"line2": "Apartment 8",
"city": "San Mateo",
"region": "CA",
"postal_code": "94114",
"country": "USA"
},
"mcc": "4900",
"dob": {
"day": 27,
"month": 6,
"year": 1978
},
"max_transaction_amount": 12000000,
"amex_mid": null,
"discover_mid": null,
"url": "www.LeesSandwiches.com",
"annual_card_volume": 12000000,
"has_accepted_credit_cards_previously": true,
"incorporation_date": {
"day": 27,
"month": 6,
"year": 1978
},
"principal_percentage_ownership": 50,
"short_business_name": null,
"ownership_type": "PRIVATE",
"tax_authority": null,
"tax_id_provided": true,
"business_tax_id_provided": true,
"default_statement_descriptor": "Lees Sandwiches"
},
"identity_roles": [],
"tags": {
"Studio Rating": "4.7"
}
}
]
}
}Identity Updated
The event you receive when an Identity gets updated.
{
"type": "updated",
"entity": "identity",
"occurred_at": "2020-04-26T21:20:41.439",
"_embedded": {
"identitys": [
{
"application": "APkBUdiWzBjUAkfnbkirXs6d",
"updated_at": "2020-04-26T21:20:41.35Z",
"created_at": "2020-04-26T21:06:11.27Z",
"id": "IDdpvBpQ9m6D3JDCRq9UDB2E",
"entity": {
"title": "CTO",
"first_name": "Bernard",
"last_name": "Sterling",
"email": "user@example.org",
"business_name": "Finix Flowers",
"business_type": "INDIVIDUAL_SOLE_PROPRIETORSHIP",
"doing_business_as": "Finix Flowers",
"phone": "7144177878",
"business_phone": "+1 (408) 756-4497",
"personal_address": {
"line1": "712 Douglass St",
"line2": "Apartment 2",
"city": "San Diego",
"region": "CA",
"postal_code": "94194",
"country": "USA"
},
"business_address": {
"line1": "741 Douglass St",
"line2": "Apartment 8",
"city": "San Mateo",
"region": "CA",
"postal_code": "94114",
"country": "USA"
},
"mcc": "4900",
"dob": {
"day": 2,
"month": 5,
"year": 1988
},
"max_transaction_amount": 1200000,
"amex_mid": null,
"discover_mid": null,
"url": "www.Finix.com",
"annual_card_volume": 12000000,
"has_accepted_credit_cards_previously": true,
"incorporation_date": {
"day": 27,
"month": 6,
"year": 1978
},
"principal_percentage_ownership": 50,
"short_business_name": null,
"ownership_type": "PRIVATE",
"tax_authority": null,
"tax_id_provided": true,
"business_tax_id_provided": true,
"default_statement_descriptor": "Finix Flowers"
},
"identity_roles": [],
"tags": {
"key": "value_2"
}
}
]
}
}Merchant Provisioned
The events you receive sent when a Merchant gets provisioned.
Merchant Created
The event you receive when you create a Merchant .
{
"type": "created",
"entity": "merchant",
"occurred_at": "2020-04-26T21:54:59.958",
"_embedded": {
"merchants": [
{
"card_expiration_date_required": false,
"settlement_enabled": false,
"mid": null,
"merchant_name": "Finix Flowers",
"created_at": "2020-04-26T21:54:59.43Z",
"processing_enabled": false,
"mcc": "4900",
"processor": "DUMMY_V1",
"creating_transfer_from_report_enabled": false,
"merchant_profile": "MPcQELZpgPU7dq1ZsCjnZQDS",
"tags": {
"key_2": "value_2"
},
"card_cvv_required": false,
"application": "APkBUdiWzBjUAkfnbkirXs6d",
"updated_at": "2020-04-26T21:54:59.43Z",
"identity": "IDdpvBpQ9m6D3JDCRq9UDB2E",
"processor_details": {},
"id": "MUrFRV3YDxDGJBA9G8dmuKCk",
"onboarding_state": "PROVISIONING",
"verification": null,
"gross_settlement_enabled": false
}
]
}
}Merchant Profile Created
The event you receive when the Merchant Profile gets automatically created for your new Merchant .
{
"type": "created",
"entity": "merchant_profile",
"occurred_at": "2020-04-26T21:54:59.692",
"_embedded": {
"merchant_profiles": [
{
"application": "APkBUdiWzBjUAkfnbkirXs6d",
"updated_at": "2020-04-26T21:54:59.42Z",
"fee_profile": null,
"risk_profile": "RPjhkhnYKWWMHwwuX1JuxinW",
"created_at": "2020-04-26T21:54:59.42Z",
"id": "MPcQELZpgPU7dq1ZsCjnZQDS",
"tags": {}
}
]
}
}Verification Created
The event you receive when you create the Verification to underwrite the new Merchant .
{
"type": "created",
"entity": "verification",
"occurred_at": "2020-04-26T21:54:59.83",
"_embedded": {
"verifications": [
{
"trace_id": "2456e6d0-f2b1-4626-8936-28728e7c2a0d",
"payment_instrument": null,
"raw": null,
"created_at": "2020-04-26T21:54:59.46Z",
"merchant": "MUrFRV3YDxDGJBA9G8dmuKCk",
"processor": "DUMMY_V1",
"tags": {
"key_2": "value_2"
},
"application": "APkBUdiWzBjUAkfnbkirXs6d",
"updated_at": "2020-04-26T21:54:59.50Z",
"identity": null,
"messages": [],
"id": "VImsN9J9VU9y9uGNyaE3TjC5",
"state": "PENDING"
}
]
}
}Merchant Underwritten
The event you receive when the Merchant gets submitted for underwriting.
{
"type": "underwritten",
"entity": "merchant",
"occurred_at": "2020-04-26T21:55:06.626",
"_embedded": {
"merchants": [
{
"card_expiration_date_required": false,
"settlement_enabled": false,
"mid": null,
"merchant_name": "Finix Flowers",
"created_at": "2020-04-26T21:54:59.43Z",
"processing_enabled": false,
"mcc": "4900",
"processor": "DUMMY_V1",
"creating_transfer_from_report_enabled": false,
"merchant_profile": "MPcQELZpgPU7dq1ZsCjnZQDS",
"tags": {
"key_2": "value_2"
},
"card_cvv_required": false,
"application": "APkBUdiWzBjUAkfnbkirXs6d",
"updated_at": "2020-04-26T21:55:01.90Z",
"identity": "IDdpvBpQ9m6D3JDCRq9UDB2E",
"processor_details": {
"api_key": "secretValue"
},
"id": "MUrFRV3YDxDGJBA9G8dmuKCk",
"onboarding_state": "APPROVED",
"verification": "VImsN9J9VU9y9uGNyaE3TjC5",
"gross_settlement_enabled": false
}
]
}
}Payment Instrument Created
The event you receive when creating the Payment Instrument for the Merchant .
{
"type": "created",
"entity": "instrument",
"occurred_at": "2020-04-26T21:55:06.798",
"_embedded": {
"instruments": [
{
"application": "APkBUdiWzBjUAkfnbkirXs6d",
"updated_at": "2020-04-26T21:55:06.54Z",
"identity": "IDdpvBpQ9m6D3JDCRq9UDB2E",
"fingerprint": "FPRqUa4Wi5Qv6x3fGP4mzkULD",
"created_at": "2020-04-26T21:55:06.54Z",
"currency": "USD",
"id": "PIxmAdNbw1VJH6UwAH265moM",
"instrument_type": "VIRTUAL",
"type": "VIRTUAL",
"tags": {}
}
]
}
}Risk Profile Created
The event you receive when creating a Risk Profile for the Merchant . Create a Risk Profile when you want the Merchant to have a different Risk Profile than your Application.
{
"type": "created",
"entity": "risk_profile",
"occurred_at": "2020-04-26T21:55:06.961",
"_embedded": {
"risk_profiles": [
{
"application": "APkBUdiWzBjUAkfnbkirXs6d",
"updated_at": "2020-04-26T21:55:06.54Z",
"avs_failure_allowed": false,
"created_at": "2020-04-26T21:55:06.54Z",
"id": "RPmzoeiYws2kD7j8Rtyx4fiw",
"csc_failure_allowed": false,
"tags": {}
}
]
}
}Verification Approved
The event you receive when the Verification request to underwrite the Merchant get approved. If approved, state gets updated to SUCCEEDED.
{
"type": "updated",
"entity": "verification",
"occurred_at": "2020-04-26T21:55:07.337",
"_embedded": {
"verifications": [
{
"trace_id": "2456e6d0-f2b1-4626-8936-28728e7c2a0d",
"payment_instrument": null,
"raw": "RawDummyMerchantUnderwriteResult",
"created_at": "2020-04-26T21:54:59.46Z",
"merchant": "MUrFRV3YDxDGJBA9G8dmuKCk",
"processor": "DUMMY_V1",
"tags": {
"key_2": "value_2"
},
"application": "APkBUdiWzBjUAkfnbkirXs6d",
"updated_at": "2020-04-26T21:55:06.72Z",
"identity": null,
"messages": [],
"id": "VImsN9J9VU9y9uGNyaE3TjC5",
"state": "SUCCEEDED"
}
]
}
}Merchant Approved and Enabled
The event you receive when the Merchant gets approved and enabled to process payments. When the Merchant gets approved, processing_enabled gets updated to true.
{
"type": "updated",
"entity": "merchant",
"occurred_at": "2020-04-26T21:55:07.46",
"_embedded": {
"merchants": [
{
"card_expiration_date_required": false,
"settlement_enabled": true,
"mid": null,
"merchant_name": "Finix Flowers",
"created_at": "2020-04-26T21:54:59.43Z",
"processing_enabled": true,
"mcc": "4900",
"processor": "DUMMY_V1",
"creating_transfer_from_report_enabled": false,
"merchant_profile": "MPcQELZpgPU7dq1ZsCjnZQDS",
"tags": {
"key_2": "value_2"
},
"card_cvv_required": false,
"application": "APkBUdiWzBjUAkfnbkirXs6d",
"updated_at": "2020-04-26T21:55:06.72Z",
"identity": "IDdpvBpQ9m6D3JDCRq9UDB2E",
"processor_details": {
"api_key": "secretValue"
},
"id": "MUrFRV3YDxDGJBA9G8dmuKCk",
"onboarding_state": "APPROVED",
"verification": "VImsN9J9VU9y9uGNyaE3TjC5",
"gross_settlement_enabled": false
}
]
}
}Merchant Profile Updated - Risk Profile
The event you receive when the Merchant Profile gets updated with with a new risk_profile.
{
"type": "updated",
"entity": "merchant_profile",
"occurred_at": "2020-04-26T21:55:07.071",
"_embedded": {
"merchant_profiles": [
{
"application": "APkBUdiWzBjUAkfnbkirXs6d",
"updated_at": "2020-04-26T21:55:06.72Z",
"fee_profile": null,
"risk_profile": "RPmzoeiYws2kD7j8Rtyx4fiw",
"created_at": "2020-04-26T21:54:59.42Z",
"id": "MPcQELZpgPU7dq1ZsCjnZQDS",
"tags": {}
}
]
}
}Merchant Profile Updated - Fee Profile
The event you receive when the Merchant Profile gets updated with with a fee_profile.
{
"type": "updated",
"entity": "merchant_profile",
"occurred_at": "2020-04-27T21:56:49.42Z",
"_embedded": {
"merchant_profiles": [
{
"application": "APkBUdiWzBjUAkfnbkirXs6d",
"updated_at": "2020-04-26T21:55:06.72Z",
"fee_profile": "FPq6PQ9pHsab66fKMmjQ7jb5",
"risk_profile": null,
"created_at": "2020-04-27T21:54:51.42Z",
"id": "MPcQELZpgPU7dq1ZsCjnZQDS",
"tags": {}
}
]
}
}Payment Instrument Created
The event that's sent when a Payment Instrument gets created for the merchant.
{
"type": "created",
"entity": "instrument",
"occurred_at": "2020-04-26T21:55:06.88",
"_embedded": {
"instruments": [
{
"application": "APkBUdiWzBjUAkfnbkirXs6d",
"updated_at": "2020-04-26T21:55:06.54Z",
"identity": "IDdpvBpQ9m6D3JDCRq9UDB2E",
"fingerprint": "FPRqUa4Wi5Qv6x3fGP4mzkULD",
"created_at": "2020-04-26T21:55:06.54Z",
"currency": "USD",
"id": "PI3JU8AogWTLgDtdN7zDvZwW",
"instrument_type": "VIRTUAL",
"type": "VIRTUAL",
"tags": {}
}
]
}
}Reattempt Merchant Provisioning
The events that get sent when another attempt is made to provision (underwrite) the Merchant .
Verification Created
The event you receive when you create the Verification to underwrite (or provision) the new Merchant .
{
"type": "created",
"entity": "verification",
"occurred_at": "2020-04-26T22:10:44.523",
"_embedded": {
"verifications": [
{
"trace_id": "f7375d38-9ed0-4d86-b62d-a8f692f635cb",
"payment_instrument": null,
"raw": null,
"created_at": "2020-04-26T22:10:44.42Z",
"merchant": "MUrFRV3YDxDGJBA9G8dmuKCk",
"processor": "DUMMY_V1",
"tags": {},
"application": "APkBUdiWzBjUAkfnbkirXs6d",
"updated_at": "2020-04-26T22:10:44.45Z",
"identity": null,
"messages": [],
"id": "VIb691JRnMdz4M73yi6jAmCN",
"state": "PENDING"
}
]
}
}Verification Approved
The event you receive when the Verification request to underwrite the Merchant get approved. If approved, state gets updated to SUCCEEDED.
{
"type": "updated",
"entity": "verification",
"occurred_at": "2020-04-26T22:11:05.955",
"_embedded": {
"verifications": [
{
"trace_id": "f7375d38-9ed0-4d86-b62d-a8f692f635cb",
"payment_instrument": null,
"raw": "RawDummyMerchantUnderwriteResult",
"created_at": "2020-04-26T22:10:44.42Z",
"merchant": "MUrFRV3YDxDGJBA9G8dmuKCk",
"processor": "DUMMY_V1",
"tags": {},
"application": "APkBUdiWzBjUAkfnbkirXs6d",
"updated_at": "2020-04-26T22:11:05.76Z",
"identity": null,
"messages": [],
"id": "VIb691JRnMdz4M73yi6jAmCN",
"state": "SUCCEEDED"
}
]
}
}Merchant Underwritten
The event you receive when the Merchant gets submitted for underwriting.
{
"type": "underwritten",
"entity": "merchant",
"occurred_at": "2020-04-26T22:11:05.686",
"_embedded": {
"merchants": [
{
"card_expiration_date_required": false,
"settlement_enabled": true,
"mid": null,
"merchant_name": "Finix Flowers",
"created_at": "2020-04-26T21:54:59.43Z",
"processing_enabled": true,
"mcc": "4900",
"processor": "DUMMY_V1",
"creating_transfer_from_report_enabled": false,
"merchant_profile": "MPcQELZpgPU7dq1ZsCjnZQDS",
"tags": {
"key_2": "value_2"
},
"card_cvv_required": false,
"application": "APkBUdiWzBjUAkfnbkirXs6d",
"updated_at": "2020-04-26T21:55:06.72Z",
"identity": "IDdpvBpQ9m6D3JDCRq9UDB2E",
"processor_details": {
"api_key": "secretValue"
},
"id": "MUrFRV3YDxDGJBA9G8dmuKCk",
"onboarding_state": "APPROVED",
"verification": "VIb691JRnMdz4M73yi6jAmCN",
"gross_settlement_enabled": false
}
]
}
}Merchant Provisioned (Card Present)
The events that get sent when a Merchant is provisioned to process card present transactions.
Merchant Created
The event you receive when you create a Merchant .
{
"type": "created",
"entity": "merchant",
"occurred_at": "2020-04-26T22:30:41.801",
"_embedded": {
"merchants": [
{
"card_expiration_date_required": false,
"settlement_enabled": false,
"mid": null,
"merchant_name": "Finix Flowers",
"created_at": "2020-04-26T22:30:41.50Z",
"processing_enabled": false,
"mcc": "4900",
"processor": "VANTIV_V1",
"creating_transfer_from_report_enabled": false,
"merchant_profile": "MPix8GV6WTWv8hWVxvWV2unm",
"tags": {},
"card_cvv_required": false,
"application": "APkBUdiWzBjUAkfnbkirXs6d",
"updated_at": "2020-04-26T22:30:41.50Z",
"identity": "IDdpvBpQ9m6D3JDCRq9UDB2E",
"processor_details": {},
"id": "MUeLemkwC6WSaaZLUUB1Y7mr",
"onboarding_state": "PROVISIONING",
"verification": null,
"gross_settlement_enabled": false
}
]
}
}Merchant Profile Created
The event you receive when the Merchant Profile gets automatically created for your new Merchant .
{
"type": "created",
"entity": "merchant_profile",
"occurred_at": "2020-04-26T22:30:41.731",
"_embedded": {
"merchant_profiles": [
{
"application": "APkBUdiWzBjUAkfnbkirXs6d",
"updated_at": "2020-04-26T22:30:41.49Z",
"fee_profile": null,
"risk_profile": "RPjhkhnYKWWMHwwuX1JuxinW",
"created_at": "2020-04-26T22:30:41.49Z",
"id": "MPix8GV6WTWv8hWVxvWV2unm",
"tags": {}
}
]
}
}Initial Verification Created
The event you receive when you create the Verification to underwrite the new Merchant .
{
"type": "created",
"entity": "verification",
"occurred_at": "2020-04-26T22:30:41.636",
"_embedded": {
"verifications": [
{
"trace_id": "FNX4YG8ut4zJQekpQGZbtZL2a",
"payment_instrument": null,
"raw": null,
"created_at": "2020-04-26T22:30:41.50Z",
"merchant": "MUeLemkwC6WSaaZLUUB1Y7mr",
"processor": "VANTIV_V1",
"tags": {},
"application": "APkBUdiWzBjUAkfnbkirXs6d",
"updated_at": "2020-04-26T22:30:41.52Z",
"identity": null,
"messages": [],
"id": "VIpdSnQwTNeWgMHXvFDCPVsx",
"state": "PENDING"
}
]
}
}Initial Verification Failed
The event you receive when the Verification request to underwrite the Merchant get denied. If denied, state gets updated to FAILED.
{
"type": "updated",
"entity": "verification",
"occurred_at": "2020-04-26T22:31:15.486",
"_embedded": {
"verifications": [
{
"trace_id": "FNX4YG8ut4zJQekpQGZbtZL2a",
"payment_instrument": null,
"raw": "MerchantResponse(correlationId=null, httpStatusCode=500, httpStatusMessage=Original response had no body, id=null, mid=null, acceptedCards=null, expressSubAccount=null, errors=[Error(errorCode=null, errorMessage=Original response had no body. Please check Vantiv credentials or health status of Vantiv service, target=null)])",
"created_at": "2020-04-26T22:30:41.50Z",
"merchant": "MUeLemkwC6WSaaZLUUB1Y7mr",
"processor": "VANTIV_V1",
"tags": {},
"application": "APkBUdiWzBjUAkfnbkirXs6d",
"updated_at": "2020-04-26T22:31:15.23Z",
"identity": null,
"messages": [
"Error(errorCode=null, errorMessage=Original response had no body. Please check Vantiv credentials or health status of Vantiv service, target=null)"
],
"id": "VIpdSnQwTNeWgMHXvFDCPVsx",
"state": "FAILED"
}
]
}
}Merchant Rejected
The event you receive when the request to underwrite the Merchant get denied. If denied, onboarding_state gets updated to REJECTED.
{
"type": "updated",
"entity": "merchant",
"occurred_at": "2020-04-26T22:31:15.59",
"_embedded": {
"merchants": [
{
"card_expiration_date_required": false,
"settlement_enabled": false,
"mid": null,
"merchant_name": "Finix Flowers",
"created_at": "2020-04-26T22:30:41.50Z",
"processing_enabled": false,
"mcc": "4900",
"processor": "VANTIV_V1",
"creating_transfer_from_report_enabled": false,
"merchant_profile": "MPix8GV6WTWv8hWVxvWV2unm",
"tags": {},
"card_cvv_required": false,
"application": "APkBUdiWzBjUAkfnbkirXs6d",
"updated_at": "2020-04-26T22:31:15.23Z",
"identity": "IDdpvBpQ9m6D3JDCRq9UDB2E",
"processor_details": {},
"id": "MUeLemkwC6WSaaZLUUB1Y7mr",
"onboarding_state": "REJECTED",
"verification": "VIpdSnQwTNeWgMHXvFDCPVsx",
"gross_settlement_enabled": false
}
]
}
}Second Verification Created
The event you receive when you create the second Verification to try underwriting the new Merchant again.
{
"type": "created",
"entity": "verification",
"occurred_at": "2020-04-26T22:33:10.198",
"_embedded": {
"verifications": [
{
"trace_id": "85f2b5a5-0c58-4382-bf94-349b738db6c3",
"payment_instrument": null,
"raw": null,
"created_at": "2020-04-26T22:33:10.12Z",
"merchant": "MUrFRV3YDxDGJBA9G8dmuKCk",
"processor": "DUMMY_V1",
"tags": {},
"application": "APkBUdiWzBjUAkfnbkirXs6d",
"updated_at": "2020-04-26T22:33:10.14Z",
"identity": null,
"messages": [],
"id": "VIwq2UdpXyUoDGW3e4uwY2dB",
"state": "PENDING"
}
]
}
}Second Attempt to Underwrite Merchant
The event you receive when the Merchant gets submitted again for underwriting.
{
"type": "underwritten",
"entity": "merchant",
"occurred_at": "2020-04-26T22:34:06.036",
"_embedded": {
"merchants": [
{
"card_expiration_date_required": false,
"settlement_enabled": true,
"mid": null,
"merchant_name": "Finix Flowers",
"created_at": "2020-04-26T21:54:59.43Z",
"processing_enabled": true,
"mcc": "4900",
"processor": "DUMMY_V1",
"creating_transfer_from_report_enabled": false,
"merchant_profile": "MPcQELZpgPU7dq1ZsCjnZQDS",
"tags": {
"key_2": "value_2"
},
"card_cvv_required": false,
"application": "APkBUdiWzBjUAkfnbkirXs6d",
"updated_at": "2020-04-26T21:55:06.72Z",
"identity": "IDdpvBpQ9m6D3JDCRq9UDB2E",
"processor_details": {
"api_key": "secretValue"
},
"id": "MUrFRV3YDxDGJBA9G8dmuKCk",
"onboarding_state": "APPROVED",
"verification": "VIwq2UdpXyUoDGW3e4uwY2dB",
"gross_settlement_enabled": false
}
]
}
}Verification Approved
The event you receive when the second Verification request to underwrite the Merchant get approved. If approved, state gets updated to SUCCEEDED.
{
"type": "updated",
"entity": "verification",
"occurred_at": "2020-04-26T22:34:06.323",
"_embedded": {
"verifications": [
{
"trace_id": "85f2b5a5-0c58-4382-bf94-349b738db6c3",
"payment_instrument": null,
"raw": "RawDummyMerchantUnderwriteResult",
"created_at": "2020-04-26T22:33:10.12Z",
"merchant": "MUrFRV3YDxDGJBA9G8dmuKCk",
"processor": "DUMMY_V1",
"tags": {},
"application": "APkBUdiWzBjUAkfnbkirXs6d",
"updated_at": "2020-04-26T22:34:06.15Z",
"identity": null,
"messages": [],
"id": "VIwq2UdpXyUoDGW3e4uwY2dB",
"state": "SUCCEEDED"
}
]
}
}Uploading Files
The following events detail the changes that happen while uploading files. For more information, see Uploading Files to Finix.
File Created
The event you receive sent when a File gets created.
{
"type": "created",
"entity": "file",
"occurred_at": "2022-05-23T17:46:42.19914",
"_embedded": {
"files": [
{
"updated_at": "2022-05-23T17:46:37.42Z",
"platform_id": "PLm5E6FbtCZ5vjpCaKhq5PwN",
"created_at": "2022-05-23T17:46:37.42Z",
"id": "FILE_aiAQBbBz2wosPQjQoaGZHD",
"linked_type": "MERCHANT",
"display_name": "John's Drivers License",
"type": "DRIVERS_LICENSE_FRONT",
"linked_to": "MUucec6fHeaWo3VHYoSkUySM",
"application_id": "APgPDQrLD52TYvqazjHJJchM",
"status": "REQUIRES_UPLOAD",
"tags": {
"key_1": "value_1"
}
}
]
}
}File Approved
The event you receive when a File is approved. When approved, the status of the File gets updated to UPLOADED.
{
"type": "updated",
"entity": "file",
"occurred_at": "2022-05-23T17:46:42.19914",
"_embedded": {
"files": [
{
"updated_at": "2022-05-23T17:46:37.42Z",
"platform_id": "PLm5E6FbtCZ5vjpCaKhq5PwN",
"created_at": "2022-05-23T17:46:37.42Z",
"id": "FILE_aiAQBbBz2wosPQjQoaGZHD",
"linked_type": "MERCHANT",
"display_name": "John's Drivers License",
"type": "DRIVERS_LICENSE_FRONT",
"linked_to": "MUucec6fHeaWo3VHYoSkUySM",
"application_id": "APgPDQrLD52TYvqazjHJJchM",
"status": "UPLOADED",
"tags": {
"key_1": "value_1"
}
}
]
}
}File Rejected
The event you receive when a File gets rejected. When rejected, the status of the File gets updated to INVALID.
{
"type": "updated",
"entity": "file",
"occurred_at": "2022-05-23T17:46:42.19914",
"_embedded": {
"files": [
{
"updated_at": "2022-05-23T17:46:37.42Z",
"platform_id": "PLm5E6FbtCZ5vjpCaKhq5PwN",
"created_at": "2022-05-23T17:46:37.42Z",
"id": "FILE_KUCDz2GzXtfgVUPFq8CqL",
"linked_type": "MERCHANT",
"display_name": "John's Drivers License",
"type": "DRIVERS_LICENSE_FRONT",
"linked_to": "MU2n7BSovtwYsWYZF6rBnnzk",
"application_id": "APgPDQrLD52TYvqazjHJJchM",
"status": "INVALID",
"tags": {
"key_1": "value_1"
}
}
]
}
}External Link Created
The event you receive when an external_link gets created.
{
"type": "created",
"entity": "external_link",
"occurred_at": "2022-05-23T18:21:44.726992",
"_embedded": {
"external_links": [
{
"expires_at": "2022-05-23T18:31:39.62Z",
"expired": false,
"user_id": "USsRhsHYZGBPnQw8CByJyEQW",
"file_id": "FILE_aiAQBbBz2wosPQjQoaGZHD",
"created_at": "2022-05-23T18:21:39.62Z",
"id": "EL_6YjrZF3yCLB3zCLm24yAGm",
"type": "UPLOAD",
"url": "https://finix-file-quarantine-sb.s3.us-east-2.amazonaws.com/MERCHANT/MUucec6fHeaWo3VHYoSkUySM/DRIVERS_LICENSE_FRONT/FILE_aiAQBbBz2wosPQjQoaGZHD/file?X-Amz-Security-Token=...",
"tags": {
"key": "value"
}
}
]
}
}External Link Updated
The event you receive when an external_link gets updated.
{
"type": "updated",
"entity": "external_link",
"occurred_at": "2022-05-23T18:21:44.726992",
"_embedded": {
"external_links": [
{
"expires_at": "2022-05-23T18:31:39.62Z",
"expired": false,
"user_id": "USsRhsHYZGBPnQw8CByJyEQW",
"file_id": "FILE_aiAQBbBz2wosPQjQoaGZHD",
"created_at": "2022-05-23T18:21:39.62Z",
"id": "EL_6YjrZF3yCLB3zCLm24yAGm",
"type": "UPLOAD",
"url": "https://finix-file-quarantine-sb.s3.us-east-2.amazonaws.com/MERCHANT/MUucec6fHeaWo3VHYoSkUySM/DRIVERS_LICENSE_FRONT/FILE_aiAQBbBz2wosPQjQoaGZHD/file?X-Amz-Security-Token=...",
"tags": {
"key": "value"
}
}
]
}
}Payment Instrument Created (Card)
The event you receive when a Payment Instrument is created from a credit or debit card.
{
"type": "created",
"entity": "instrument",
"occurred_at": "2020-04-26T21:22:57.287",
"_embedded": {
"instruments": [
{
"address": {
"line1": "900 Metro Center Blv",
"line2": null,
"city": "San Francisco",
"region": "CA",
"postal_code": "94404",
"country": "USA"
},
"address_verification": "UNKNOWN",
"bin": "489514",
"security_code_verification": "UNKNOWN",
"created_at": "2020-04-26T21:22:57.21Z",
"instrument_type": "PAYMENT_CARD",
"card_type": "UNKNOWN",
"type": "PAYMENT_CARD",
"tags": {
"card_name": "Business Card"
},
"expiration_year": 2029,
"application": "APkBUdiWzBjUAkfnbkirXs6d",
"updated_at": "2020-04-26T21:22:57.21Z",
"last_four": "0006",
"identity": "IDe5JkBhBeW3ZEvzqWc8kmXd",
"fingerprint": "FPRogKWsRQks2HGaau5eGR9AF",
"expiration_month": 3,
"name": "John Smith",
"currency": "USD",
"id": "PIoBQHZFB3p8UM8HasuN6icB",
"brand": "VISA"
}
]
}
}Payment Instrument Created (Bank Account)
The event you receive when a Payment Instrument is created using the information of a bank account.
{
"type": "created",
"entity": "instrument",
"occurred_at": "2020-04-26T21:24:03.139",
"_embedded": {
"instruments": [
{
"bank_code": "123123123",
"country": "USA",
"account_type": "SAVINGS",
"created_at": "2020-04-26T21:24:03.06Z",
"instrument_type": "BANK_ACCOUNT",
"type": "BANK_ACCOUNT",
"tags": {
"Bank Account": "Company Account"
},
"masked_account_number": "XXXXX3123",
"application": "APkBUdiWzBjUAkfnbkirXs6d",
"updated_at": "2020-04-26T21:24:03.06Z",
"identity": "IDdpvBpQ9m6D3JDCRq9UDB2E",
"fingerprint": "FPRd5moHxL3Ltuvk4cczxetCg",
"name": "John",
"currency": "USD",
"id": "PInwJvRi22wrz4j5Mx3ghBE9"
}
]
}
}Payment Instrument Updated
The events that get sent when Payment Instruments gets manually updated with a PUT request.
{
"id": "event_7849EPiVUN9dknfmPoctE6",
"system_generated_idempotency_id": "7849EPiVUN9dknfmPoctE6",
"type": "updated",
"entity": "instrument",
"occurred_at": "2023-03-03T17:31:01.465843",
"_embedded": {
"instruments": [
{
"bin": "558958",
"created_at": "2023-03-03T17:30:59.89Z",
"instrument_type": "PAYMENT_CARD",
"type": "PAYMENT_CARD",
"enabled": true,
"issuer_country": "USA",
"updated_at": "2023-03-03T17:30:59.89Z",
"last_four": "0770",
"identity": "ID4NxfCXYDu8NiueXHm8JUCb",
"fingerprint": "FPRoD2LpBkgJDaUBAAmtdQPAn",
"expiration_month": 9,
"currency": "USD",
"id": "PIicBscsDiBfs6QW2C5gQvGa",
"brand": "VISA",
"disabled_code": null,
"address": {
"line1": "631 Howard St",
"line2": null,
"city": "San Francisco",
"region": "CA",
"postal_code": "94105",
"country": null
},
"address_verification": "POSTAL_CODE_AND_STREET_MATCH",
"created_via": "API",
"security_code_verification": "MATCHED",
"disabled_message": null,
"card_type": "CREDIT",
"tags": {},
"expiration_year": 2027,
"application": "APot9H635fZLZuRNZDS6bbsU",
"name": "John Smith"
}
]
}
}Instruments Updated (Account Updater)
The events that get sent when Payment Instruments get updated using Finix's Account Updater.
Account Updater Request
The event you receive when an Instrument Updates request gets created.
{
"type": "updated",
"entity": "instrument_update",
"occurred_at": "2022-07-08T17:25:18.654574",
"_embedded": {
"instrument_updates": [
{
"updated_at": "2022-07-08T17:25:16.83Z",
"created_at": "2022-07-08T17:18:07.46Z",
"id": "IUvwEeaEfDBtLPYSNZespSn8",
"merchant": "MUucec6fHeaWo3VHYoSkUySM",
"state": "SUCCEEDED"
}
]
}
}Payment Instrument Updated
The event you receive when the Payment Instrument gets updated using Finix's Account Updater.
{
"type": "updated",
"entity": "instrument",
"occurred_at": "2020-04-26T22:47:08.145",
"_embedded": {
"instruments": [
{
"push_funds_block_indicator": "C",
"address": {
"line1": "900 Metro Center Blv",
"line2": null,
"city": "San Francisco",
"region": "CA",
"postal_code": "94404",
"country": "USA"
},
"address_verification": "POSTAL_CODE_AND_STREET_MATCH",
"bin": "489514",
"security_code_verification": "UNMATCHED",
"created_at": "2020-04-26T21:22:57.21Z",
"instrument_type": "PAYMENT_CARD",
"card_type": "UNKNOWN",
"type": "PAYMENT_CARD",
"tags": {
"card_name": "Business Card"
},
"fast_funds_indicator": "B",
"expiration_year": 2029,
"application": "APkBUdiWzBjUAkfnbkirXs6d",
"updated_at": "2020-04-26T22:47:07.97Z",
"last_four": "0006",
"identity": "IDe5JkBhBeW3ZEvzqWc8kmXd",
"fingerprint": "FPRogKWsRQks2HGaau5eGR9AF",
"expiration_month": 3,
"name": "John Smith",
"online_gambing_block_indicator": "N",
"currency": "USD",
"id": "PIoBQHZFB3p8UM8HasuN6icB",
"brand": "VISA"
}
]
}
}Verification Created
The event you receive details the Verification that gets created to process the Instrument Updates request.
{
"type": "created",
"entity": "verification",
"occurred_at": "2020-04-26T22:47:08.051",
"_embedded": {
"verifications": [
{
"trace_id": "011722198912",
"payment_instrument": "PIoBQHZFB3p8UM8HasuN6icB",
"raw": {
"validation_details": {
"systems_trace_audit_number": "011722198912",
"error_result": null,
"transaction_identifier": "159588093394000",
"approval_code": null,
"action_code": "N7",
"response_code": "5",
"address_verification_results": "Y",
"cvv2_result_code": "N"
},
"inquiry_details": {
"systems_trace_audit_number": "011722198912",
"error_result": null,
"visa_network_info": [
{
"card_type_code": "D",
"billing_currency_code": 840,
"billing_currency_minor_digits": 2,
"issuer_name": "Visa Test Bank",
"card_issuer_country_code": 840,
"fast_funds_indicator": "B",
"push_funds_block_indicator": "C",
"online_gambing_block_indicator": "N"
}
],
"ppgs_network_info": []
},
"general_inquiry_details": {
"systems_trace_audit_number": "011722198912",
"error_result": null,
"card_product_id": null,
"card_product_name": null,
"card_product_subtype_code": null,
"card_product_subtype_description": null,
"card_type_code": null,
"card_subtype_code": null,
"card_platform_code": null,
"issuer_name": null,
"bin": null,
"country_code": null,
"status": {
"status_code": "CDI000",
"status_description": "Success"
}
}
},
"created_at": "2020-04-26T22:47:05.85Z",
"merchant": null,
"processor": "VISA_V1",
"tags": {},
"application": "APkBUdiWzBjUAkfnbkirXs6d",
"updated_at": "2020-04-26T22:47:07.93Z",
"identity": null,
"messages": [],
"id": "VIvNYHbQyqq2iDzhafVPs2MA",
"state": "SUCCEEDED"
}
]
}
}Onboarding Form Created
The event you receive when an onboarding_form gets created.
{
"id": "event_3M7pFpzorXGdtSDaBubCkt",
"type": "created",
"entity": "onboarding_form",
"occurred_at": "2022-12-12T21:37:44.385255",
"_embedded": {
"onboarding_forms": [
{
"merchant_processors": [
{
"processor": "DUMMY_V1"
}
],
"onboarding_link": {
"expires_at": "2022-12-12T22:07:43.48Z",
"link_url": "https://sandbox.payments-dashboard.com/merchant-onboarding?formId=obf_7EMbv4C2bCvzFkVFwDWnEo&applicationId=APgPDQrLD52TYvqazjHJJchM&bearerToken=..."
},
"onboarding_data": {
"entity": {},
"associated_entities": [],
"payment_instruments": {},
"additional_underwriting_data": {},
"max_transaction_amount": 100000
},
"updated_at": "2022-12-12T21:37:43.466129Z",
"identity_id": null,
"onboarding_link_details": {
"return_url": "https://www.finix.com/docs",
"expired_session_url": "https://www.finix.com/",
"fee_details_url": "https://www.finix.com/docs",
"terms_of_service_url": "https://www.finix.com/terms-and-policies",
"expiration_in_minutes": 10080
},
"created_at": "2022-12-12T21:37:43.466129Z",
"id": "obf_7EMbv4C2bCvzFkVFwDWnEo",
"application_id": "APgPDQrLD52TYvqazjHJJchM",
"status": "IN_PROGRESS",
"tags": {}
}
]
}
}Onboarding Form Updated
The event you receive when an onboarding_form gets updated or submitted.
{
"type": "updated",
"entity": "onboarding_form",
"occurred_at": "2022-12-12T21:37:44.385255",
"_embedded": {
"onboarding_forms": [
{
"id": "obf_7EMbv4C2bCvzFkVFwDWnEo",
"onboarding_data": {
"entity": {
"title": "CEO",
"first_name": "John",
"last_name": "Smith",
"email": "john@example.com",
"business_name": "Finix Flowers",
"business_type": "INDIVIDUAL_SOLE_PROPRIETORSHIP",
"doing_business_as": "Finix Flowers",
"phone": "5558675309",
"business_phone": "5558675309",
"mcc": "4900",
"url": "example.com",
"ownership_type": "PRIVATE",
"default_statement_descriptor": "FNX",
"max_transaction_amount": 100000,
"annual_card_volume": "10000000",
"principal_percentage_ownership": "100",
"tax_id": "*****6789",
"business_tax_id": "*****6890",
"personal_address": {
"line1": "631 Howard St.",
"city": "San Francisco",
"region": "CA",
"postal_code": "94105",
"country": "USA"
},
"business_address": {
"line1": "631 Howard St.",
"city": "San Francisco",
"region": "CA",
"postal_code": "94105",
"country": "USA"
},
"dob": {
"day": 1,
"month": 1,
"year": 1981
},
"incorporation_date": {
"day": 1,
"month": 1,
"year": 2007
}
},
"payment_instruments": {
"name": "John Smith",
"bank_code": "123456789",
"account_number": "*****6789",
"account_type": "CHECKING",
"type": "BANK_ACCOUNT"
},
"additional_underwriting_data": {
"refund_policy": "NO_REFUNDS",
"average_ach_transfer_amount": 0,
"average_card_transfer_amount": 10000,
"merchant_agreement_ip_address": "4.14.107.114",
"merchant_agreement_accepted": true,
"merchant_agreement_timestamp": "2022-11-16T00:53:45.228537Z",
"merchant_agreement_user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/107.0.0.0 Safari/537.36",
"annual_ach_volume": 0,
"business_description": "Flowers",
"volume_distribution_by_business_type": {
"other_volume_percentage": 0,
"business_to_business_volume_percentage": 100,
"business_to_consumer_volume_percentage": 0
},
"card_volume_distribution": {
"ecommerce_percentage": 100,
"card_present_percentage": 0,
"mail_order_telephone_order_percentage": 0
}
},
"max_transaction_amount": 100000
},
"merchant_processors": [
{
"processor": "DUMMY_V1"
}
],
"onboarding_link_details": {
"return_url": "https://www.example.com/finix-handlers/onboarding-return",
"expired_session_url": "https://www.example.com/finix-handlers/onboarding-expires",
"fee_details_url": "https://www.finix.com/docs",
"terms_of_service_url": "https://www.finix.com/terms-and-policies",
"expiration_in_minutes": 10080
},
"status": "COMPLETED",
"identity_id": "ID8XfQPGnxM2oviYgdzjMWsn",
"application_id": "APgPDQrLD52TYvqazjHJJchM",
"created_at": "2022-11-16T00:50:23.787426Z",
"updated_at": "2022-11-16T00:53:46.124008Z",
"tags": {
"seller": "Finix Flowers"
}
}
]
}
}Payout Profile Created
The event that's sent when the payout settings of a Merchant are changed or updated.
{
"type": "created",
"entity": "payout_profile",
"occurred_at": "2022-08-05T18:46:47.488477",
"_embedded": {
"payout_profiles": [
{
"updated_at": "2022-08-05T11:46:46.52Z",
"created_at": "2022-08-05T11:46:46.52Z",
"id": "POwgvawdPpTfE2fvayUi4FJ1",
"linked_type": "MERCHANT",
"type": "NET",
"net": {
"frequency": "DAILY",
"submission_delay_days": 0,
"payment_instrument_id": "PI8K6j4DkAuoD56mcxKxic9d",
"rail": "STANDARD"
},
"linked_id": "MU84HSuYw9GSVxWoiXuMsPdH",
"tags": {}
}
]
}
}Settlement Accruing
The event you receive when a Settlement begins accruing transactions. This is the first webhook that is received for a Settlement.
{
"type": "accruing_started",
"entity": "settlement",
"occurred_at": "2018-03-06T20:41:34.277",
"_embedded": {
"settlements": [
{
"id": "STc4qcqYJn4tKaD6bkHzkzMG",
"application": "APcL6gyMzeFqDf6RHJid3SEq",
"tags": { },
"identity": "ID57iuPnKwuopPn93YsGmvkP",
"currency": "USD",
"merchant_id": "MUgRjRrRwDyMbzS6CVQYPECC",
"created_at": "2022-08-18T19:00:00.93Z",
"updated_at": "2022-08-18T19:00:00.93Z",
"processor": "DUMMY_V1",
"type": "MERCHANT_REVENUE",
"funds_flow": null,
"payment_type": null,
"total_amount": 662154,
"total_fees": 19232,
"total_fee": 19232,
"net_amount": 642922,
"destination": null,
"status": "PENDING"
}
]
}
}Settlement Created
The event you receive when a Settlement closes and awaiting Finix approval.. This is the second webhook that is received for a Settlement.
{
"type": "created",
"entity": "settlement",
"occurred_at": "2022-08-18T16:45:30.253835",
"_embedded": {
"settlements": [
{
"total_fees": 1388,
"destination": null,
"created_at": "2022-08-18T16:30:06.07Z",
"merchant_id": "MUeDVrf2ahuKc9Eg5TeZugvs",
"type": "MERCHANT_REVENUE",
"processor": "DUMMY_V1",
"tags": {},
"payment_type": null,
"application": "APgPDQrLD52TYvqazjHJJchM",
"updated_at": "2022-08-18T16:45:27.03Z",
"total_amount": 49380,
"identity": "IDuqZpDw28f2KK6YuDk4jNLg",
"total_fee": 1388,
"currency": "USD",
"id": "STzcJD5WSsMojBzsuH65N8j",
"net_amount": 47992,
"funds_flow": "NET",
"status": "AWAITING_APPROVAL"
}
]
}
}Settlement Updated and Awaiting Approval
The event you receive after Finix approves a Settlement and it becomes available for approval.
{
"id": "event_9op0ILKJG4LweMMoDers4l",
"type": "updated",
"entity": "settlement",
"occurred_at": "2023-02-16T22:19:57.64Z",
"_embedded": {
"transfers": [
{
"id": "ST2sg1vzfNdeNBr8a4iqVxDt",
"created_at": "2023-02-16T22:19:57.64Z",
"updated_at": "2023-02-16T22:37:05.11Z",
"adjustment_credit_amount": 0,
"adjustment_credit_count": 0,
"adjustment_debit_amount": 0,
"adjustment_debit_count": 0,
"application": "APxxJrYiqedWNXKsbKz939r8",
"auto_close_time": "2023-02-17T13:00:00.00Z",
"currency": "USD",
"dispute_credit_amount": 0,
"dispute_credit_count": 0,
"dispute_debit_amount": 0,
"dispute_debit_count": 0,
"exception": false,
"externally_funded_amount": 0,
"externally_funded_count": 0,
"fee_count": 12,
"finix_fee_count": 0,
"merchant": "MUnawwFb6vCdrnteVtPDdwmK",
"payout_plan": "POa1KmjxP1RXXg3nWdhoPSfG",
"processor_type": "DUMMY_V1",
"reverse_amount": 0,
"reverse_count": 0,
"schedule_type": "DAILY",
"settlement_group": "SG2senctJE9aMysfYz7AUheu",
"split_count": 0,
"status": "AWAITING_APPROVAL",
"tags": {},
"total_amount": 39450,
"total_fee_amount": 1857,
"total_finix_fee_amount": 0,
"total_split_amount": 0,
"transfer_credit_amount": 0,
"transfer_credit_count": 0,
"transfer_debit_amount": 39450,
"transfer_debit_count": 6,
"window_end": "2023-02-16T22:37:00.00Z",
"window_start": "2023-02-16T05:00:00.00Z"
}
]
}
}Approved Settlement
The event sent when a Merchant approves a Settlement.
{
"type": "updated",
"entity": "settlement",
"occurred_at": "2022-05-05T22:19:42.101668",
"_embedded": {
"settlements": [
{
"total_fees": 54321,
"destination": null,
"created_at": "2022-05-05T16:51:24.75Z",
"merchant_id": "MUvrfZpyZtaaFWJjBt2kSd5t",
"type": "MERCHANT_REVENUE",
"processor": "DUMMY_V1",
"tags": {},
"payment_type": null,
"application": "AP67hTPMFqeM9mvCkRN81c4f",
"updated_at": "2022-05-05T22:19:39.51Z",
"total_amount": 0,
"identity": "IDigyAkvecqA4KBKkvUbK9gP",
"total_fee": 54321,
"currency": "USD",
"id": "STjWJZEp51zLebP78s974o1w",
"net_amount": -54321,
"funds_flow": "NET",
"status": "APPROVED"
}
]
}
}Settlement's Funding Transfer
The event you receive when the funding transfer of a Settlement gets created for a Merchant.
{
"id": "event_8hv9UJRJG4LweMMoDgys5a",
"type": "created",
"entity": "transfer",
"occurred_at": "2022-12-13T19:12:53.829814",
"_embedded": {
"transfers": [
{
"fee": 0,
"destination": "PIshDA1jsiEJH5RStcctoqGR",
"created_at": "2022-12-13T19:12:52.49Z",
"failure_message": null,
"fee_type": "CARD_FIXED",
"source": null,
"type": "CREDIT",
"additional_buyer_charges": null,
"statement_descriptor": null,
"additional_healthcare_data": null,
"updated_at": "2022-12-13T19:12:52.58Z",
"subtype": "SETTLEMENT_MERCHANT",
"amount_requested": 194408,
"currency": "USD",
"id": "TRund4D4dYB3EoMFjHADw1X4",
"state": "PENDING",
"idempotency_id": null,
"amount": 194408,
"failure_code": null,
"trace_id": "770788e0-84eb-4350-81a8-34d5d4fa4201",
"address_verification": null,
"security_code_verification": null,
"raw": null,
"merchant": "MU7cXuKj2xx41hhZZi6bZ13A",
"merchant_identity": "IDtLE8194YeihTtmtTSzucoP",
"tags": {},
"ready_to_settle_at": null,
"application": "AP7Geeyfse2KNHiZU6BYZqo5",
"externally_funded": "UNKNOWN",
"messages": []
}
]
}
}Debit a Bank Account (ACH)
The events you receive using ACH (also called eCheck) to debit a bank account.
Transfer Created
The event you receive when a transfer gets created to debit a bank account.
{
"type": "created",
"entity": "transfer",
"occurred_at": "2020-04-26T23:41:55.297",
"_embedded": {
"transfers": [
{
"idempotency_id": null,
"amount": 95073,
"trace_id": "c2bf4ba1-ef59-4c1d-9313-8a46c096cf95",
"fee": 9507,
"destination": null,
"raw": null,
"created_at": "2020-04-26T23:41:55.13Z",
"source": "PI4CxWXFQBPjTiU1F1oUcRqz",
"merchant": "MU7cXuKj2xx41hhZZi6bZ13A",
"merchant_identity": "IDdpvBpQ9m6D3JDCRq9UDB2E",
"type": "DEBIT",
"tags": {
"order_number": "21DFASJSAKAS"
},
"statement_descriptor": "FIN*FINIX FLOWERS",
"ready_to_settle_at": null,
"application": "APkBUdiWzBjUAkfnbkirXs6d",
"updated_at": "2020-04-26T23:41:55.23Z",
"subtype": "API",
"messages": [],
"currency": "USD",
"id": "TRhb7bDRw4TQwUrGj7zCetVG",
"state": "PENDING"
}
]
}
}Transfer Succeeded
The event you receive when a Transfer gets updated to SUCCEEDED.
{
"type": "updated",
"entity": "transfer",
"occurred_at": "2020-04-26T23:42:18.582",
"_embedded": {
"transfers": [
{
"idempotency_id": null,
"amount": 95073,
"trace_id": "c2bf4ba1-ef59-4c1d-9313-8a46c096cf95",
"fee": 9507,
"destination": null,
"raw": null,
"created_at": "2020-04-26T23:41:55.13Z",
"source": "PI4CxWXFQBPjTiU1F1oUcRqz",
"merchant": "MU7cXuKj2xx41hhZZi6bZ13A",
"merchant_identity": "IDdpvBpQ9m6D3JDCRq9UDB2E",
"type": "DEBIT",
"tags": {
"order_number": "21DFASJSAKAS"
},
"statement_descriptor": "FIN*FINIX FLOWERS",
"ready_to_settle_at": null,
"application": "APkBUdiWzBjUAkfnbkirXs6d",
"updated_at": "2020-04-26T23:42:18.53Z",
"subtype": "API",
"messages": [],
"currency": "USD",
"id": "TRhb7bDRw4TQwUrGj7zCetVG",
"state": "SUCCEEDED"
}
]
}
}Refund a Debit
The event you receive when refunding or reversing a debit.
The event that gets sent has transfers.type: REVERSAL
-
type: created -
entity: transfer -
_embedded.transfers[0].type: REVERSAL
{
"type": "created",
"entity": "transfer",
"occurred_at": "2020-04-26T23:47:33.443",
"_embedded": {
"transfers": [
{
"idempotency_id": null,
"amount": 100,
"trace_id": "df499916-5cda-45f0-b1d9-3d59460cd867",
"fee": 0,
"destination": "PI5JEJTNwLzZ8rMMFV9QkaHz",
"raw": null,
"created_at": "2020-04-26T23:47:33.17Z",
"source": null,
"merchant": "MU7cXuKj2xx41hhZZi6bZ13A",
"merchant_identity": "IDdpvBpQ9m6D3JDCRq9UDB2E",
"type": "REVERSAL",
"tags": {},
"statement_descriptor": "FIN*FINIX FLOWERS",
"ready_to_settle_at": null,
"application": "APkBUdiWzBjUAkfnbkirXs6d",
"updated_at": "2020-04-26T23:47:33.39Z",
"subtype": "API",
"messages": [],
"currency": "USD",
"id": "TRxiRsBXhWp7ZdVwkRiEEjFm",
"state": "PENDING"
}
]
}
}[Card Present] Sale with EMV Card
The events you receive when processing a Transfer with an EMV card.
Transfer Created
The event you receive when a Transfer gets created to process a Transfer with an EMV card. The Transfer gets created with state: PENDING.
{
"type": "created",
"entity": "transfer",
"occurred_at": "2020-04-29T20:32:40.5",
"_embedded": {
"transfers": [
{
"idempotency_id": null,
"amount": 20000,
"trace_id": "FNXaEQJjdH6SLSNcU3JgUXenX",
"fee": 0,
"destination": null,
"raw": null,
"created_at": "2020-04-29T20:32:40.39Z",
"source": "PIbARkH2cDxpXChBDTDtGzZz",
"merchant": "MU7cXuKj2xx41hhZZi6bZ13A",
"merchant_identity": "IDgk8BqH6Kp176UF7KsQecio",
"type": "DEBIT",
"tags": {},
"statement_descriptor": "FIN*FINIX",
"ready_to_settle_at": null,
"application": "APiDZzAY28F2uSz47L88EuPk",
"updated_at": "2020-04-29T20:32:40.46Z",
"subtype": "API",
"messages": [],
"currency": "USD",
"id": "TRj4BxdJJu3XHF2xh9BgF8J9",
"state": "PENDING",
"device": "DV4b5w1TNAkBu9RTgXU7C19b"
}
]
}
}Transfer Updated
The event you receive when a Transfer gets updated to SUCCEEDED.
{
"type": "updated",
"entity": "transfer",
"occurred_at": "2020-04-29T20:32:57.697",
"_embedded": {
"transfers": [
{
"idempotency_id": null,
"amount": 20000,
"trace_id": "FNXaEQJjdH6SLSNcU3JgUXenX",
"fee": 0,
"destination": null,
"raw": null,
"created_at": "2020-04-29T20:32:40.39Z",
"source": "PIbARkH2cDxpXChBDTDtGzZz",
"merchant": "MU7cXuKj2xx41hhZZi6bZ13A",
"merchant_identity": "IDgk8BqH6Kp176UF7KsQecio",
"type": "DEBIT",
"tags": {},
"statement_descriptor": "FIN*FINIX",
"ready_to_settle_at": null,
"application": "APiDZzAY28F2uSz47L88EuPk",
"updated_at": "2020-04-29T20:32:57.55Z",
"subtype": "API",
"messages": [],
"currency": "USD",
"id": "TRj4BxdJJu3XHF2xh9BgF8J9",
"state": "SUCCEEDED",
"device": "DV4b5w1TNAkBu9RTgXU7C19b"
}
]
}
}Transfer Ready to Settle
The event you receive when the Transfer is ready for approval in a Settlement. A transfer is ready to settle when ready_to_settle_at gets updated with a timestamp.
{
"type": "updated",
"entity": "transfer",
"occurred_at": "2020-04-29T20:32:56.547",
"_embedded": {
"transfers": [
{
"idempotency_id": null,
"amount": 20000,
"trace_id": "FNXaEQJjdH6SLSNcU3JgUXenX",
"fee": 0,
"destination": null,
"raw": null,
"created_at": "2020-04-29T20:32:40.39Z",
"source": "PIbARkH2cDxpXChBDTDtGzZz",
"merchant": "MU7cXuKj2xx41hhZZi6bZ13A",
"merchant_identity": "IDgk8BqH6Kp176UF7KsQecio",
"type": "DEBIT",
"tags": {},
"statement_descriptor": "FIN*FINIX",
"ready_to_settle_at": "2020-04-29T20:32:56.51Z",
"application": "APiDZzAY28F2uSz47L88EuPk",
"updated_at": "2020-04-29T20:32:56.50Z",
"subtype": "API",
"messages": [],
"currency": "USD",
"id": "TRj4BxdJJu3XHF2xh9BgF8J9",
"state": "SUCCEEDED",
"device": "DV4b5w1TNAkBu9RTgXU7C19b"
}
]
}
}[Card Present] Sale with non EMV Card
The events you receive when a Transfer gets created for card present transactions.
Transfer Created
The event you receive when a Transfer gets created to process a card present transaction.
{
"type": "created",
"entity": "transfer",
"occurred_at": "2020-04-29T20:32:07.555",
"_embedded": {
"transfers": [
{
"idempotency_id": null,
"amount": 20000,
"trace_id": "FNXrkV69dG3nU4fNmW4Mtwpoo",
"fee": 0,
"destination": null,
"raw": null,
"created_at": "2020-04-29T20:32:07.37Z",
"source": "PI3WYRq5CjwrMAUV8STDXYJJ",
"merchant": "MU7cXuKj2xx41hhZZi6bZ13A",
"merchant_identity": "IDgk8BqH6Kp176UF7KsQecio",
"type": "DEBIT",
"tags": {},
"statement_descriptor": "FIN*FINIX",
"ready_to_settle_at": null,
"application": "APiDZzAY28F2uSz47L88EuPk",
"updated_at": "2020-04-29T20:32:07.50Z",
"subtype": "API",
"messages": [],
"currency": "USD",
"id": "TRgCH1Mo7dn9m1abgFDjQBzo",
"state": "PENDING",
"device": "DV4b5w1TNAkBu9RTgXU7C19b"
}
]
}
}Identity Created
The event you receive when an Identity gets created. The new Identity gets used to create the Payment Instrument for the non EMV card.
{
"type": "created",
"entity": "identity",
"occurred_at": "2020-04-29T20:32:07.637",
"_embedded": {
"identitys": [
{
"application": null,
"updated_at": "2020-04-29T20:32:07.37Z",
"created_at": "2020-04-29T20:32:07.37Z",
"id": "ID6ckSipRZQE6jDRYS78qEeH",
"entity": {
"title": null,
"first_name": null,
"last_name": null,
"email": null,
"business_name": null,
"business_type": null,
"doing_business_as": null,
"phone": null,
"business_phone": null,
"personal_address": null,
"business_address": null,
"mcc": null,
"dob": null,
"max_transaction_amount": 0,
"amex_mid": null,
"discover_mid": null,
"url": null,
"annual_card_volume": 0,
"has_accepted_credit_cards_previously": false,
"incorporation_date": null,
"principal_percentage_ownership": null,
"short_business_name": null,
"ownership_type": null,
"tax_authority": null,
"tax_id_provided": false,
"business_tax_id_provided": false,
"default_statement_descriptor": null
},
"identity_roles": [],
"tags": {}
}
]
}
}Transfer Updated
The event you receive when a Transfer gets updated to SUCCEEDED.
{
"type": "updated",
"entity": "transfer",
"occurred_at": "2020-04-29T20:32:31.508",
"_embedded": {
"transfers": [
{
"idempotency_id": null,
"amount": 20000,
"trace_id": "FNXrkV69dG3nU4fNmW4Mtwpoo",
"fee": 0,
"destination": null,
"raw": null,
"created_at": "2020-04-29T20:32:07.37Z",
"source": "PI3WYRq5CjwrMAUV8STDXYJJ",
"merchant": "MU7cXuKj2xx41hhZZi6bZ13A",
"merchant_identity": "IDgk8BqH6Kp176UF7KsQecio",
"type": "DEBIT",
"tags": {},
"statement_descriptor": "FIN*FINIX",
"ready_to_settle_at": null,
"application": "APiDZzAY28F2uSz47L88EuPk",
"updated_at": "2020-04-29T20:32:31.32Z",
"subtype": "API",
"messages": [],
"currency": "USD",
"id": "TRgCH1Mo7dn9m1abgFDjQBzo",
"state": "SUCCEEDED",
"device": "DV4b5w1TNAkBu9RTgXU7C19b"
}
]
}
}Transfer Ready to Settle
The event you receive when the Transfer is ready for approval in a Settlement. A transfer is ready to settle when ready_to_settle_at gets updated with a timestamp.
{
"type": "updated",
"entity": "transfer",
"occurred_at": "2020-04-29T20:32:29.772",
"_embedded": {
"transfers": [
{
"idempotency_id": null,
"amount": 20000,
"trace_id": "FNXrkV69dG3nU4fNmW4Mtwpoo",
"fee": 0,
"destination": null,
"raw": null,
"created_at": "2020-04-29T20:32:07.37Z",
"source": "PI3WYRq5CjwrMAUV8STDXYJJ",
"merchant": "MU7cXuKj2xx41hhZZi6bZ13A",
"merchant_identity": "IDgk8BqH6Kp176UF7KsQecio",
"type": "DEBIT",
"tags": {},
"statement_descriptor": "FIN*FINIX",
"ready_to_settle_at": "2020-04-29T20:32:29.67Z",
"application": "APiDZzAY28F2uSz47L88EuPk",
"updated_at": "2020-04-29T20:32:29.66Z",
"subtype": "API",
"messages": [],
"currency": "USD",
"id": "TRgCH1Mo7dn9m1abgFDjQBzo",
"state": "SUCCEEDED",
"device": "DV4b5w1TNAkBu9RTgXU7C19b"
}
]
}
}Sale with Manual Entry (Card Present)
The events you receive when a Transfer is created for a transaction processed via manual entry.
Transfer Created
The event you receive when a Transfer gets created for a transaction processed via manual entry.
{
"type": "created",
"entity": "transfer",
"occurred_at": "2020-04-29T20:34:06.854",
"_embedded": {
"transfers": [
{
"idempotency_id": null,
"amount": 20000,
"trace_id": "FNXaarxCYxm5ckVFPiyCKh8d1",
"fee": 0,
"destination": null,
"raw": null,
"created_at": "2020-04-29T20:34:06.69Z",
"source": "PInJceezonsp9C5Vcta3azs1",
"merchant": "MU7cXuKj2xx41hhZZi6bZ13A",
"merchant_identity": "IDgk8BqH6Kp176UF7KsQecio",
"type": "DEBIT",
"tags": {},
"statement_descriptor": "FIN*FINIX",
"ready_to_settle_at": null,
"application": "APiDZzAY28F2uSz47L88EuPk",
"updated_at": "2020-04-29T20:34:06.80Z",
"subtype": "API",
"messages": [],
"currency": "USD",
"id": "TRqq52oDiPVv3WJNb1B7M1UU",
"state": "PENDING",
"device": "DV4b5w1TNAkBu9RTgXU7C19b"
}
]
}
}Transfer Updated
The event you receive when a Transfer gets updated to SUCCEEDED.
{
"type": "updated",
"entity": "transfer",
"occurred_at": "2020-04-29T20:35:13.819",
"_embedded": {
"transfers": [
{
"idempotency_id": null,
"amount": 20000,
"trace_id": "FNXaarxCYxm5ckVFPiyCKh8d1",
"fee": 0,
"destination": null,
"raw": null,
"created_at": "2020-04-29T20:34:06.69Z",
"source": "PInJceezonsp9C5Vcta3azs1",
"merchant": "MU7cXuKj2xx41hhZZi6bZ13A",
"merchant_identity": "IDgk8BqH6Kp176UF7KsQecio",
"type": "DEBIT",
"tags": {},
"statement_descriptor": "FIN*FINIX",
"ready_to_settle_at": null,
"application": "APiDZzAY28F2uSz47L88EuPk",
"updated_at": "2020-04-29T20:35:13.57Z",
"subtype": "API",
"messages": [],
"currency": "USD",
"id": "TRqq52oDiPVv3WJNb1B7M1UU",
"state": "SUCCEEDED",
"device": "DV4b5w1TNAkBu9RTgXU7C19b"
}
]
}
}Transfer Ready to Settle
The event you receive when the Transfer is ready for approval in a Settlement. A transfer is ready to settle when ready_to_settle_at gets updated with a timestamp.
{
"type": "updated",
"entity": "transfer",
"occurred_at": "2020-04-29T20:35:11.986",
"_embedded": {
"transfers": [
{
"idempotency_id": null,
"amount": 20000,
"trace_id": "FNXaarxCYxm5ckVFPiyCKh8d1",
"fee": 0,
"destination": null,
"raw": null,
"created_at": "2020-04-29T20:34:06.69Z",
"source": "PInJceezonsp9C5Vcta3azs1",
"merchant": "MU7cXuKj2xx41hhZZi6bZ13A",
"merchant_identity": "IDgk8BqH6Kp176UF7KsQecio",
"type": "DEBIT",
"tags": {},
"statement_descriptor": "FIN*FINIX",
"ready_to_settle_at": "2020-04-29T20:35:11.94Z",
"application": "APiDZzAY28F2uSz47L88EuPk",
"updated_at": "2020-04-29T20:35:11.93Z",
"subtype": "API",
"messages": [],
"currency": "USD",
"id": "TRqq52oDiPVv3WJNb1B7M1UU",
"state": "SUCCEEDED",
"device": "DV4b5w1TNAkBu9RTgXU7C19b"
}
]
}
}Referenced Refund (Card Present)
The events you receive when a Card Present Transaction gets refunded/reversed.
Transfer Created
The event you receive when a Transfer gets created to refund a transaction. A Transfer created to process a refund will have type: REVERSAL.
{
"type": "created",
"entity": "transfer",
"occurred_at": "2020-04-29T20:37:36.256",
"_embedded": {
"transfers": [
{
"idempotency_id": null,
"amount": 1000,
"trace_id": "FNX2kW6zCR27aD9rqgxzXuHRE",
"fee": 0,
"destination": "PInJceezonsp9C5Vcta3azs1",
"raw": null,
"created_at": "2020-04-29T20:37:33.74Z",
"source": null,
"merchant": "MU7cXuKj2xx41hhZZi6bZ13A",
"merchant_identity": "IDgk8BqH6Kp176UF7KsQecio",
"type": "REVERSAL",
"tags": {},
"statement_descriptor": "FIN*FINIX",
"ready_to_settle_at": "2020-04-29T20:37:35.87Z",
"application": "APiDZzAY28F2uSz47L88EuPk",
"updated_at": "2020-04-29T20:37:35.87Z",
"subtype": "API",
"messages": [],
"currency": "USD",
"id": "TR9c8iiP5dsWnqQvMQgWowH1",
"state": "PENDING",
"device": "DV4b5w1TNAkBu9RTgXU7C19b"
}
]
}
}Transfer Updated
The event you receive when a reversal Transfer gets updated to SUCCEEDED.
{
"type": "updated",
"entity": "transfer",
"occurred_at": "2020-04-29T20:37:35.955",
"_embedded": {
"transfers": [
{
"idempotency_id": null,
"amount": 1000,
"trace_id": "FNX2kW6zCR27aD9rqgxzXuHRE",
"fee": 0,
"destination": "PInJceezonsp9C5Vcta3azs1",
"raw": null,
"created_at": "2020-04-29T20:37:33.74Z",
"source": null,
"merchant": "MU7cXuKj2xx41hhZZi6bZ13A",
"merchant_identity": "IDgk8BqH6Kp176UF7KsQecio",
"type": "REVERSAL",
"tags": {},
"statement_descriptor": "FIN*FINIX",
"ready_to_settle_at": null,
"application": "APiDZzAY28F2uSz47L88EuPk",
"updated_at": "2020-04-29T20:37:35.87Z",
"subtype": "API",
"messages": [],
"currency": "USD",
"id": "TR9c8iiP5dsWnqQvMQgWowH1",
"state": "SUCCEEDED",
"device": "DV4b5w1TNAkBu9RTgXU7C19b"
}
]
}
}Transfer Ready to Settle
The event you receive when the Transfer is ready for approval in a Settlement. A transfer is ready to settle when ready_to_settle_at gets updated with a timestamp.
{
"type": "updated",
"entity": "transfer",
"occurred_at": "2020-04-29T20:37:35.955",
"_embedded": {
"transfers": [
{
"idempotency_id": null,
"amount": 1000,
"trace_id": "FNX2kW6zCR27aD9rqgxzXuHRE",
"fee": 0,
"destination": "PInJceezonsp9C5Vcta3azs1",
"raw": null,
"created_at": "2020-04-29T20:37:33.74Z",
"source": null,
"merchant": "MU7cXuKj2xx41hhZZi6bZ13A",
"merchant_identity": "IDgk8BqH6Kp176UF7KsQecio",
"type": "REVERSAL",
"tags": {},
"statement_descriptor": "FIN*FINIX",
"ready_to_settle_at": "2020-04-29T20:37:35.87Z",
"application": "APiDZzAY28F2uSz47L88EuPk",
"updated_at": "2020-04-29T20:37:35.87Z",
"subtype": "API",
"messages": [],
"currency": "USD",
"id": "TR9c8iiP5dsWnqQvMQgWowH1",
"state": "SUCCEEDED",
"device": "DV4b5w1TNAkBu9RTgXU7C19b"
}
]
}
}Unreferenced Refund with Swipe Card (Card Present)
The events you receive when an unreferenced refund gets processed for a card present transaction.
Transfer Created
The event you receive when a Transfer gets created to refund a transaction where the card was swiped. A Transfer created to process a refund for a swiped card will have type: CREDIT.
{
"type": "created",
"entity": "transfer",
"occurred_at": "2020-04-29T20:38:15.648",
"_embedded": {
"transfers": [
{
"idempotency_id": null,
"amount": 5000,
"trace_id": "FNX4KXt8NXXttQZAghLj4jxtR",
"fee": 0,
"destination": "PI2KVAR4aohyZB9FTi23s18L",
"raw": null,
"created_at": "2020-04-29T20:38:15.49Z",
"source": null,
"merchant": "MU7cXuKj2xx41hhZZi6bZ13A",
"merchant_identity": "IDgk8BqH6Kp176UF7KsQecio",
"type": "CREDIT",
"tags": {
"order_number": "test"
},
"statement_descriptor": "FIN*FINIX",
"ready_to_settle_at": null,
"application": "APiDZzAY28F2uSz47L88EuPk",
"updated_at": "2020-04-29T20:38:15.59Z",
"subtype": "API",
"messages": [],
"currency": "USD",
"id": "TRc7FYetjSmUbKFVUTG5cJKq",
"state": "PENDING",
"device": "DV4b5w1TNAkBu9RTgXU7C19b"
}
]
}
}Transfer Updated
The event you receive when a reversal Transfer gets updated to SUCCEEDED.
{
"type": "updated",
"entity": "transfer",
"occurred_at": "2020-04-29T20:38:30.613",
"_embedded": {
"transfers": [
{
"idempotency_id": null,
"amount": 5000,
"trace_id": "FNX4KXt8NXXttQZAghLj4jxtR",
"fee": 0,
"destination": "PI2KVAR4aohyZB9FTi23s18L",
"raw": null,
"created_at": "2020-04-29T20:38:15.49Z",
"source": null,
"merchant": "MU7cXuKj2xx41hhZZi6bZ13A",
"merchant_identity": "IDgk8BqH6Kp176UF7KsQecio",
"type": "CREDIT",
"tags": {
"order_number": "test"
},
"statement_descriptor": "FIN*FINIX",
"ready_to_settle_at": null,
"application": "APiDZzAY28F2uSz47L88EuPk",
"updated_at": "2020-04-29T20:38:30.56Z",
"subtype": "API",
"messages": [],
"currency": "USD",
"id": "TRc7FYetjSmUbKFVUTG5cJKq",
"state": "SUCCEEDED",
"device": "DV4b5w1TNAkBu9RTgXU7C19b"
}
]
}
}Transfer Ready to Settle
The event you receive when the Transfer is ready for approval in a Settlement. A transfer is ready to settle when ready_to_settle_at gets updated with a timestamp.
{
"type": "updated",
"entity": "transfer",
"occurred_at": "2020-04-29T20:38:30.335",
"_embedded": {
"transfers": [
{
"idempotency_id": null,
"amount": 5000,
"trace_id": "FNX4KXt8NXXttQZAghLj4jxtR",
"fee": 0,
"destination": "PI2KVAR4aohyZB9FTi23s18L",
"raw": null,
"created_at": "2020-04-29T20:38:15.49Z",
"source": null,
"merchant": "MU7cXuKj2xx41hhZZi6bZ13A",
"merchant_identity": "IDgk8BqH6Kp176UF7KsQecio",
"type": "CREDIT",
"tags": {
"order_number": "test"
},
"statement_descriptor": "FIN*FINIX",
"ready_to_settle_at": "2020-04-29T20:38:30.29Z",
"application": "APiDZzAY28F2uSz47L88EuPk",
"updated_at": "2020-04-29T20:38:30.28Z",
"subtype": "API",
"messages": [],
"currency": "USD",
"id": "TRc7FYetjSmUbKFVUTG5cJKq",
"state": "SUCCEEDED",
"device": "DV4b5w1TNAkBu9RTgXU7C19b"
}
]
}
}Transfer Updated
The events that get sent when a Transfer gets updated.
Transfer Updated to Succeeded
The events that get sent when a Transfer gets updated to SUCCEEDED.
{
"type": "updated",
"entity": "transfer",
"occurred_at": "2020-04-26T23:51:06.063",
"_embedded": {
"transfers": [
{
"idempotency_id": null,
"amount": 100,
"trace_id": "df499916-5cda-45f0-b1d9-3d59460cd867",
"fee": 0,
"destination": "PI5JEJTNwLzZ8rMMFV9QkaHz",
"raw": null,
"created_at": "2020-04-26T23:47:33.17Z",
"source": null,
"merchant": "MU7cXuKj2xx41hhZZi6bZ13A",
"merchant_identity": "IDdpvBpQ9m6D3JDCRq9UDB2E",
"type": "REVERSAL",
"tags": {},
"statement_descriptor": "FIN*FINIX FLOWERS",
"ready_to_settle_at": null,
"application": "APkBUdiWzBjUAkfnbkirXs6d",
"updated_at": "2020-04-26T23:48:12.40Z",
"subtype": "API",
"messages": [],
"currency": "USD",
"id": "TRxiRsBXhWp7ZdVwkRiEEjFm",
"state": "SUCCEEDED"
}
]
}
}Transfer Ready to Settle
The event you receive when the Transfer is ready for approval in a Settlement. A transfer is ready to settle when ready_to_settle_at gets updated with a timestamp.
{
"type": "updated",
"entity": "transfer",
"occurred_at": "2020-04-26T23:51:27.34",
"_embedded": {
"transfers": [
{
"idempotency_id": null,
"amount": 95073,
"trace_id": "c2bf4ba1-ef59-4c1d-9313-8a46c096cf95",
"fee": 9507,
"destination": null,
"raw": null,
"created_at": "2020-04-26T23:41:55.13Z",
"source": "PI4CxWXFQBPjTiU1F1oUcRqz",
"merchant": "MU7cXuKj2xx41hhZZi6bZ13A",
"merchant_identity": "IDdpvBpQ9m6D3JDCRq9UDB2E",
"type": "DEBIT",
"tags": {
"order_number": "121212123"
},
"statement_descriptor": "FIN*FINIX FLOWERS",
"ready_to_settle_at": "2020-04-27T04:00:00.00Z",
"application": "APkBUdiWzBjUAkfnbkirXs6d",
"updated_at": "2020-04-26T23:51:27.27Z",
"subtype": "API",
"messages": [],
"currency": "USD",
"id": "TRhb7bDRw4TQwUrGj7zCetVG",
"state": "SUCCEEDED"
}
]
}
}Transfer Cancelled
The event you receive when a Transfer gets cancelled.
{
"type": "updated",
"entity": "transfer",
"occurred_at": "2022-08-09T22:30:09.692475",
"_embedded": {
"transfers": [
{
"idempotency_id": "4c39e773d04d60eb24ea767258cec28b",
"amount": 3238,
"trace_id": "FNX4hvw94KQPfipvLZVUUSx8y",
"failure_code": null,
"fee": 0,
"destination": null,
"raw": null,
"created_at": "2022-08-07T16:20:29.40Z",
"source": "PI8EV9PDtnTomU1SbhtXfss1",
"merchant": "MUeDVrf2ahuKc9Eg5TeZugvs",
"merchant_identity": "IDndzozsxaoZFPLgCAhTgpaN",
"failure_message": null,
"type": "DEBIT",
"tags": {},
"statement_descriptor": "FI *BEYOND",
"additional_buyer_charges": null,
"ready_to_settle_at": null,
"application": "APwug8rgLYVRAvDvBeuF3oFU",
"updated_at": "2022-08-09T22:30:08.48Z",
"subtype": "API",
"externally_funded": "UNKNOWN",
"messages": [],
"currency": "USD",
"id": "TRsXVRii1UWCGYG1XKXbpEVw",
"state": "CANCELED"
}
]
}
}Balance Transfer Created
The event you receive when a balance_transfer gets created.
{
"type": "created",
"entity": "balance_transfer",
"occurred_at": "2022-08-03T21:55:05.910359",
"_embedded": {
"balance_transfers": [
{
"amount": 4000,
"processor_type": "LITLE_V1",
"reference_id": "FNXn7iXXHxj5oE1z77yCAjXTa",
"destination": "FOR_BENEFIT_OF_ACCOUNT",
"created_at": "2022-08-03T21:48:30.81Z",
"description": "Need to increase buffer given the high number of NSFs on merchant fee debits",
"external_reference_id": "83989593962319302",
"source": "OPERATING_ACCOUNT",
"tags": {
"example": "documentation tag"
},
"updated_at": "2022-08-03T21:48:31.32Z",
"currency": "USD",
"id": "BT_sM2xrz69EKhvd6EsW3UjP",
"state": "SUCCEEDED"
}
]
}
}Dispute Created
The event you receive when a Dispute gets created.
{
"type": "created",
"entity": "dispute",
"occurred_at": "2022-05-13T21:28:12.289991",
"_embedded": {
"disputes": [
{
"reason": "FRAUD",
"amount": 888888,
"created_at": "2022-05-13T21:28:11.04Z",
"message": null,
"tags": {
"order_number": "21DFASJSAKAS"
},
"occurred_at": "2022-05-13T21:27:53.49Z",
"dispute_details": {
"arn": "123"
},
"transfer": "TRikkDuedytMAj6A1pdfFCTg",
"application": "AP3AB2itAWrrrPVS6spvrGYp",
"updated_at": "2022-05-13T21:28:10.49Z",
"identity": "IDsArLxCm9QGbi2QfhaFrTED",
"action": null,
"id": "DIaFfc4tNXbRDDXXFE5qt6Rq",
"state": "PENDING",
"respond_by": "2022-05-20T21:28:11.04Z"
}
]
}
}Dispute Evidence Created
The event you receive when evidence gets created for a Dispute.
{
"type": "created",
"entity": "evidence",
"occurred_at": "2022-08-10T21:05:16.417563",
"_embedded": {
"evidences": [
{
"dispute": "DItff2xbqSx3vbSUoepqwF5R",
"updated_at": "2022-08-10T21:05:11.99Z",
"created_at": "2022-08-10T21:05:11.99Z",
"id": "DFre6geC3iouMhzXjfGiwi5y",
"state": "PENDING",
"tags": {
"file-extension": ".png",
"content-type": "image/png",
"file-name": "evidence.png"
}
}
]
}
}Dispute Evidence Uploaded
The event you receive when documents are successfully uploaded to a evidence for a Dispute.
{
"type": "updated",
"entity": "evidence",
"occurred_at": "2022-08-09T17:23:37.554229",
"_embedded": {
"evidences": [
{
"dispute": "DIs7yQRkHDdMYhurzYz72SFk",
"updated_at": "2022-08-09T17:09:39.28Z",
"created_at": "2022-08-09T17:09:39.28Z",
"id": "DF45NRTbyfpuELmeTmvbpJwo",
"state": "SUCCEEDED",
"tags": {
"file-extension": ".png",
"content-type": "image/png",
"file-name": "finix_file.png"
}
}
]
}
}Dispute Updated
The event you receive when a Dispute gets updated.
{
"type": "updated",
"entity": "dispute",
"occurred_at": "2022-05-13T21:31:43.249792",
"_embedded": {
"disputes": [
{
"reason": "FRAUD",
"amount": 888888,
"created_at": "2022-05-13T21:28:11.04Z",
"message": null,
"tags": {
"order_number": "21DFASJSAKAS"
},
"occurred_at": "2022-05-13T21:27:53.49Z",
"dispute_details": {
"arn": "123"
},
"transfer": "TRikkDuedytMAj6A1pdfFCTg",
"application": "AP3AB2itAWrrrPVS6spvrGYp",
"updated_at": "2022-05-13T21:31:33.22Z",
"identity": "IDsArLxCm9QGbi2QfhaFrTED",
"action": null,
"id": "DIaFfc4tNXbRDDXXFE5qt6Rq",
"state": "WON",
"respond_by": "2022-05-20T21:28:11.04Z"
}
]
}
}