Salesforce Integration


You can integrate XTRM payments into your salesforce enviroment. 


Use our payments object specification (below) in salesforce to create payment records that are then automatically processed by XTRM. Whether the payments are to companies or individuals, in any currency, anywhere in the world. 


There are 2 methods for this:


1) Use our XTRM Connector to grab the payment data from your SFDC payments object (App) on a scheduled basis.


2) Grab the realtime payments data from your SFDC payments object (App) into your own server which pass the payments data to XTRM using our API


For more information on how to set this up, please contact us on 1.866.367.9289, email sales@xtrm.com or click HERE to send us your info and we will contact you.


The XTRM SFDC Payment Record Object.

This is a proposed data object to enable XTRM to make automated payments from Salesforce. The company will create payment records (this object), and at intervals, XTRM will fetch and process those records via the Salesforce API. 

Most fields are optional; the various MANDATORY fields are described in further detail below by payment type.

Expected Usage of this Object

A company can create XTRM payment records within their Salesforce instance, and supply XTRM with the credential it needs to use the regular Salesforce API to read new (unprocessed) records at a set time interval. XTRM can then update the payment record transaction IDs, processed time, action result (success/error) codes, and longer comments) in the data fields reserved for XTRM’s usage.


This object uses semantic versioning. XTRM expects to prese

Always Mandatory Fields:

  • paymentAmount

  • paymentType

  • paymentMethod

  • currencyCode

  • benEmail

Mandatory For Personal or Employer Payments:

  • benLegalFirstname

  • benLegalLastname

  • benEmail

For Direct-To-Check:

  • benAddress1

  • benCity

  • benRegion

  • benPostalCode

  • benCountry


Fields & Salesforce Field Types


Field

SFObjectName

SF Data Type

Brief Explanation of Field

batchDescription

batchDescription__c

Text(255)

Description of this particular batch

benAddress1

benAddress1__c

Text(255)

Beneficiary Address Line 1

benAddress2

benAddress2__c

Text(255)

Beneficiary Address Line 2

benAptSuite

benAptSuite__c

Text(255)

Beneficiary Apartment or Suite Designator

benCity

benCity__c

Text(255)

Beneficiary City

benCompany

benCompany__c

Text(255)

Beneficiary Company

benCountry

benCountry__c

Text(255)

Beneficiary Country

benEmail

benEmail__c

Email

Beneficiary Email

benEmployer

benEmployer__c

Text(255)

Beneficiary Employer

benID

benID__c

Text(255)

Beneficiary ID (payor’s ID, not used by XTRM)

benLegalFirstname

benLegalFirstname__c

Text(255)

Beneficiary legal first name

benLegalLastname

benLegalLastname__c

Text(255)

Beneficiary legal last name

benPostalCode

benPostalCode__c

Text(255)

Beneficiary postal code

benRegion

benRegion__c

Text(255)

Beneficiary State, Province, or Region

benWalletID

benWalletID__c

Text(255)

Beneficiary’s XTRM wallet ID to pay (optional)

Created By

CreatedById

Lookup(User)

Salesforce object metadata

createdTime

createdTime__c

Date/Time

Timestamp for object creation

currencyCode

currencyCode__c

Text(255)

Currency to pay in

fundingWalletName

fundingWalletName__c

Text(255)

Sender’s XTRM Wallet ID (optional)

Last Modified By

LastModifiedById

Lookup(User)

Salesforce object metadata

Owner

OwnerId

Lookup(User,Group)

Salesforce object metadata

paymentAmount

paymentAmount__c

Number(14, 4)

Amount to pay to beneficiary

paymentMethod

paymentMethod__c

Text(255)

Specific payment method

paymentTransactionID

paymentTransactionID__c

Auto Number

Payor’s ID for this transaction

paymentType

paymentType__c

Text(255)


programName

programName__c

Text(255)

Payor program name

recievedTime

recievedTime__c

Date/Time

Timestamp when processed by XTRM (XTRM use only)

recieveTransactionId

recieveTransactionId__c

Text(255)

XTRM transaction id for received funds (XTRM use only)

sendTransactionID

sendTransactionID__c

Text(255)

XTRM transaction id for sent funds (XTRM use only)

transactionComment

transactionComment__c

Long Text Area(131072)

Payor’s use

XTRM Payment

Name

Text(80)

Reserved

XTRMAction

XTRMAction__c

Text(255)

XTRM action code (paid, rejected, error…) (XTRM use only)

XTRMComment

XTRMComment__c

Long Text Area(131072)

Comment on transaction (XTRM use only)

XTRMPaymentRecord_0.1.0

XTRMPaymentRecord_010__c

Number(18, 0)

XTRM Payment Data Object Version (0.1.0)


Other Data Possibilities

Data Object Fields Information

batchDescription

batchDescription__c        Text(255)        OPTIONAL

A string identifying the batch payment. This is a vendor-controlled field, and is not used by XTRM.

benAddress1

benAddress1__c         Text(255)        MANDATORY FOR CHECKS

Beneficiary address line 1. This field is mandatory if payment is being made by check, optional otherwise.

benAddress2

benAddress2__c            Text(255)        OPTIONAL

Beneficiary address line 2, for more complex beneficiary addresses.

benAptSuite

benAptSuite__c            Text(255)        OPTIONAL

Beneficiary apartment or suite designation, as suite 101 or Apartment #33-A, for more complex beneficiary addresses.

benCity

benCity__c            Text(255)        MANDATORY FOR CHECKS

Beneficiary city. This field is mandatory if payment is being made by check, optional otherwise.

benCompany

benCompany__c            Text(255)        OPTIONAL

Beneficiary company name.

benCountry

benCountry__c            Text(255)        MANDATORY FOR CHECKS

Beneficiary country. This field is mandatory if payment is being made by check, optional otherwise.

benEmail

benEmail__c            Email        MANDATORY

Beneficiary email. This may be an individual or a company finance administrator. As this is a primary way XTRM contacts beneficiaries to inform them of payments, this field is always mandatory.

benEmployer

benEmployer__c            Text(255)        OPTIONAL

The beneficiary’s employer.

benID

benID__c                Text(255)        OPTIONAL

Beneficiary ID used by the payor to identify the beneficiary; this field is never used by XTRM and is for the remittor’s use.

benLegalFirstname

benLegalFirstname__c    Text(255)        MANDATORY FOR CHECKS, COMPANY, AND EMPLOYER PAYMENTS

Beneficiary’s legal first name. 

benLegalLastname

benLegalLastname__c        Text(255)        MANDATORY FOR CHECKS, COMPANY, AND EMPLOYER PAYMENTS

Beneficiary’s legal last name.

benPostalCode

benPostalCode__c        Text(255)        MANDATORY FOR CHECKS, COMPANY, AND EMPLOYER PAYMENTS

Beneficiary’s legal last name.

benRegion

benRegion__c            Text(255)        MANDATORY FOR CHECKS, COMPANY, AND EMPLOYER PAYMENTS

Beneficiary’s state or region.

benWalletID

benWalletID__c            Text(255)        OPTIONAL

The unique ID of the beneficiary’s XTRM wallet in which to deposit funds. If not specified, the payment will go to an existing wallet of the beneficiary which holds that currency (each wallet holds a single currency). If the beneficiary does not currently have a wallet for that currency, a wallet will be created for the beneficiary. This field is used to specify a particular wallet when the beneficiary has multiple wallets for currency. This field is always optional.

Created By

CreatedById            Lookup(User)    MANDATORY, SALESFORCE-PROVIDED METADATA

Salesforce object metadata

createdTime

createdTime__c            Date/Time        MANDATORY

Timestamp for object creation. This, with the paymentTransactionID field, makes each record unique.

currencyCode

currencyCode__c        Text(255)        MANDATORY

Three-letter currency code for the payment. This field may become a picklist (enum).

fundingWalletName

fundingWalletName__c    Text(255)        OPTIONAL

Sender’s XTRM Wallet ID from which to pull funds. If blank, a wallet with the appropriate currency is used.

Last Modified By

LastModifiedById        Lookup(User)    MANDATORY, SALESFORCE-PROVIDED METADATA

Salesforce object metadata

Owner

OwnerId                Lookup(User,Group)    MANDATORY, SALESFORCE-PROVIDED METADATA

Salesforce object metadata

paymentAmount

paymentAmount__c        Number(14, 4)    MANDATORY

Amount to pay to the beneficiary, in the currency specified.

paymentMethod

paymentMethod__c        Text(255)        MANDATORY

Payment could be choice, gift card, debit card, virtual visa, etc.  This field may become a picklist (enum).

paymentTransactionID

paymentTransactionID__c    Auto Number    MANDATORY, SALESFORCE-GENERATED

This is a unique record number for this payment record.

paymentType

paymentType__c        Text(255)            MANDATORY

Payment type: company, personal, or employer. Field may become a pick list (enum).

programName

programName__c        Text(255)            OPTIONAL

Payor program name

recievedTime

recievedTime__c    Date/Time            FOR USE BY XTRM ONLY (MANDATORY)

Timestamp when processed by XTRM. XTRM will update the record once processed. Please note that a processed record may or may not have been paid; please check the XTRMAction field for success or failure.

recieveTransactionId

recieveTransactionId__c    Text(255)        FOR USE BY XTRM ONLY (OPTIONAL)

An XTRM payment involves two transactions: one for the remittor, and one for the beneficiary. On a successful payment, the unique transaction ID for the beneficiary’s wallet is recorded here.

sendTransactionID

sendTransactionID__c    Text(255)        FOR USE BY XTRM ONLY (OPTIONAL)

An XTRM payment involves two transactions: one for the remittor, and one for the beneficiary. On a successful payment, the unique transaction ID for the remittor’s wallet is recorded here.

transactionComment

transactionComment__c    Long Text Area(131072)    OPTIONAL

This field

XTRM Payment

Name                    Text(80)        SALEFORCE RESERVED READ-ONLY

This field is used by Salesforce to hold the name of this record type. 

XTRMAction

XTRMAction__c            Text(255)        FOR USE BY XTRM ONLY (MANDATORY)    

XTRM will place a value here corresponding to the result. This field might become a number, rather than text.

XTRMComment

XTRMComment__c            Long Text Area(131072)    FOR USE BY XTRM ONLY (OPTIONAL)

If XTRM has data or error information accompanying an unsuccessful transaction, XTRM may put that information here, as applicable.

XTRMPaymentRecordVersion    

XTRMPaymentRecordVersion__c        Text(255)        MANDATORY

This field identifies the semantic version number of the record. The current version is 0.1.0, and as of the current writing, the only valid value for this field is “0.1.0”.