API Reference
API ReferenceChangelogFAQDashboard

Payment Method object

Payment Method is a standalone object in our system and user interface that stores information about an applicant’s payment methods.

Each payment method is linked to a specific applicant profile. It can be added to support further verification, ownership confirmation, and financial-related investigations.

You can add a new payment method using the Add payment method endpoint.

📘

Note

Additionally, the payment method is created either by submitting a transaction for risk scoring or is generated automatically through applicant actions.

Supported payment methods

The Payment Method object supports these types of payment methods:

  • Crypto-wallets. Digital wallets that allow applicants to store and use cryptocurrencies such as Ethereum or Bitcoin.
  • Bank cards. Traditional card-based payment instruments including credit, debit, and prepaid cards.
  • Bank accounts. Accounts held with financial institutions, identified using IBAN, SWIFT, SOFORT, iDEAL, or other regional payment systems.
  • E-wallets. Digital wallets that hold applicants' financial data for performing transactions without physical cards.
  • Other. Alternative payment methods that are not covered above.

Payment Method properties

Here are the properties of the Payment Method object.

FieldTypeDescription
idStringIdentifier of the payment method in the Sumsub system.
externalIdStringIdentifier of the payment method on your side.
createdAtDateDate and time when the payment method was submitted to the Sumsub system. Format YYYY-MM-DD HH-MM-SS, e.g., 2025-07-17 10:37:54.
reviewObjectIncludes the status and other details of the payment method.
dataObjectPayment method data.
institutionInfoObjectIncludes details about the financial institution used by a participant to execute the transaction.

review attributes

FieldTypeDescription
reviewStatusStringIndicates the payment method review status. Possible statuses:
  • init — initiated.
  • pending — pending to be processed.
  • queued — in progress.
  • awaitingUser — user action is required.
  • onHold — assistance from a compliance expert is required.
  • prechecked — initial quick check is done.
  • completed — the check is completed, and the review answer is given whether the payment method is approved or rejected.
createDateDateDate and time (UTC) when the check was launched.

data attributes

FieldTypeDescription
typeStringType of the payment method. Can be one of the following: bankCard, bankAccount, eWallet, cryptoWallet, other.
subTypeStringSubtype of the payment method (could be a domain specific type or a name, e.g., PayPal).
accountIdentifierStringUnique identifier of the account associated with this payment pethod.
fullNameStringFull name of the account holder. Applicable to the bankAccount type.
validUntillDateDate field for the bankCard type indicating the date when the bank card is expired (format yyyy-MM-dd).
currencyCodeStringCode of the currency the wallet holds (USD, GBP, BTC, etc.). Applicable to the cryptoWallet type.
cryptoChainStringCrypto chain name. Specifies the network name to which the token at currencyCode belongs. Empty for native tokens (e.g. for BTC, ETH). For more information, see chain codes. Applicable to the cryptoWallet type.
memoStringOptional field for the cryptoWallet type in blockchain transactions to attach metadata or messages for identification, routing, or compliance purposes.

institutionInfo attributes

FieldTypeDescription
codeStringInstitution code (e.g. BIC).
nameStringInstitution name (e.g., Wells Fargo).
addressObjectInstitution address.
issuerObjectDescribes who issued the payment method within the scope of the current license key. It can be either you or one of your applicants.

issuer attributes

FieldTypeDescription
typeString

Specifies the issuer of the payment method:

  • license — you as a license key owner.
  • applicant — the applicant (individual or company) under the current license.
applicantIdStringIdentifier of the applicant (in the Sumsub system) who issued the payment method. Applicable when issuer.type is set to applicant. Can refer to either a KYB (company) or KYC (individual) applicant.