Skip to main content

Documentation Index

Fetch the complete documentation index at: https://gnosispay-feat-v2-auth-module.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Account Events

1. Account.balance.changed

Triggered when the account balance changes.

Event Trigger Points

FlowReason Value
Deposit approveddeposit.approved
Deposit rejecteddeposit.rejected
Withdrawal completedwithdrawal.completed
Instant withdrawal reconciledwithdrawal.completed
Card authorizationcard.authorization.{category}
{
   "id": "evt_abc123def456...",
   "type": "account.balance.changed",
   "createdAt": "2026-03-30T12:00:00.000000000Z",
   "data": {
     "accountId": "550e8400-e29b-41d4-a716-446655440000",
     "reason": "deposit.approved",
     "referenceId": "ref-123",
     "balances": [
       {
         "currency": "EUR",
         "decimals": 18,
         "spendable": "1000000000000000000",
         "nonSpendable": "500000000000000000",
         "processingDeposits": "200000000000000000",
         "processingWithdrawals": "100000000000000000"
       },
       {
         "currency": "GBP",
         "decimals": 18,
         "spendable": "0",
         "nonSpendable": "0",
         "processingDeposits": "0",
         "processingWithdrawals": "0"
       },
       {
         "currency": "USD",
         "decimals": 6,
         "spendable": "1000000",
         "nonSpendable": "50000",
         "processingDeposits": "100000",
         "processingWithdrawals": "0"
       }
     ]
   }
 }

2. Account.created

Triggered when a new account is created and provisioning begins.
{
  "id": "evt_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4",
  "type": "account.created",
  "createdAt": "2026-03-11T14:30:00.123456789Z",
  "data": {
    "id": "019505a1-b2c3-7d4e-a5f6-a1b2c3d4e5f6",
    "kycProfileId": "019505a1-c3d4-7e5f-b6a7-b2c3d4e5f6a7",
    "safeOwnerAddress": "0x1234567890abcdef1234567890abcdef12345678",
    "safeAddress": null,
    "chain": {
      "name": "gnosis",
      "id": "100"
    },
    "reference": null,
    "nativeCurrency": "EUR",
    "additionalCurrencies": ["GBP"],
    "createdAt": "2026-03-11T14:30:00.123456789Z",
    "updatedAt": "2026-03-11T14:30:00.123456789Z",
    "closedAt": null,
    "status": "provisioning",
    "provisionedAt": null
  }
}

3. Account.activated

Triggered when account provisioning is complete and account becomes active.
{
  "id": "evt_b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7",
  "type": "account.activated",
  "createdAt": "2026-03-11T15:00:00.123456789Z",
  "data": {
    "id": "019505a1-b2c3-7d4e-a5f6-a1b2c3d4e5f6",
    "kycProfileId": "019505a1-c3d4-7e5f-b6a7-b2c3d4e5f6a7",
    "safeOwnerAddress": "0x1234567890abcdef1234567890abcdef12345678",
    "safeAddress": "0xabcdef1234567890abcdef1234567890abcdef12",
    "chain": {
      "name": "gnosis",
      "id": "100"
    },
    "reference": "partner-ref-123",
    "nativeCurrency": "EUR",
    "additionalCurrencies": ["GBP"],
    "createdAt": "2026-03-11T14:30:00.123456789Z",
    "updatedAt": "2026-03-11T15:00:00.123456789Z",
    "closedAt": null,
    "status": "active",
    "provisionedAt": "2026-03-11T14:45:00.123456789Z"
  }
}

4. Account.blocked

Triggered when an account is blocked due to security or compliance reasons.
{
  "id": "evt_c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8",
  "type": "account.blocked",
  "createdAt": "2026-03-11T16:00:00.123456789Z",
  "data": {
    "id": "019505a1-b2c3-7d4e-a5f6-a1b2c3d4e5f6",
    "kycProfileId": "019505a1-c3d4-7e5f-b6a7-b2c3d4e5f6a7",
    "safeOwnerAddress": "0x1234567890abcdef1234567890abcdef12345678",
    "safeAddress": "0xabcdef1234567890abcdef1234567890abcdef12",
    "chain": {
      "name": "gnosis",
      "id": "100"
    },
    "reference": "partner-ref-123",
    "nativeCurrency": "EUR",
    "additionalCurrencies": ["GBP"],
    "createdAt": "2026-03-11T14:30:00.123456789Z",
    "updatedAt": "2026-03-11T16:00:00.123456789Z",
    "closedAt": null,
    "status": "blocked",
    "provisionedAt": "2026-03-11T14:45:00.123456789Z"
  }
}

KYC Events

5. KYC.profile.approved

Triggered when a KYC profile verification is approved.
{
  "id": "evt_d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9",
  "type": "kyc.profile.approved",
  "createdAt": "2026-03-11T14:00:00.123456789Z",
  "data": {
    "id": "019505a1-c3d4-7e5f-b6a7-b2c3d4e5f6a7",
    "reference": "applicant-abc123",
    "email": "user@example.com",
    "status": "approved",
    "tenantId": "tenant-xyz",
    "details": {
      "fullName": "John Doe",
      "phoneNumber": "+441234567890",
      "dateOfBirth": "1990-01-15T00:00:00Z",
      "nationality": "GB",
      "countryOfResidence": "GB",
      "countryOfBirth": "GB",
      "documentNumber": "AB123456C",
      "gender": "male",
      "addresses": [
        {
          "id": "019505a1-e5f6-7a7b-c8d9-e0f1a2b3c4d5",
          "country": "GB",
          "postalCode": "SW1A 1AA",
          "city": "London",
          "state": "England",
          "address1": "10 Downing Street",
          "address2": null
        }
      ]
    }
  }
}

6. KYC.profile.rejected

Triggered when a KYC profile verification is rejected.
{
  "id": "evt_e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0",
  "type": "kyc.profile.rejected",
  "createdAt": "2026-03-11T14:00:00.123456789Z",
  "data": {
    "id": "019505a1-c3d4-7e5f-b6a7-b2c3d4e5f6a7",
    "reference": "applicant-abc123",
    "email": "user@example.com",
    "status": "rejected",
    "tenantId": "tenant-xyz",
    "details": {
      "fullName": "John Doe",
      "phoneNumber": "+441234567890",
      "dateOfBirth": "1990-01-15T00:00:00Z",
      "nationality": "GB",
      "countryOfResidence": "GB",
      "countryOfBirth": "GB",
      "documentNumber": "AB123456C",
      "gender": "male",
      "addresses": [
        {
          "id": "019505a1-e5f6-7a7b-c8d9-e0f1a2b3c4d5",
          "country": "GB",
          "postalCode": "SW1A 1AA",
          "city": "London",
          "state": "England",
          "address1": "10 Downing Street",
          "address2": null
        }
      ]
    }
  }
}

7. KYC.profile.requires_action

Triggered when a KYC profile requires additional action from the user.
{
  "id": "evt_f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0c1",
  "type": "kyc.profile.requires_action",
  "createdAt": "2026-03-11T14:00:00.123456789Z",
  "data": {
    "id": "019505a1-c3d4-7e5f-b6a7-b2c3d4e5f6a7",
    "reference": "applicant-abc123",
    "email": "user@example.com",
    "status": "requires_action",
    "tenantId": "tenant-xyz",
    "details": null
  }
}

8. KYC.profile.resubmission_requested

Triggered when KYC profile requires document resubmission.
{
  "id": "evt_a7b8c9d0e1f2a3b4c5d6e7f8a9b0c1d2",
  "type": "kyc.profile.resubmission_requested",
  "createdAt": "2026-03-11T14:00:00.123456789Z",
  "data": {
    "id": "019505a1-c3d4-7e5f-b6a7-b2c3d4e5f6a7",
    "reference": "applicant-abc123",
    "email": "user@example.com",
    "status": "resubmission_requested",
    "tenantId": "tenant-xyz",
    "details": null
  }
}

9. KYC.terms.approved

Triggered when all required terms are accepted.
{
  "id": "evt_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6",
  "type": "kyc.terms.approved",
  "createdAt": "2026-03-17T10:30:00.000000000Z",
  "data": {
    "profileId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
    "checkType": "terms",
    "status": "approved",
    "reference": "partner-user-ref-123"
  }
}

10. KYC.source_of_funds.approved

Triggered when source of funds questionnaire is submitted and approved.
{
  "id": "evt_b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7",
  "type": "kyc.source_of_funds.approved",
  "createdAt": "2026-03-17T10:35:00.000000000Z",
  "data": {
    "profileId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
    "checkType": "source_of_funds",
    "status": "approved",
    "reference": "partner-user-ref-123"
  }
}

Deposit Events

11. Deposit.pending

Triggered when an on-chain deposit is detected and awaiting KYT processing.
{
  "id": "evt_c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8",
  "type": "deposit.pending",
  "createdAt": "2026-03-17T11:00:00.000000000Z",
  "data": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "accountId": "d4e5f6a7-b8c9-0123-4567-890abcdef012",
    "status": "pending",
    "amount": "1000000",
    "currency": "USDCe",
    "decimals": 6,
    "transactionHash": "0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef",
    "chain": {
      "name": "gnosis",
      "id": "100"
    },
    "createdAt": "2026-03-17T10:59:30.000000000Z"
  }
}

12. Deposit.approved

Triggered when a deposit is confirmed after KYT and funds become available.
{
  "id": "evt_d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9",
  "type": "deposit.approved",
  "createdAt": "2026-03-17T11:00:00.000000000Z",
  "data": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "accountId": "d4e5f6a7-b8c9-0123-4567-890abcdef012",
    "status": "approved",
    "amount": "1000000",
    "currency": "USDCe",
    "decimals": 6,
    "transactionHash": "0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef",
    "chain": {
      "name": "gnosis",
      "id": "100"
    },
    "createdAt": "2026-03-17T10:59:30.000000000Z"
  }
}

13. Deposit.rejected

Triggered when a deposit is rejected by KYT.
{
  "id": "evt_e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0",
  "type": "deposit.rejected",
  "createdAt": "2026-03-17T11:00:00.000000000Z",
  "data": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "accountId": "d4e5f6a7-b8c9-0123-4567-890abcdef012",
    "status": "rejected",
    "amount": "1000000",
    "currency": "USDCe",
    "decimals": 6,
    "transactionHash": "0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef",
    "chain": {
      "name": "gnosis",
      "id": "100"
    },
    "createdAt": "2026-03-17T10:59:30.000000000Z"
  }
}

Withdrawal Events

14. Withdrawal.completed

Triggered when a withdrawal is successfully processed on-chain.
{
  "id": "evt_f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0c1",
  "type": "withdrawal.completed",
  "createdAt": "2026-03-17T12:15:00.000000000Z",
  "data": {
    "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
    "accountId": "d4e5f6a7-b8c9-0123-4567-890abcdef012",
    "status": "completed",
    "amount": "500000",
    "currency": "USDCe",
    "decimals": 6,
    "transactionHash": "0xabcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890",
    "chain": {
      "name": "gnosis",
      "id": "100"
    },
    "createdAt": "2026-03-17T12:10:00.000000000Z"
  }
}

15. Withdrawal.failed

Triggered when a withdrawal fails at any stage.
{
  "id": "evt_a7b8c9d0e1f2a3b4c5d6e7f8a9b0c1d2",
  "type": "withdrawal.failed",
  "createdAt": "2026-03-17T12:15:00.000000000Z",
  "data": {
    "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
    "accountId": "d4e5f6a7-b8c9-0123-4567-890abcdef012",
    "status": "failed",
    "amount": "500000",
    "currency": "USDCe",
    "decimals": 6,
    "transactionHash": "",
    "chain": {
      "name": "gnosis",
      "id": "100"
    },
    "createdAt": "2026-03-17T12:10:00.000000000Z"
  }
}

Card Events

16. Card.created

Triggered when a virtual card is provisioned or physical card reaches pending activation.
{
  "id": "evt_b8c9d0e1f2a3b4c5d6e7f8a9b0c1d2e3",
  "type": "card.created",
  "createdAt": "2026-03-17T14:00:00.000000000Z",
  "data": {
    "id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
    "accountId": "d4e5f6a7-b8c9-0123-4567-890abcdef012",
    "type": "virtual",
    "status": "created",
    "last4": "4321",
    "createdAt": "2026-03-17T14:00:00.000000000Z"
  }
}

17. Card.activated

Triggered when a physical card is activated.
{
  "id": "evt_c9d0e1f2a3b4c5d6e7f8a9b0c1d2e3f4",
  "type": "card.activated",
  "createdAt": "2026-03-17T15:00:00.000000000Z",
  "data": {
    "id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
    "accountId": "d4e5f6a7-b8c9-0123-4567-890abcdef012",
    "type": "plastic",
    "status": "activated",
    "last4": "4321",
    "createdAt": "2026-03-17T14:00:00.000000000Z"
  }
}

18. Card.blocked

Triggered when a card is temporarily blocked.
{
  "id": "evt_d0e1f2a3b4c5d6e7f8a9b0c1d2e3f4a5",
  "type": "card.blocked",
  "createdAt": "2026-03-17T15:30:00.000000000Z",
  "data": {
    "id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
    "accountId": "d4e5f6a7-b8c9-0123-4567-890abcdef012",
    "type": "virtual",
    "status": "blocked",
    "last4": "4321",
    "createdAt": "2026-03-17T14:00:00.000000000Z"
  }
}

19. Card.unblocked

Triggered when a card is unblocked and restored to active status.
{
  "id": "evt_e1f2a3b4c5d6e7f8a9b0c1d2e3f4a5b6",
  "type": "card.unblocked",
  "createdAt": "2026-03-17T16:00:00.000000000Z",
  "data": {
    "id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
    "accountId": "d4e5f6a7-b8c9-0123-4567-890abcdef012",
    "type": "virtual",
    "status": "unblocked",
    "last4": "4321",
    "createdAt": "2026-03-17T14:00:00.000000000Z"
  }
}

20. Card.canceled

Triggered when a card is permanently canceled.
{
  "id": "evt_f2a3b4c5d6e7f8a9b0c1d2e3f4a5b6c7",
  "type": "card.canceled",
  "createdAt": "2026-03-17T16:30:00.000000000Z",
  "data": {
    "id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
    "accountId": "d4e5f6a7-b8c9-0123-4567-890abcdef012",
    "type": "virtual",
    "status": "canceled",
    "last4": "4321",
    "createdAt": "2026-03-17T14:00:00.000000000Z"
  }
}

Card Transaction Events

The following table shows all card transaction event types and when they are triggered:
Event TypeWhen It FiresPismo Category
card.transaction.createdNew debit authorization (purchase, withdrawal, etc.)AUTHORIZATION (debit processing codes)
card.transaction.refundCredit voucher authorization (refund to cardholder)AUTHORIZATION (credit processing codes: 20, 203100, PSM007)
card.transaction.declinedAuthorization denied by PismoDECLINED
card.transaction.clearedTransaction settled/cleared (B2 confirmation)CONFIRMATION, AIRPORT_TAX, INSTALLMENT
card.transaction.reversedFull cancellation of an authorizationCANCELLATION
card.transaction.replacementAmount adjustment on a pending authorizationREPLACEMENT
card.transaction.incrementalAdditional authorization amount addedINCREMENTAL
card.transaction.partial_cancellationPartial reversal of an authorizationPARTIAL_CANCELLATION
card.transaction.cancellation_reversalUndo of a previous cancellationCANCELLATION_REVERSAL
card.transaction.reversal_partial_cancellationUndo of a previous partial cancellationREVERSAL_PARTIAL_CANCELLATION

21. Card.transaction.created

Triggered when a new debit authorization occurs (purchase, withdrawal, etc.).
{
  "id": "evt_8a3c1d4f2b6e9870c2a5b4d6e8f0a1c3",
  "type": "card.transaction.declined",
  "createdAt": "2026-04-24T11:17:44.082000000Z",
  "data": {
    "id": "f1c84a96-3d05-4b6b-9f1a-b2e7c5d8a012",
    "accountId": "12c4a7e2-7a91-4f4f-9e76-1c9e1c2a2b18",
    "cardId": "8a3b2c91-4d7e-49ab-bf25-ef019a4e6b20",
    "status": "declined",
    "amount": "20",
    "currency": "EUR",
    "decimals": 2,
    "originalAmount": "20",
    "originalCurrency": "USD",
    "originalDecimals": 2,
    "isCredit": false,
    "createdAt": "2026-04-24T11:17:43.000000000Z",
    "updatedAt": "2026-04-24T11:17:43.000000000Z",
    "description": "Kindle Svcs  888-802-3080 US",
    "authorizationId": 717,
    "authorizationCode": "XZ0COI",
    "merchant": {
      "name": "Kindle Svcs",
      "city": "888-802-3080",
      "country": "US",
      "categoryCode": "5818"
    },
    "entryMode": "0100",
    "country": null,
    "billing": {
      "billingAmount": "20",
      "billingCurrency": {
        "symbol": "€",
        "code": "EUR",
        "decimals": 2,
        "name": "Euro"
      }
    },
    "transactionCurrency": {
      "symbol": "$",
      "code": "USD",
      "decimals": 2,
      "name": "US Dollar"
    },
    "cardToken": "8a3b2c91-4d7e-49ab-bf25-ef019a4e6b20",
    "wallet": {
            "provider": "apple_pay",
            "device_brand": null,
            "device_model": null,
            "device_type": "MOBILE_PHONE",
            "device_name": "S29uc3RhbnRpbidzIGlQaG9uZQ.."
        },
    "clearedAt": null,
    "isPending": false,
    "kind": "payment",
    "transactionType": "0100",
    "transactions": [],
    "declineReason": {
      "code": null,
      "message": null
    }
  }
}