v1

latestOpenAPI 3.0.32026-07-2621102.1 MB

Claim

/claim/withdrawRequest

Use this endpoint to request a claim to be withdrawn

post/claim/withdrawRequest

Request body

providerIdinteger required

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

transactionIdstring required

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

ClaimIdstring required

Unique claim ID

WithdrawalReasonstring required

Reason for claim to be withdrawn

Example request

{
  "providerId": 9999,
  "transactionId": "984513-395483653-4483483478",
  "ClaimId": "2408050075C",
  "WithdrawalReason": "Test reason for withdrawal"
}

Response

Successful claim withdraw request

Type'Error' | 'Success'

Status of the request

Messagestring

Message about the status

Codestring

Numeric code for the status