Webhook payloads

Webhook payload examples

Below are sample webhook payloads that will be sent to the configured webhook URL when an event is triggered:

`account.autopay.changed` payload

{
  "event": "account.autopay.changed",
  "person_id": "dddbe452-f8b0-401f-a348-1650207f13cd",
  "customer_id": "1601350c-62df-4a0d-b845-ef279c980240",
  "status": "enabled" // or "disabled"
}

`account.autopay.failed` payload

{
  "event": "account.autopay.failed",
  "person_id": "dddbe452-f8b0-401f-a348-1650207f13cd",
  "customer_id": "1601350c-62df-4a0d-b845-ef279c980240",
  "amount_in_cents": 10000,
  "statement_start_date": "2023-05-01",
  "statement_end_date": "2023-05-31"
}

`account.autopay.processed` payload

{
  "event": "account.autopay.processed",
  "person_id": "dddbe452-f8b0-401f-a348-1650207f13cd",
  "customer_id": "1601350c-62df-4a0d-b845-ef279c980240",
  "amount_in_cents": 10000,  
  "statement_start_date": "2023-05-01",
  "statement_end_date": "2023-05-31"
}

`account.autopay.scheduled` payload

{
  "event": "account.autopay.scheduled",
  "person_id": "dddbe452-f8b0-401f-a348-1650207f13cd",
  "customer_id": "1601350c-62df-4a0d-b845-ef279c980240",
  "amount_in_cents": 10000,  
  "statement_start_date": "2023-05-01",
  "statement_end_date": "2023-05-31"
}

`account.statements.generated` payload

{
  "event": "account.statements.generated",
  "person_id": "dddbe452-f8b0-401f-a348-1650207f13cd",
  "customer_id": "1601350c-62df-4a0d-b845-ef279c980240",
  "statement_start_date": "2023-05-01",
  "statement_end_date": "2023-05-31"
}

`account.statements.ready` payload

Below are examples for each type of statement (credit and deposit):

`credit` statement payload

{
  "event": "account.statements.ready",
  "occurred_at": "2022-07-21T19:05:09.403321+00:00",
  "details": {
    "type": "credit",
    "fees": 0,
    "transactions": [
      {
        "uuid": "1601350c-62df-4a0d-b845-ef279c980240",
        "transaction_description": "ach_f3a9f49d-df98-4b80-90d7-c25781694f50",
        "transaction_date": "2022-06-29",
        "transaction_type": "Payment",
        "amount": -123,
        "settled_date": "2022-06-29"
      }
    ],
    "credit": {
      "statement_balance": 9352,
      "credit_limit": 10000,
      "interest_charged": 0,
      "payment_due_date": "2022-07-22",
      "minimum_payment_due": 9352,
      "available_credit": 648,
      "purchases": 0,
      "previous_statement_balance": 9475,
      "payments_and_credits": 123
    },
    "statement_id": "dddbe452-f8b0-401f-a348-1650207f13cd",
    "statement_month": "2022-06",
    "statement_start_date": "2022-06-01",
    "statement_end_date": "2022-06-30",
    "account_id": "9d6e9039-15ec-4a8e-9693-e738f5be9a1b",
  }
}

`deposit` statement payload

{
  "event": "account.statements.ready",
  "occurred_at": "2022-07-22T16:54:00.054374+00:00",
  "details": {
    "fees": 0,
    "type": "deposit",
    "transactions": [
      {
        "uuid": "b03a9706-a6a9-4bd2-85cd-d92dbb50b744",
        "settled_date": "2022-07-21",
        "amount": 100,
        "transaction_date": "2022-07-20",
        "transaction_description": "virtual transfer",
        "transaction_type": "Account to Account"
      },
      {
        "transaction_description": "virtual transfer",
        "amount": 100,
        "transaction_date": "2022-07-20",
        "settled_date": "2022-07-21",
        "uuid": "deb4b4c5-e00f-42e1-94b6-2195718d0392",
        "transaction_type": "Account to Account"
      },
      {
        "transaction_date": "2022-07-20",
        "amount": 100,
        "transaction_description": "virtual transfer",
        "settled_date": "2022-07-21",
        "transaction_type": "Account to Account",
        "uuid": "af82dfc1-a1ea-4f30-a9e3-d4a9b91ef2d9"
      },
      {
        "transaction_description": "virtual transfer",
        "transaction_date": "2022-07-20",
        "transaction_type": "Account to Account",
        "uuid": "f7576c74-27b8-418c-99e1-eee4d7be7be0",
        "amount": 100,
        "settled_date": "2022-07-21"
      }
    ],
    "deposit": {
      "deposits": 200,
      "beginning_balance": 0,
      "ending_balance": 0,
      "withdrawals": 200
    },
    "statement_id": "776b3133-313c-4891-9742-1356d7386424",
    "statement_month": "2022-07",
    "statement_start_date": "2022-07-01",
    "statement_end_date": "2022-07-20",
    "account_id": "ff84f6de-54c3-447c-ba56-134a889b88f4"
  }
}

`card.created` payload

{
  "event": "card.created",
  "card": {
    "status": "Active",
    "card_account_id": "00c96cd0-0e28-48c1-a8f0-63edba69276d",
    "last_four": "5181",
    "card_id": "beb8732c-d2ca-4422-b408-91bbe3e2aebf",
    "customer_id": "1601350c-62df-4a0d-b845-ef279c980240"
  },
  "occurred_at": "2022-07-15T16:33:51.032050+00:00"
}

`card.status.active` payload

{
  "event": "card.status.active",
  "card": {
    "card_id": "9e30d021-3f39-4fcc-935b-e286d7f52807",
    "status": "Active",
    "last_four": "3351"
  },
  "occurred_at": "2022-07-15T19:46:50.778488+00:00"
}

`card.status.closed` payload

{
  "event": "card.status.closed",
  "card": {
    "card_id": "5475ad4b-1ae8-4e9e-b4c2-d1badff35564",
    "status": "Closed",
    "last_four": "9472"
  },
  "occurred_at": "2022-07-15T17:10:19.903691+00:00"
}

`card.status.fraud` payload

{
  "event": "card.status.fraud",
  "card": {
    "status": "Fraud",
    "card_id": "ee98bd82-a63b-452b-b884-f672a33e8db0",
    "last_four": "3586"
  },
  "occurred_at": "2022-07-15T17:05:05.814836+00:00"
}

`card.status.inactive` payload

{
  "event": "card.status.inactive",
  "card": {
    "card_id": "ee98bd82-a63b-452b-b884-f672a33e8db0",
    "status": "Inactive",
    "last_four": "3586"
  },
  "occurred_at": "2022-07-15T17:05:11.905684+00:00"
}

`card.status.reissue` payload

{
  "event": "card.status.reissue",
  "card": {
    "status": "Reissue",
    "card_id": "ee98bd82-a63b-452b-b884-f672a33e8db0",
    "last_four": "3586"
  },
  "occurred_at": "2022-07-15T17:05:52.316767+00:00"
}

`develop.api_key.created` payload

{
  "event": "develop.api_key.created",
  "occurred_at": "2023-10-06T20:03:48.508039+00:00",
  "created_by": "[email protected]",
  "identity": "1601350c-62df-4a0d-b845-ef279c980240",
  "key_name": "test_key"
}

`kyc.verification.document_required` payload

{
  "event": "kyc.verification.document_required",
  "occurred_at": "2023-03-20T15:41:10.620021+00:00",
  "inquiry_id": "inq_Y8Pe2kSAJ7away95sUUXBpAh",
  "customer_id": "e413a8e7-f072-4e6d-9589-cea35de849c5",
  "documents": [
    {
      "document_type": "persona",
      "status": "required",
      "upload_link": "https://inquiry.withpersona.com/verify?environment=sandbox&inquiry-id=inq_Y8Pe2kSAJ7away95sUUXBpAh"
    }
  ]
}

`kyc.verification.under_review` payload

{
  "event": "kyc.verification.under_review",
  "customer_id": "1d48c087-f68e-48ab-b779-a15a3dca4c27",
  "occurred_at": "2022-07-15T16:54:12.058527+00:00"
}

`kyc.verification.success` payload

{
  "event": "kyc.verification.success",
  "customer_id": "1d48c087-f68e-48ab-b779-a15a3dca4c27",
  "occurred_at": "2022-07-15T16:36:46.167945+00:00"
}

`kyc.verification.failure` payload

{
  "event": "kyc.verification.failure",
  "customer_id": "1d48c087-f68e-48ab-b779-a15a3dca4c27",
  "occurred_at": "2022-07-15T16:41:10.284335+00:00"
}

`kyc.verification.timeout` payload

{
  "event": "kyc.verification.timeout",
  "occurred_at": "2022-07-15T19:10:50.187657+00:00",
  "customer_id": "6c83e28d-f93b-4446-86e4-a68b414a39e6"
}

`kyb.verification.approved` payload

{
  "event": "kyb.verification.approved",
  "business_id": "0b84df2b-c344-4e70-a496-ecec769a84af",
  "occurred_at": "2022-07-15T17:06:41.122010+00:00"
}

`credit.application.created` payload

{
  "event": "credit.application.created",
  "occurred_at": "2022-08-23T20:55:32.495309+00:00",
  "details": {
    "resource": "credit.application",
    "data": {
      "applicant": {
        "ssn": "XXXXX1234",
        "monthly_housing_payment": 1000,
        "zip_code": "94104",
        "street2": "Ste 600",
        "customer_id": "9e1981d9-59c4-433b-a269-e63fb463f36f",
        "total_annual_income": 100000,
        "date_of_birth": "1970-01-01",
        "street1": "345 California St",
        "city": "San Francisco",
        "email": "[email protected]",
        "phone_country_code": null,
        "address_id": "b4f3c81b-96fc-49b3-8517-cf8e75af5012",
        "last_name": "Bond",
        "middle_name": "",
        "phone": null,
        "state": "CA",
        "first_name": "James",
        "country": "US"
      },
      "application_id": "109079cb-7995-4e67-be10-ad5279c6c352",
      "accounts": {
        "security_deposit_account_id": null
      },
      "date_updated": "2024-03-14T22:08:35.839853+00:00",
    	"date_created": "2024-01-09T20:01:56.375201+00:00",
      "program_id": "816d1c5a-f3d5-4dc0-84b2-7c6dff6a7c4c",
      "application_status": "created"
    }
  }
}

`credit.application.submitted` payload

{
  "event": "credit.application.submitted",
  "occurred_at": "2022-08-23T20:55:55.663776+00:00",
  "details": {
    "resource": "credit.application",
    "data": {
      "date_updated": "2024-03-14T22:08:35.839853+00:00",
      "date_created": "2024-01-09T20:01:56.375201+00:00",
      "accounts": {
        "security_deposit_account_id": null
      },
      "application_id": "109079cb-7995-4e67-be10-ad5279c6c352",
      "program_id": "816d1c5a-f3d5-4dc0-84b2-7c6dff6a7c4c",
      "application_status": "submitted",
      "applicant": {
        "ssn": "XXXXX1234",
        "monthly_housing_payment": 1000,
        "zip_code": "94104",
        "street2": "Ste 600",
        "customer_id": "9e1981d9-59c4-433b-a269-e63fb463f36f",
        "total_annual_income": 100000,
        "date_of_birth": "1970-01-01",
        "street1": "345 California St",
        "city": "San Francisco",
        "email": "[email protected]",
        "phone_country_code": null,
        "address_id": "b4f3c81b-96fc-49b3-8517-cf8e75af5012",
        "last_name": "Bond",
        "middle_name": "",
        "phone": null,
        "state": "CA",
        "first_name": "James",
        "country": "US"
      }
    }
  }
}

`credit.application.approved` payload

{
  "event": "credit.application.approved",
  "occurred_at": "2022-08-23T20:56:03.778815+00:00",
  "details": {
    "resource": "credit.application",
    "data": {
      "application_id": "109079cb-7995-4e67-be10-ad5279c6c352",
      "applicant": {
        "ssn": "XXXXX1234",
        "monthly_housing_payment": 1000,
        "zip_code": "94104",
        "street2": "Ste 600",
        "customer_id": "9e1981d9-59c4-433b-a269-e63fb463f36f",
        "total_annual_income": 100000,
        "date_of_birth": "1970-01-01",
        "street1": "345 California St",
        "city": "San Francisco",
        "email": "[email protected]",
        "phone_country_code": null,
        "address_id": "b4f3c81b-96fc-49b3-8517-cf8e75af5012",
        "last_name": "Bond",
        "middle_name": "",
        "phone": null,
        "state": "CA",
        "first_name": "James",
        "country": "US"
      },
      "date_updated": "2024-03-14T22:08:35.839853+00:00",
      "date_created": "2024-01-09T20:01:56.375201+00:00",
      "application_status": "approved",
      "accounts": {
        "security_deposit_account_id": "598f15bd-407f-4a6e-9eba-ce81d3090c3f"
      },
      "program_id": "816d1c5a-f3d5-4dc0-84b2-7c6dff6a7c4c"
    }
  }
}

`credit.application.resubmit_required` payload

{
  "event": "credit.application.resubmit_required",
  "occurred_at": "2022-07-23T20:00:17.018488+00:00",
  "details": {
    "data": {
      "application_id": "8717de3b-ccdc-4471-9a0a-eb2d2796e113",
      "accounts": {
        "security_deposit_account_id": null
      },
      "date_updated": "2024-03-14T22:08:35.839853+00:00",
      "date_created": "2024-01-09T20:01:56.375201+00:00",
      "application_status": "resubmit_required",
      "applicant": {
        "ssn": "XXXXX1234",
        "monthly_housing_payment": 1000,
        "zip_code": "94104",
        "street2": "Ste 600",
        "customer_id": "9e1981d9-59c4-433b-a269-e63fb463f36f",
        "total_annual_income": 100000,
        "date_of_birth": "1970-01-01",
        "street1": "345 California St",
        "city": "San Francisco",
        "email": "[email protected]",
        "phone_country_code": null,
        "address_id": "b4f3c81b-96fc-49b3-8517-cf8e75af5012",
        "last_name": "Bond",
        "middle_name": "",
        "phone": null,
        "state": "CA",
        "first_name": "James",
        "country": "US"
      },
      "program_id": "1be27a53-e449-4d5f-8be6-d7c930ea79c4"
    },
    "resource": "credit.application"
  }
}

`credit.application.adverse_action` payload

{
  "event": "credit.application.adverse_action",
  "sent_time": "2022-06-24T18:36:30.416759",
  "details": {
    "resource": "credit.application",
    "data": {
      "application_id": "aff6e905-5f4e-49fa-8098-ef7681b056dc",
      "applicant": {
        "ssn": "XXXXX1234",
        "monthly_housing_payment": 1000,
        "zip_code": "94104",
        "street2": "Ste 600",
        "customer_id": "9e1981d9-59c4-433b-a269-e63fb463f36f",
        "total_annual_income": 100000,
        "date_of_birth": "1970-01-01",
        "street1": "345 California St",
        "city": "San Francisco",
        "email": "[email protected]",
        "phone_country_code": null,
        "address_id": "b4f3c81b-96fc-49b3-8517-cf8e75af5012",
        "last_name": "Bond",
        "middle_name": "",
        "phone": null,
        "state": "CA",
        "first_name": "James",
        "country": "US"
      },
      "adverse_action": {
            "id": "0a7457c4-e195-4711-9aeb-95f21edd47bb",
            "application_id": "a09cf774-29fe-4a1b-82f3-4ac365136074",
            "date_created": "2022-04-11T13:13:27.197638Z",
            "date_updated": "2022-04-11T13:13:27.284854Z",
            "service": "kyc",
            "reasons": [
                "Unable to verify identity"
            ]
        },
      "date_created": "2022-06-24T18:34:02.808056Z",
      "date_updated": "2022-06-24T18:36:30.401454Z",
      "program_id": "4ff0aefa-a02f-4d20-b520-33eefcd8d5e2",
      "application_status": "denied",
      "accounts": {
        "security_deposit_account_id": null
      }
    }
  }
}

`customer.updated` payload

{
  "event": "customer.updated",
  "occurred_at": "2023-10-18T16:27:26.984242+00:00",
  "details": {
    "last_name": "Bond",
    "phone_country_code": "1",
    "addresses": [
      {
        "zip_code": "12345-1111",
        "city": "San Francisco",
        "address_id": "b4f3c81b-96fc-49b3-8517-cf8e75af5012",
        "country": "US",
        "date_created": "2022-04-25T03:31:46.824113+00:00",
        "state": "CA",
        "street": "123 Market St",
        "address_type": "PHYSICAL",
        "street2": "",
        "is_primary": true
      }
    ],
    "first_name": "James",
    "business_id": null,
    "customer_id": "9e1981d9-59c4-433b-a269-e63fb463f36f",
    "email": "[email protected]",
    "bond_brand_id": "00000000-0000-0000-0000-000000000000",
    "middle_name": "Herbert",
    "kyc_requests_available": 0,
    "ssn": "XXX-XX-5555",
    "date_created": "2022-04-25T03:31:46.822224+00:00",
    "brand_person_id": "832be8a2-7f5e-4d92-c1dd-b5923cc57f88",
    "dob": "1920-11-11",
    "phone": "1234567890"
  }
}

`portal.data_export` payload

{
  "event": "portal.data_export",
  "occurred_at": "2023-10-10T15:39:40.688784+00:00",
  "created_by": "[email protected]",
  "details": {
    "business_id": null,
    "transaction_type": null,
    "order_by": "desc",
    "transaction_state": null,
    "report_type": "transaction",
    "num_rows": 100,
    "payment_type": null,
    "start_date": "2023-09-10",
    "transaction_id": null,
    "end_date": "2023-10-10",
    "customer_id": null
  }
}

`transactions` payload

Below are examples for each type of transaction (card, ACH, and account):

Card payment payload

{
  "event": "transactions",
  "transaction": {
    "transaction_id": "f3d106b6-45b3-45bd-be44-7c56687cc58a",
    "bond_brand_id": "00000000-0000-0000-0000-000000000000",
    "customer_id": "90513b2a-bfe9-4f8a-8eb7-53a62ae17f6e",
    "account_id": "5f7fbde2-520f-4805-8dcd-848b5aa0298a",
    "payment_type": "card",
    "transaction_type": "POS Purchase",
    "state": "pending",
    "description": "Pre-Auth Transaction-POS Signature Purchase - Partial Amount",
    "amount": "-21.93",
    "fee": "0.00",
    "currency": "USD",
    "created_time": "2022-07-15T18:57:28+00:00",
    "updated_time": "2022-07-15T18:57:28+00:00",
    "balances": {
      "prior_balance": "-38.07",
      "new_balance": "-60.00"
    },
    "details": {
      "card_id": "02045f3a-4e4e-4b79-84cc-f45e9427674a",
      "mcc": "5814",
      "mcc_description": "Fast Food",
      "currency": "USD",
      "exchange_rate": "1.00",
      "merchant_id": "4445197736264",
      "merchant_name": "Wendy'S #878",
      "merchant_city": "SAN BRUNO    ",
      "merchant_state": "CA",
      "merchant_currency": "USD",
      "merchant_amount": "-22.72",
      "cardholder_presence": true,
      "statement_descriptor": "WENDY'S #878             SAN BRUNO    CAUSA"
    }
  },
  "occurred_at": "2022-06-28T15:38:50.473639+00:00"
}

ACH transfer payload

{
  "event": "transactions",
  "transaction": {
    "transaction_id": "337f8357-babc-4362-b814-fa2c5aaf19b6",
    "bond_brand_id": "00000000-0000-0000-0000-000000000000",
    "customer_id": "08dcd97e-bacb-4da3-bd36-2a8e5655400e",
    "account_id": "b9302eb7-c9ce-4487-a790-d31d12448b34",
    "payment_type": "ach",
    "transaction_type": "ACH Deposit",
    "state": "pending",
    "amount": "0.01",
    "currency": "USD",
    "created_time": "2022-07-15T16:08:54.226382+00:00",
    "updated_time": "2022-07-15T16:08:54.226382+00:00",
    "balances": {
      "prior_balance": "49.00",
      "new_balance": "49.00"
    },
    "details": {
      "card_id": "3a69d8ba-29c1-4541-8b6d-d52aebd708f7",
      "external_account_id": "bfe86340-a3f9-49fd-b278-0bff7346041c",
      "class_code": "WEB",
      "direction": "debit",
      "network": "same-day-ach",
      "description": "Test"
    }
  },
  "occurred_at": "2022-06-23T16:22:06.612669+00:00"
}

Card-to-card transfer payload

{
  "event": "transactions",
  "transaction": {
    "transaction_id": "0721ae9e-616b-4af8-864c-3b7c8b740424",
    "bond_brand_id": "5ca99020-807b-45fa-897f-c0fbf90be275",
    "customer_id": "4a70f31c-4e2e-4566-b867-642e3470dab2",
    "account_id": "d5b95905-9421-47c0-beb7-ddd6a26e25a8",
    "payment_type": "account",
    "transaction_type": "Card to Card Transfer",
    "state": "completed",
    "amount": "10.00",
    "currency": "USD",
    "created_time": "2022-07-15T19:41:35+00:00",
    "updated_time": "2022-07-15T19:41:35+00:00",
    "balances": {
      "prior_balance": "180.01",
      "new_balance": "190.01"
    },
    "details": {
      "origination_card_id": "9e30d021-3f39-4fcc-935b-e286d7f52807",
      "destination_card_id": "66ce7043-1a1f-48b2-9240-82be0ed0f539"
    }
  },
  "occurred_at": "2022-06-23T16:22:06.943717+00:00"
}

Webhook payload examples

account.autopay.changed payload

account.autopay.failed payload

account.autopay.processed payload

account.autopay.scheduled payload

account.statements.generated payload

account.statements.ready payload

credit statement payload

deposit statement payload

card.created payload

card.status.active payload

card.status.closed payload

card.status.fraud payload

card.status.inactive payload

card.status.reissue payload

develop.api_key.created payload

kyc.verification.document_required payload

kyc.verification.under_review payload

kyc.verification.success payload

kyc.verification.failure payload

kyc.verification.timeout payload

kyb.verification.approved payload

credit.application.created payload

credit.application.submitted payload

credit.application.approved payload

credit.application.resubmit_required payload

credit.application.adverse_action payload

customer.updated payload

portal.data_export payload

transactions payload