Get Money Movement Fraud

post

https://risk-{corename}.{env}.gpsrv.com/prp/1.0/getMoneyMovementFraud

Use the Get Money Movement Fraud endpoint to evaluate the risk associated with specific money-movement transactions and account linking to understand if a customer transaction is fraudulent, then take appropriate action based on predefined criteria. This endpoint provides detailed fraud detection insights, including rules triggered, actions taken, and supplementary fraud prevention decisions.

Form Data

riskServiceId

string

required

Identifier created by the Risk Squad. A fixed value for each client
Pattern: EPRP prefix followed by colon-separated identifiers
Example: EPRP:505:401:8385

apiLogin

string

required

Web service username, as provided by SoFi Tech Solutions.
Pattern: Max 50 characters
Example: "AbC123-9999"

apiTransKey

string

required

Web service password, as provided by SoFi Tech Solutions.
Pattern: Max 15 characters
Example: "4sb62fh6w4h7w34g"

providerId

string

required

Your unique provider identifier from SoFi Tech Solutions.
Pattern: Max 10-digit numeric string
Example: "9999"

transactionId

string

required

Supply a globally unique ID to identify this endpoint request ("transaction"). A UUID is preferred.
Pattern: Max 60 characters
Example: "9845dk-39fdk3fj3-4483483478"

eventType

string

enum

required

Event type.
Pattern: acct_vrfy, ach, wire, rtp, fednow, aft, or oct
Example: acct_vrfy

Allowed:

eventSubtype

string

enum

Event subtype.
Pattern: finicity, incoming_debit, incoming_credit, outgoing_debit, or outgoing_credit
Example: finicity

Allowed:

eventId

string

Map trans_id to event_id
Pattern: One or more digits
Example: 2356109249

eventTs

date-time

required

Map trans_ts to event_ts
Pattern: YYYY-MM-DD HH:MM:SS
Example: 2025-05-26 01:00:00

partnerId

string

required

A unique partner identifier from SoFi Tech Solutions.
Pattern: One or more digits
Example: 505

progId

string

required

A unique program identifier from SoFi Tech Solutions.
Pattern: One or more digits
Example: 9009

prodId

string

required

A unique product identifier from SoFi Tech Solutions.
Pattern: One or more digits
Example: 1234

pmtRefNo

string

required

Payment reference number
Pattern: 12 digits
Example: 999101012345

xid

string

Transaction XID
Pattern: One or more digits
Example: 1234

balId

string

required

Balance ID or galileo_account_number
Pattern: One or more digits
Example: 4321

appDate

date-time

Timestamp for when this application was submitted
Pattern: YYYY-MM-DD HH:MM:SS
Example: 2025-04-18 00:00:00

instantVerify

boolean

required

Whether to run GIVE.
Pattern: true or false
Example: TRUE

counterpartyPanCardNo

string

Counterparty PAN for AFT or OCT use cases
Pattern: 16 digits
Example: 1234567890123456

counterpartyAcctNo

string

Counterparty account number
Pattern: 5–17 digits
Example: 841523654

counterpartyAcctType

string

Counterparty account type
Pattern: personal, business, or other
Example: personal

counterpartyAcctSubtype

string

Counterparty account subtype
Pattern: checking or savings
Example: checking

counterpartyRtNo

string

Counterparty bank routing number
Pattern: 9 digits
Example: 021000021

counterpartyBalAmount

number

Latest available balance of the counterparty account
Pattern: Integer or decimal number
Example: 250.15

counterpartyBalanceTs

date-time

Timestamp for when counterpartyBalAmount was captured
Pattern: YYYY-MM-DD HH:MM:SS
Example: 2025-04-18 7:39:30

counterpartyIdDocType

string

Counterparty account holder ID type: ssn, itin or ein
Pattern: ssn, itin, or ein
Example: ssn

counterpartyIdDocNo

string

Counterparty account holder SSN or tax ID
Pattern: 9 digits
Example: 123456789

counterpartyFirstName

string

Counterparty account holder first name
Pattern: Letter followed by letters, spaces, apostrophes, periods, or hyphens
Example: John

counterpartyMiddleName

string

Counterparty account holder middle name
Pattern: Letter followed by letters, spaces, apostrophes, periods, or hyphens
Example: James

counterpartyLastName

string

Counterparty account holder last name
Pattern: Letter followed by letters, spaces, apostrophes, periods, or hyphens
Example: Doe

counterpartyBusinessName

string

Counterparty bank business name when counterpartyAcctType: business.
Pattern: Non-empty text
Example: John Inc

counterpartyDob

string

Counterparty account holder date of birth
Pattern: One or more digits
Example: 29221

counterpartyAddr1

string

Counterparty account holder address line 1
Pattern: 1–60 characters
Example: 1417 N Rue St.

counterpartyAddr2

string

Counterparty account holder address line 2
Pattern: 1–60 characters
Example: APT 5520

counterpartyCity

string

City of the counterparty account holder
Pattern: Non-empty text
Example: Saint Charles

counterpartyState

string

State of the counterparty account holder
Pattern: 2 uppercase letters
Example: MO

counterpartyZip

string

ZIP or postal code of the counterparty account holder
Pattern: 5–20 characters
Example: 63301

counterpartyCtryCd

string

Two-letter country code of the counterparty account holder
Pattern: 2 uppercase letters (ISO 3166-1)
Example: US

counterpartyBillingAddr1

string

Counterparty account holder billing address line 1
Pattern: 1–60 characters
Example: 1417 n. rue st.

counterpartyBillingAddr2

string

Counterparty account holder billing address line 2
Pattern: 1–60 characters
Example: APT 5520

counterpartyBillingCity

string

Billing city of the counterparty account holder
Pattern: Non-empty text
Example: saint charles

counterpartyBillingState

string

Billing state of the counterparty account holder
Pattern: 2 uppercase letters
Example: MO

counterpartyBillingZip

string

Billing ZIP or postal code of the counterparty account holder
Pattern: 5–20 characters
Example: 63301

counterpartyBillingCtryCd

string

Two-letter billing country code of the counterparty account holder
Pattern: 2 uppercase letters (ISO 3166-1)
Example: US

counterpartyMobilePhoneNo

string

Counterparty account holder mobile phone number
Pattern: E.164 US format: +1 followed by 10 digits
Example: +11234567890

counterpartyHomePhoneNo

string

Counterparty account holder home phone number
Pattern: E.164 US format: +1 followed by 10 digits
Example: +11234567890

counterpartyEmailAddr

string

Counterparty account holder email address
Pattern: Email address
Example: [email protected]

counterpartyIpAddr

string

Counterparty account holder IP address
Pattern: IPv4 address (four dot-separated number groups)
Example: 172.16.10.20

counterpartyNameMatchScore

number

Counterparty name match score from Finicity
Pattern: 0–1 decimal
Example: 0.9

counterpartyPhoneMatchInd

boolean

Counterparty phone number match indicator from Finicity
Pattern: true or false
Example: False

counterpartyZipMatchInd

boolean

Counterparty ZIP code match indicator from Finicity
Pattern: true or false
Example: True

counterpartyEmailMatchInd

boolean

Counterparty email address match indicator from Finicity
Pattern: true or false
Example: True

customerPanCardNo

string

Customer PAN for AFT or OCT use cases
Pattern: 16 digits
Example: 1234567890123456

customerAcctNo

string

Customer account number (PRN)
Pattern: 5–17 digits
Example: 999101523654

customerAcctType

string

Customer account type
Pattern: personal, business, or other
Example: personal

customerAcctSubtype

string

Customer account subtype
Pattern: checking or savings
Example: checking

customerRtNo

string

Customer bank routing number
Pattern: 9 digits
Example: 210000221

customerBalAmount

number

Latest available balance of the customer account
Pattern: Integer or decimal number
Example: 250.15

customerBalanceTs

date-time

Timestamp for when customerBalAmount was captured.
Pattern: YYYY-MM-DD HH:MM:SS
Example: 2025-04-18 7:39:30

customerIdDocType

string

Customer account holder ID type
Pattern: ssn, itin, or ein
Example: ssn

customerIdDocNo

string

Customer account holder SSN or tax ID
Pattern: 9 digits
Example: 123456789

customerFirstName

string

Customer account holder first name
Pattern: Letter followed by letters, spaces, apostrophes, periods, or hyphens
Example: John

customerMiddleName

string

Customer account holder middle name
Pattern: Letter followed by letters, spaces, apostrophes, periods, or hyphens
Example: Arnold

customerLastName

string

Customer account holder last name
Pattern: Letter followed by letters, spaces, apostrophes, periods, or hyphens
Example: Doe

customerBusinessName

string

Customer bank business name when customerAcctType: business
Pattern: Non-empty text
Example: John Inc

customerDob

string

Customer account holder date of birth
Pattern: One or more digits
Example: 29221

customerAddr1

string

Customer account holder address line 1
Pattern: 1–60 characters
Example: 1417 N Rue St.

customerAddr2

string

Customer account holder address line 2
Pattern: 1–60 characters
Example: APT 5520

customerCity

string

City of the customer account holder
Pattern: Non-empty text
Example: Saint Charles

customerState

string

State of the customer account holder
Pattern: 2 uppercase letters
Example: MO

customerZip

string

ZIP or postal code of the customer account holder
Pattern: 5–20 characters
Example: 63301

customerCtryCd

string

Two-letter country code of the customer account holder
Pattern: 2 uppercase letters (ISO 3166-1)
Example: US

customerBillingAddr1

string

Customer billing address line 1 (AFT/OCT use cases)
Pattern: 1–60 characters
Example: 1417 n. rue st.

customerBillingAddr2

string

Customer billing address line 2 (AFT/OCT use cases)
Pattern: 1–60 characters
Example: APT 5520

customerBillingCity

string

Customer billing city (AFT/OCT use cases)
Pattern: Non-empty text
Example: saint charles

customerBillingState

string

Customer billing state (AFT/OCT use cases)
Pattern: 2 uppercase letters
Example: MO

customerBillingZip

string

Customer billing ZIP (AFT/OCT use cases)
Pattern: 5–20 characters
Example: 63301

customerBillingCtryCd

string

Two-letter billing country code of the customer (AFT/OCT use cases)
Pattern: 2 uppercase letters (ISO 3166-1)
Example: US

customerMobilePhoneNo

string

Customer account holder mobile phone number
Pattern: E.164 US format: +1 followed by 10 digits
Example: +11234567890

customerHomePhoneNo

string

Customer account holder home phone number
Pattern: E.164 US format: +1 followed by 10 digits
Example: +11234567890

customerEmailAddr

string

Customer account holder email address
Pattern: Email address
Example: [email protected]

customerIpAddr

string

Customer IP address
Pattern: IPv4 address (four dot-separated number groups)
Example: 192.168.10.20

sequenceNumber

integer

Sequence number
Pattern: Integer, optional leading minus sign
Example: 20250500000000000000000000000000000

requestTs

date-time

Map in_ts to request_ts
Pattern: YYYY-MM-DD HH:MM:SS
Example: 2025-05-27 13:46:37

procTs

date-time

Processing timestamp
Pattern: YYYY-MM-DD HH:MM:SS
Example: 2025-05-27 13:46:45

effectiveDt

date-time

Effective date
Pattern: YYYY-MM-DD HH:MM:SS
Example: 2025-05-28 00:00:00

origRec

string

Original record
Pattern: Non-empty text
Example: ST

batchHdr

string

Batch header
Pattern: Non-empty text
Example: 5200Wyndham 134233889 WEBP2P 250528250528 1096001010000003

transAmt

number

Transaction amount (map amt to trans_amt)
Pattern: Integer or decimal number
Example: 300.14

currCd

string

3-letter currency code
Pattern: 3 uppercase letters (ISO 4217)
Example: USD

transCode

string

Transaction code
Pattern: One or more digits
Example: 37

transType

string

Transaction type
Pattern: Non-empty text
Example: AC

status

string

Status
Pattern: Non-empty text
Example: P

statusDesc

string

Status description
Pattern: Non-empty text
Example: Processed

feeFlag

string

Fee flag
Pattern: Any text, including empty
Example: true

feeAmt

number

Fee amount
Pattern: Integer or decimal number
Example: 1.50

loadType

string

Load type
Pattern: Non-empty text
Example: M

origTrace

string

Original trace
Pattern: One or more digits
Example: 96001015089930

retCodeDishon

string

Return code dishonor
Pattern: Any text, including empty

chgCode

string

Change code
Pattern: Any text, including empty

chgTs

date-time

Change timestamp
Pattern: YYYY-MM-DD HH:MM:SS, or empty

destId

string

Destination ID
Pattern: One or more digits
Example: 531

destInstName

string

Destination institution name
Pattern: Non-empty text
Example: Sunrise_Bank_Wyndham_AC

destInstId

string

Destination institution ID
Pattern: 9 digits
Example: 271081528

destAcctType

string

Destination account type
Pattern: Non-empty text
Example: S

destFilename

string

Destination filename
Pattern: Non-empty text
Example: ACHs250527A531

sourceId

string

Source ID
Pattern: One or more digits
Example: 531

sourceInstName

string

Source institution name
Pattern: Non-empty text
Example: galileo:wyndham

sourceInstCat

string

Source institution category
Pattern: Non-empty text
Example: OTH

sourceInstId

string

Source institution ID
Pattern: One or more digits
Example: 96001013

sourceTrace

string

Source trace
Pattern: One or more digits
Example: 21000025074388

sourceFilename

string

Source filename
Pattern: Non-empty text
Example: wyndham

destRetFilename

string

Destination return filename
Pattern: Any text, including empty

destRetTs

date-time

Destination return timestamp
Pattern: YYYY-MM-DD HH:MM:SS
Example: 2025-03-07 10:20:28

destRetTrace

string

Destination return trace
Pattern: Any text, including empty

returnCode

string

Return code (required for certain eventSubtypes)
Pattern: R followed by 2 digits
Example: R01

returnTs

date-time

Return timestamp (required for certain eventSubtypes)
Pattern: YYYY-MM-DD HH:MM:SS
Example: 2025-05-29 07:24:36

sourceRetFilename

string

Source return filename
Pattern: Non-empty text
Example: ACH.366.250411.A

sourceRetTs

date-time

Source return timestamp
Pattern: YYYY-MM-DD HH:MM:SS
Example: 2025-04-11 11:45:50

sourceRetTrace

string

Source return trace
Pattern: One or more digits
Example: 103113352137688

origRetTrace

string

Original return trace
Pattern: One or more digits
Example: 125109013780198

retStlDate

date-time

Return settlement date
Pattern: YYYY-MM-DD HH:MM:SS
Example: 2025-01-17 00:00:00

origRetCode

string

Original return code
Pattern: One or more digits
Example: 01

addNo

string

Additional number
Pattern: One or more digits
Example: 0

disbType

string

Disbursement type
Pattern: One or more digits
Example: 0

retryCount

integer

Retry count
Pattern: Integer, optional leading minus sign
Example: -1

retryTs

date-time

Retry timestamp
Pattern: YYYY-MM-DD HH:MM:SS
Example: 2025-02-19 00:22:13

batchCat

string

Batch category
Pattern: One or more digits
Example: 9009

revId

string

Revision ID
Pattern: Any text, including empty

sameDay

string

Same-day indicator
Pattern: Y or N
Example: N

origName

string

Original name
Pattern: Non-empty text
Example: HEALTH CARE SERV

govOrig

string

Government origin indicator
Pattern: Y or N
Example: Y

reviewFlag

string

Review flag
Pattern: Y or N
Example: Y

reviewReason

string

Review reason
Pattern: Non-empty text
Example: potential R17 return

blocksIdUsed

string

Blocks ID used
Pattern: One or more digits
Example: 0

identNumber

string

Identification number
Pattern: One or more digits
Example: 692101336968

lastEnqueuedTs

date-time

Last-enqueued timestamp
Pattern: YYYY-MM-DD HH:MM:SS
Example: 2025-06-02 03:28:33

rowInsertOrigin

string

Row insert origin
Pattern: Non-empty text
Example: aue1

rowUpdateOrigin

string

Row update origin
Pattern: Non-empty text
Example: aue1

dscr

string

Description
Pattern: Non-empty text
Example: Bill Payment - Check

secCode

string

SEC code
Pattern: 3 uppercase letters
Example: WEB

companyName

string

Company name
Pattern: Non-empty text
Example: Nuttige LLC

ofacStatus

string

OFAC status
Pattern: Any text, including empty

Response

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

default