/claim/intake/retrieveTransactions

post

https://{corename}.gft-dispute-api.{env}.gpsrv.com/gft-dispute-api/1.0/claim/intake/retrieveTransactions

Use this endpoint to retrieve transactions that can be selected to add to the claim. Using the customer ID, account number, and submitted claim reasons to retrieve valid transactions.

A default date range is built into the dispute system, so most inputs are optional.

This API can be called multiple times if ad-hoc searching
is being performed.

Prerequisite API call:

/claim/intake/addClaimReasons

Body Params

providerId

int32

required

Your unique provider identifier from SoFi Tech Solutions.
Pattern: Max 10 digits
Example: 9999

transactionId

string

required

length between 1 and 60

Supply a globally unique ID to identify this endpoint request ("transaction").
Pattern: Max 60 characters
Example: "984513-395483653-4483483478"

ClaimId

string

required

Unique claim ID

SearchAccountNumber

number

Account number for searching for transactions that are on a different account than the claim.

Required only if the user needs to add transactions to the claim that are on a different account than the claim's disputed transactions.

SearchStartDate

string

Search start date for date range search.

Required only if the user is searching for transactions within a certain date range

Format: yyyyMMdd

SearchEndDate

string

Search end date for date range search.

Required only if the user is searching for transactions within a certain date range

Format: yyyyMMdd

SearchAmount

string

Transaction amount to search for.

Required only if the user is searching for a transaction with a specific amount.

SearchMerchantName

string

Merchant name/Transaction description to search for.

Required only if the user is searching for a transaction with a specific merchant

Headers

Authorization

string

Defaults to Basic {token}

For {token} insert base64-encoded apiLogin:apiTransKey

profile-type

string

enum

Defaults to agent

Optional param to call Dispute API as a customer-service agent or a cardholder

Allowed:

Responses

Language

URL

Loading…

Response

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

application/json

200postRetrieveTransactions

202Transaction Selection UnavailableThis is a response for claim types that do not support transaction selection. This is configurable by the client, but by default the dispute system will set this to true for ClaimReasons ATMDepNotPosted, FraudApp, MerchantNonReceiptFunds, NonFraudMissing.

400Error retrieve transactions request

500Error retrieve transactions request