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 An balance_transfer was created. This is only sent to CORE customers.
balance_transfer updated An 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 submitted for provisioning.
merchant updated A merchant was updated. This commonly happens when provisioning merchants and updating merchant details. The merchants.onboarding_state will tell you if the request was APPROVED or REJECTED.
merchant underwritten A merchant was underwritten and can now start handling 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.
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 created A settlement was created. settlements.total_amount and settlements.net_amount tells you the total of the payout.
settlement updated A settlement was updated.
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 verifications.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 an example below to confirm the related activity occurred or completed in Finix.

Authorization Created

The event that gets sent when an authorization is created.

Copy
Copied
{
    "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_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:

  • entity = authorization
  • type = updated
  • transfer = : TRANSFER_ID:
Copy
Copied
{
    "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_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.

Copy
Copied
{
    "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_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.

Copy
Copied
{
    "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
                },
                "tags": {}
            }
        ]
    }
}

Payment Instrument Created

The event you receive when a Payment Instrument gets created for an EMV card.

Copy
Copied
{
    "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.

Copy
Copied
{
    "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_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.

Copy
Copied
{
    "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_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.

Copy
Copied
{
    "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_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.

Copy
Copied
{
    "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_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.

Copy
Copied
{
    "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
                },
                "tags": {}
            }
        ]
    }
}

Payment Instrument Created

The event you receive when a Payment Instrument gets created for a non-EMV card.

Copy
Copied
{
    "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.

Copy
Copied
{
    "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_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.

Copy
Copied
{
    "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_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.

Copy
Copied
{
    "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_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.

Copy
Copied
{
    "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_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.

Copy
Copied
{
    "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_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.

Copy
Copied
{
    "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_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.

Copy
Copied
{
    "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
                },
                "tags": {
                    "key": "value"
                }
            }
        ]
    }
}

Identity Created for a Merchant

The event you receive when an Identity gets created for a merchant.

Copy
Copied
{
    "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": "0742",
                    "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"
                },
                "tags": {
                    "Studio Rating": "4.7"
                }
            }
        ]
    }
}

Identity Updated

The event you receive when an Identity gets updated.

Copy
Copied
{
    "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": "0742",
                    "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"
                },
                "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.

Copy
Copied
{
    "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": "0742",
                "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.

Copy
Copied
{
    "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.

Copy
Copied
{
    "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.

Copy
Copied
{
    "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": "0742",
                "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.

Copy
Copied
{
    "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.

Copy
Copied
{
    "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.

Copy
Copied
{
    "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.

Copy
Copied
{
    "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": "0742",
                "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

The event you receive when the merchant_profile gets updated with with a new risk_profile.

Copy
Copied
{
    "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": {}
            }
        ]
    }
}

Payment Instrument Created

The event that's sent when a Payment Instrument gets created for the merchant.

Copy
Copied
{
    "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.

Copy
Copied
{
    "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.

Copy
Copied
{
    "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.

Copy
Copied
{
    "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": "0742",
                "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.

Copy
Copied
{
    "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": "0742",
                "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.

Copy
Copied
{
    "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.

Copy
Copied
{
    "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"
            }
        ]
    }
}

Inital Verification Failed

The event you receive when the Verification request to underwrite the merchant get denied. If denied, state gets updated to FAILED.

Copy
Copied
{
    "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.

Copy
Copied
{
    "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": "0742",
                "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.

Copy
Copied
{
    "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.

Copy
Copied
{
    "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": "0742",
                "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.

Copy
Copied
{
    "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 recieve sent when a File gets created.

Copy
Copied
{
    "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 recieve when a File is approved. When approved, the status of the File gets updated to UPLOADED.

Copy
Copied
  {
    "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.

Copy
Copied
  {
    "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.

Copy
Copied
{
    "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 recieve when an external_link gets updated.

Copy
Copied
{
    "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.

Copy
Copied
{
    "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.

Copy
Copied
{
    "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"
            }
        ]
    }
}

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 recieve when an Instrument Update request gets created.

Copy
Copied
{
  "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 recieve when the payment_instruments gets updated.

Copy
Copied
{
    "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 recieve detials the verification that gets created to process the Instrument Update request.

Copy
Copied
{
    "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"
            }
        ]
    }
}

Settlement Created

The event you recieve when a Settlement gets created.

Copy
Copied
{
  "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 Accruing

The event you recieve when a Settlement begins accruing transactions.

Copy
Copied
{
  "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"
      }
    ]
  }
}

Approved Settlement

The event you receive when a Settlement gets approved.

Copy
Copied
{
  "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.

Copy
Copied
{
  "type" : "created",
  "entity" : "transfer",
  "occurred_at" : "2020-02-08T00:53:19.495",
  "_embedded" : {
    "transfers" : [ {
      "idempotency_id" : null,
      "amount" : 640830,
      "trace_id" : "FNXs7nZ7Wo9h7JYHWA7WT1v9J",
      "fee" : 0,
      "destination" : "PIsmXAK15VPu3uW46P1rd5gg",
      "raw" : null,
      "created_at" : "2020-02-08T00:52:05.05Z",
      "source" : null,
      "merchant_identity" : "IDsAdjiN5uWCTdNojKLse8SM",
      "type" : "SETTLEMENT",
      "tags" : { },
      "statement_descriptor" : null,
      "ready_to_settle_at" : null,
      "application" : "APrtqGVzLhi8FxpLKLE8Ajvm",
      "updated_at" : "2020-02-08T00:53:18.38Z",  
      "subtype" : "API",
      "messages" : [ ],
      "currency" : "USD",
      "id" : "TRmu2oZ8tk94jrnm6DpQhu11",
      "state" : "SUCCEEDED"
    } ]
  }
}

Debit a Bank Account (ie eCheck)

The events you receive using eCheck to debit a bank acccount.

transfer Created

The event you recieve when a transfer gets created to debit a bank account.

Copy
Copied
{
    "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_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 recieve when a transfer gets updated to SUCCEEDED.

Copy
Copied
{
    "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_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 recieve when refunding or reversing a debit.

The event that gets sent has transfers.type as REVERSAL:

  • entity = transfer
  • type = created
  • transfers.type = REVERSAL
Copy
Copied
{
    "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_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 recieve 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 a PENDING state.

Copy
Copied
{
    "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_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.

Copy
Copied
{
    "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_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 recieve 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.

Copy
Copied
{
    "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_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.

Copy
Copied
{
    "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_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.

Copy
Copied
{
    "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
                },
                "tags": {}
            }
        ]
    }
}

transfer Updated

The event you receive when a transfer gets updated to SUCCEEDED.

Copy
Copied
{
    "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_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 recieve 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.

Copy
Copied
{
    "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_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.

Copy
Copied
{
    "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_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.

Copy
Copied
{
    "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_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.

Copy
Copied
{
    "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_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 recieve 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.

Copy
Copied
{
    "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_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.

Copy
Copied
{
    "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_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.

Copy
Copied
{
    "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_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 unrefrenced 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.

Copy
Copied
{
    "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_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.

Copy
Copied
{
    "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_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.

Copy
Copied
{
    "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_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 Succedded

The events that get sent when a transfer gets updated to SUCCEEDED.

Copy
Copied
{
    "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_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.

Copy
Copied
{
    "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_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.

Copy
Copied
{
    "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_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.

Copy
Copied
{{
    "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.

Copy
Copied
{
  "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.

Copy
Copied
{{
    "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 succesffully uploaded to a evidence for a Dispute.

Copy
Copied
{{
    "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 recieve when a Dispute gets updated.

Copy
Copied
{
  "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"
      }
    ]
  }
}