Salesforce Docs Portal

PaymentMandate

Represents information about the payment mandates given by a customer to their bank or financial institution to authorize a third party to collect payments from their account. This object is available in API version 61.0 and later.

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()

Special Access Rules

This is a standard object and is available only when you turn on the Financial Account Management Standard Objects setting.

Fields

ApplicantId

  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The applicant that's applying for the loan.

    This field is a relationship field.

  • Relationship Name: Applicant
  • Relationship Type: Lookup
  • Refers To: Applicant

ApplicationFormId

  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The application form that's associated with the mandate.

    This field is a relationship field.

  • Relationship Name: ApplicationForm
  • Relationship Type: Lookup
  • Refers To: ApplicationForm

ApplicationFormProductId

  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The product specified in the application form that's associated with the mandate.

    This field is a relationship field.

  • Relationship Name: ApplicationFormProduct
  • Relationship Type: Lookup
  • Refers To: ApplicationFormProduct

AuthorizationType

  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Specifies the type of authorization associated with the mandate. For example, whether the authorization is for the payment or disbursement requested in the mandate.
  • Possible values:
    • Disbursement
    • Payment

BankAccountNumber

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The account number of the bank that's used for the payment or disbursement.

BankAccountType

  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Specifies the type of bank account.
  • Possible values:
    • Checking
    • Savings

BankBranchAddress

  • Type: address
  • Properties: Filter, Nillable
  • Description: The address of the bank's branch that's selected for repayment.

BankBranchCity

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The city of the bank branch address.

BankBranchCountry

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The country of the bank branch address.

BankBranchGeocodeAccuracy

  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Description: Specifies the level of accuracy of the bank branch address's geographical coordinates compared with its physical address.
  • Possible values:
    • Address
    • Block
    • City
    • County
    • ExtendedZip
    • NearAddress
    • Neighborhood
    • State
    • Street
    • Unknown
    • Zip

BankBranchLatitude

  • Type: double
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The latitude of the bank branch address.

BankBranchLongitude

  • Type: double
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The longitude of the bank branch address.

BankBranchName

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The name of the bank's branch that's selected for repayment.

BankBranchPostalCode

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The postal code of the bank branch address.

BankBranchState

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The state of the bank branch address.

BankBranchStreet

  • Type: textarea
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The street of the bank branch address.

BankName

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The name of the bank that's selected for repayment.

BankRoutingNumber

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The sort code or routing number of the bank that's used for payment or disbursement.

CurrencyIsoCode

  • Type: picklist
  • Properties: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Description: If multiple currencies are enabled, contains the currency ISO code associated with the record.

    Valid value is USD.

  • Default value: USD

DisbursementAddress

  • Type: address
  • Properties: Filter, Nillable
  • Description: The address where the disbursement check is sent.

DisbursementCity

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The city related to the disbursement address.

DisbursementCountry

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The country related to the disbursement address.

DisbursementGeocodeAccuracy

  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Description: Specifies the level of accuracy of the disbursement address's geographical coordinates compared with its physical address.
  • Possible values:
    • Address
    • Block
    • City
    • County
    • ExtendedZip
    • NearAddress
    • Neighborhood
    • State
    • Street
    • Unknown
    • Zip

DisbursementLatitude

  • Type: double
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The latitude related to the disbursement address.

DisbursementLongitude

  • Type: double
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The longitude related to the disbursement address.

DisbursementPostalCode

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The postal code related to the disbursement address.

DisbursementState

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The state related to the disbursement address.

DisbursementStreet

  • Type: textarea
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The street related to the disbursement address.

FinancialAccountId

  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The financial account that's associated with the payment or disbursement mandate.

    This field is a relationship field.

  • Relationship Name: FinancialAccount
  • Relationship Type: Lookup
  • Refers To: FinancialAccount

IsAccountValidated

  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Indicates whether the account is validated (true) or not (false).
  • Default value: false

IsActive

  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Indicates whether the mandate is active (true) or not (false).
  • Default value: false

LastReferencedDate

  • Type: dateTime
  • Properties: Filter, Nillable, Sort
  • Description: The timestamp for when the current user last viewed a record related to this record.

LastViewedDate

  • Type: dateTime
  • Properties: Filter, Nillable, Sort
  • Description: The timestamp for when the current user last viewed this record.

MandateAmount

  • Type: currency
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The amount of the payment or disbursement requested in the mandate.

MandateEffectiveDate

  • Type: date
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The start date of the mandate.

MandateEndDate

  • Type: date
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The end date of the mandate.

MandateExternalIdentifier

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The external registration identifier of the mandate.

MandateFrequency

  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Specifies the payment frequency for the mandate.
  • Possible values:
    • Half Yearly
    • Monthly
    • Quarterly
    • When Presented
    • Yearly

MandateInternalIdentifier

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The unique ID of the mandate.

MandateStatus

  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Specifies the status of the mandate.
  • Possible values:
    • Cancelled
    • Created
    • Failed
    • Registered to Destination Bank
    • Rejected by Destination Bank
    • Submitted to Bank

MandateSubmissionDate

  • Type: date
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The date when the mandate was submitted.

MandateType

  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Specifies the type of mandate.
  • Possible values:
    • Electronic
    • Offline

Name

  • Type: string
  • Properties: Autonumber, Defaulted on create, Filter, idLookup, Sort
  • Description: An auto-generated string assigned to the payment mandate record.

OwnerId

  • Type: reference
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: The owner of the payment mandate record.

    This field is a polymorphic relationship field.

  • Relationship Name: Owner
  • Relationship Type: Lookup
  • Refers To: Group, User

PersonAccountId

  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The person account that's associated with the mandate.

    This field is a relationship field.

  • Relationship Name: PersonAccount
  • Relationship Type: Lookup
  • Refers To: Account

Ratio

  • Type: percent
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The disbursement or payment percentage across bank accounts.

Associated Objects

This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.

PaymentMandateChangeEvent
Change events are available for the object.
PaymentMandateFeed
Feed tracking is available for the object.
PaymentMandateHistory
History is available for tracked fields of the object.
PaymentMandateOwnerSharingRule
Sharing rules are available for the object.
PaymentMandateShare
Sharing is available for the object.