← Back to appMCA Manager Helpmcamgr.com
Browse help topics

MCA Manager Public API

v1.4.0 · openapi.json · · guide · webhooks · keys

REST API for MCA Manager. Authenticate with a per-tenant API key (Authorization: Bearer mca_live_… or mca_test_…) scoped per resource (read / write). The base URL is your company host, e.g. https://acme.mcamgr.com. Every response carries X-Request-Id and X-RateLimit-Limit / X-RateLimit-Remaining; errors share one envelope { error, code, details?, requestId }. Lists paginate by cursor. POSTs honour Idempotency-Key. Outbound webhooks (Settings → Webhooks or /api/v1/webhook-endpoints) POST a signed envelope { id, event, version, occurredAt, data } for the events listed at /help/webhooks.

Try it

Paste an API key (Settings → API keys) and send requests against your instance from this page. Prefer a mca_test_ key: it works against your sandbox, or read-only until one exists. Requests are same-origin, so open this page on your company subdomain.

Conventions

  • Auth: Authorization: Bearer mca_live_…; each operation names the scope it needs (e.g. deals:write; write implies read).
  • Errors: { error, code, details?, requestId }. Quote requestId (also in X-Request-Id) when reporting a problem.
  • Lists: limit (≤200) + cursor{ items, count, hasMore, nextCursor }; sort=field:asc|desc, expand=, fields=, ids=, q=, date windows.
  • Writes: send Idempotency-Key on POSTs; money is a decimal string ("425.00"); timestamps are UTC ISO-8601.
  • Rate limit: 120 requests per minute per key; X-RateLimit-Remaining counts down, 429 carries Retry-After.

Whoami

get/api/v1/whoamiDescribe the calling keyany

Leads

get/api/v1/leadsList leadsleads:read
post/api/v1/leadsCreate a leadleads:write
get/api/v1/leads/{id}Get a leadleads:read
patch/api/v1/leads/{id}Update a leadleads:write
delete/api/v1/leads/{id}Delete a leadleads:write

Merchants

get/api/v1/merchantsList merchantsmerchants:read
post/api/v1/merchantsCreate a merchantmerchants:write
get/api/v1/merchants/{id}Get a merchantmerchants:read
patch/api/v1/merchants/{id}Update a merchantmerchants:write
delete/api/v1/merchants/{id}Delete a merchantmerchants:write

Deals

get/api/v1/dealsList dealsdeals:read
post/api/v1/dealsCreate a dealdeals:write
get/api/v1/deals/{id}Get a dealdeals:read
patch/api/v1/deals/{id}Update a deal or move its statedeals:write
delete/api/v1/deals/{id}Delete a dealdeals:write
get/api/v1/deals/{id}/statement-analysisLatest bank-statement analysis on a dealstatement-analysis:read
post/api/v1/deals/{id}/statement-analysisDeliver a bank-statement analysis for a dealstatement-analysis:write

Statement Analysis

post/api/v1/statement-analysisDeliver a bank-statement analysis (target by deal, merchant or EIN)statement-analysis:write

Payments

get/api/v1/paymentsList paymentspayments:read
post/api/v1/paymentsRecord a paymentpayments:write
get/api/v1/payments/{id}Get a paymentpayments:read
patch/api/v1/payments/{id}Update a payment or its statuspayments:write

Submissions

get/api/v1/submissionsList submissionssubmissions:read

Decisions

get/api/v1/decisionsList underwriting decisionscompliance:read

Renewals

get/api/v1/renewalsList renewal opportunitiesrenewals:read

Credit Facilities

get/api/v1/credit-facilitiesList lines of creditcredit-facilities:read

Isos

get/api/v1/isosList ISOsisos:read
post/api/v1/isosCreate an ISOisos:write
get/api/v1/isos/{id}Get an ISOisos:read
patch/api/v1/isos/{id}Update an ISOisos:write
delete/api/v1/isos/{id}Delete an ISOisos:write

Funders

get/api/v1/fundersList fundersfunders:read
post/api/v1/fundersCreate a funderfunders:write
get/api/v1/funders/{id}Get a funderfunders:read
patch/api/v1/funders/{id}Update a funderfunders:write
delete/api/v1/funders/{id}Delete a funderfunders:write

Syndicators

get/api/v1/syndicatorsList syndicatorssyndicators:read
post/api/v1/syndicatorsCreate a syndicatorsyndicators:write
get/api/v1/syndicators/{id}Get a syndicatorsyndicators:read
patch/api/v1/syndicators/{id}Update a syndicatorsyndicators:write
delete/api/v1/syndicators/{id}Delete a syndicatorsyndicators:write

Disclosures

get/api/v1/disclosuresList disclosurescompliance:read

Ucc Filings

get/api/v1/ucc-filingsList UCC filingscompliance:read

Payouts

get/api/v1/payoutsList payout batchespayouts:read

Applications

get/api/v1/applicationsList application submissionsapplications:read

Communications

get/api/v1/communicationsList communicationscommunications:read

Webhook Endpoints

get/api/v1/webhook-endpointsList webhook endpoints and the event cataloguewebhooks:read
post/api/v1/webhook-endpointsCreate a webhook endpointwebhooks:write
get/api/v1/webhook-endpoints/{id}Get a webhook endpoint with its recent deliverieswebhooks:read
patch/api/v1/webhook-endpoints/{id}Update a webhook endpointwebhooks:write
post/api/v1/webhook-endpoints/{id}Rotate the signing secret (?action=rotate)webhooks:write
delete/api/v1/webhook-endpoints/{id}Delete a webhook endpointwebhooks:write

Webhook events

  • deal.createdA deal was created (staff, API, portal or email intake).
  • deal.state_changedA deal moved to a new state (funded, closed, defaulted…).
  • merchant.createdA merchant record was created.
  • lead.createdA lead was created.
  • lead.status_changedA lead's status changed.
  • submission.status_changedA funder submission moved to a new pipeline status.
  • payment.paidA payment was marked paid (staff, processor or API).
  • payment.bouncedA payment was returned; carries the NACHA return code when known.
  • esign.signedOne party signed a document sent for signature.
  • esign.completedEvery party signed; carries the filed document id and url.
  • esign.declinedA signer declined; the request stopped and carries their reason.
  • webhook.testSent by the Send test button.

Schemas

Error
  • error - string (required)
  • code - string (required)
  • details - object
  • requestId - string (required)
Lead
  • id - integer (required)
  • businessName - string (required)
  • dbaName - string
  • contactName - string
  • email - string
  • phone - string
  • status - string (required) (NEW | CONTACTED | QUALIFIED | CONVERTED | DEAD)
  • source - string
  • requestedAmount - decimal string
  • notes - string
  • ownerId - integer
  • nextActionAt - string
  • createdAt - string (required)
  • updatedAt - string (required)
NewLead
  • businessName - string (required)
  • dbaName - string
  • contactName - string
  • email - string
  • phone - string
  • requestedAmount - decimal string
  • source - string
  • status - string (NEW | CONTACTED | QUALIFIED | CONVERTED | DEAD)
  • notes - string
UpdateLead
  • businessName - string
  • dbaName - string
  • contactName - string
  • email - string
  • phone - string
  • requestedAmount - decimal string
  • source - string
  • status - string (NEW | CONTACTED | QUALIFIED | CONVERTED | DEAD)
  • notes - string
Merchant
  • id - integer (required)
  • legalName - string (required)
  • dbaName - string
  • referenceId - string
  • federalId - string
  • industry - string
  • email - string
  • phone - string
  • addressLine1 - string
  • addressLine2 - string
  • city - string
  • state - string
  • postalCode - string
  • businessType - string
  • startedOn - string
  • website - string
  • stateOfIncorporation - string
  • naicsCode - string
  • sicCode - string
  • homeBased - boolean (required)
  • eCommerce - boolean (required)
  • annualRevenue - decimal string
  • merchantStatusId - integer
  • externalSource - string
  • externalRef - string
  • createdAt - string (required)
  • updatedAt - string (required)
NewMerchant
  • legalName - string (required)
  • dbaName - string
  • email - string
  • phone - string
  • website - string
  • federalId - string
  • industry - string
  • naicsCode - string
  • sicCode - string
  • businessType - string
  • startedOn - string
  • stateOfIncorporation - string
  • annualRevenue - decimal string
  • addressLine1 - string
  • addressLine2 - string
  • city - string
  • state - string
  • postalCode - string
  • homeBased - boolean
  • eCommerce - boolean
  • referenceId - string
UpdateMerchant
  • legalName - string
  • dbaName - string
  • email - string
  • phone - string
  • website - string
  • federalId - string
  • industry - string
  • naicsCode - string
  • sicCode - string
  • businessType - string
  • startedOn - string
  • stateOfIncorporation - string
  • annualRevenue - decimal string
  • addressLine1 - string
  • addressLine2 - string
  • city - string
  • state - string
  • postalCode - string
  • homeBased - boolean
  • eCommerce - boolean
  • referenceId - string
Deal
  • id - integer (required)
  • dealNumber - string
  • referenceId - string
  • productType - string (required) (MCA | FACTORING | TERM_LOAN | LOC | SBA | EQUIPMENT)
  • state - string (required) (INCEPTION | SUBMITTED | PREFUNDED | FUNDED | DEFAULTED | CLOSED | RENEWED | WITHDRAWN)
  • merchantId - integer (required)
  • isoId - integer
  • fundedLenderId - integer
  • inceptionLenderId - integer
  • factorRate - decimal string
  • buyRate - decimal string
  • specifiedPercentage - decimal string
  • fundedAmount - decimal string
  • paybackAmount - decimal string
  • termDays - integer
  • position - integer
  • bankFeeBasis - string (PERCENT_OF_FUNDED | PERCENT_OF_PAYBACK | POINTS | FLAT)
  • bankFeeValue - decimal string
  • applicationFee - decimal string
  • wireFee - decimal string
  • defaultSurcharge - decimal string
  • epoWindowDays - integer
  • epoFactorRate - decimal string
  • epoCommissionBasis - string
  • epoCommissionValue - decimal string
  • collectionFrequency - string (DAILY | WEEKLY | MONTHLY)
  • collectionSchedule - string (BANKING_DAYS | WEEKDAYS | EVERY_DAY | CUSTOM_DAYS)
  • collectionDay - integer
  • paymentAmount - decimal string
  • numberOfPayments - integer
  • firstPaymentDate - string
  • payoffDate - string
  • underwriterId - integer
  • uwScore - integer
  • uwScoreCategory - string (A | B | C)
  • commissionBasis - string (PERCENT_OF_FUNDED | PERCENT_OF_PAYBACK | POINTS | FLAT)
  • commissionValue - decimal string
  • commissionOfferId - integer
  • fundedAt - string
  • defaultedAt - string
  • isRenewal - boolean (required)
  • externalSource - string
  • externalRef - string
  • renewedFromDealId - integer
  • renewalPayoffAmount - decimal string
  • createdAt - string (required)
  • updatedAt - string (required)
NewDeal
  • merchantId - integer (required)
  • isoId - integer
  • productType - string (MCA | FACTORING | TERM_LOAN | LOC | SBA | EQUIPMENT)
  • fundedAmount - decimal string
  • paybackAmount - decimal string
  • factorRate - decimal string
  • buyRate - decimal string
  • termDays - integer
  • numberOfPayments - integer
  • paymentAmount - decimal string
  • collectionFrequency - string (DAILY | WEEKLY | MONTHLY)
  • collectionSchedule - string (BANKING_DAYS | WEEKDAYS | EVERY_DAY | CUSTOM_DAYS)
  • collectionDay - integer
  • firstPaymentDate - string
  • position - integer
  • specifiedPercentage - decimal string
  • commissionBasis - string (PERCENT_OF_FUNDED | PERCENT_OF_PAYBACK | POINTS | FLAT)
  • commissionValue - decimal string
  • bankFeeBasis - string (PERCENT_OF_FUNDED | PERCENT_OF_PAYBACK | POINTS | FLAT)
  • bankFeeValue - decimal string
  • applicationFee - decimal string
  • wireFee - decimal string
  • defaultSurcharge - decimal string
  • epoFactorRate - decimal string
  • epoWindowDays - integer
  • epoCommissionBasis - string
  • epoCommissionValue - decimal string
  • fundedAt - string
  • payoffDate - string
  • fundedLenderId - integer
  • inceptionLenderId - integer
  • underwriterId - integer
  • uwScore - integer
  • uwScoreCategory - string (A | B | C)
  • referenceId - string
UpdateDeal
  • isoId - integer
  • productType - string (MCA | FACTORING | TERM_LOAN | LOC | SBA | EQUIPMENT)
  • fundedAmount - decimal string
  • paybackAmount - decimal string
  • factorRate - decimal string
  • buyRate - decimal string
  • termDays - integer
  • numberOfPayments - integer
  • paymentAmount - decimal string
  • collectionFrequency - string (DAILY | WEEKLY | MONTHLY)
  • collectionSchedule - string (BANKING_DAYS | WEEKDAYS | EVERY_DAY | CUSTOM_DAYS)
  • collectionDay - integer
  • firstPaymentDate - string
  • position - integer
  • specifiedPercentage - decimal string
  • commissionBasis - string (PERCENT_OF_FUNDED | PERCENT_OF_PAYBACK | POINTS | FLAT)
  • commissionValue - decimal string
  • bankFeeBasis - string (PERCENT_OF_FUNDED | PERCENT_OF_PAYBACK | POINTS | FLAT)
  • bankFeeValue - decimal string
  • applicationFee - decimal string
  • wireFee - decimal string
  • defaultSurcharge - decimal string
  • epoFactorRate - decimal string
  • epoWindowDays - integer
  • epoCommissionBasis - string
  • epoCommissionValue - decimal string
  • fundedAt - string
  • payoffDate - string
  • fundedLenderId - integer
  • inceptionLenderId - integer
  • underwriterId - integer
  • uwScore - integer
  • uwScoreCategory - string (A | B | C)
  • referenceId - string
  • state - string (INCEPTION | SUBMITTED | PREFUNDED | FUNDED | DEFAULTED | CLOSED | RENEWED | WITHDRAWN)
Payment
  • id - integer (required)
  • dealId - integer (required)
  • type - string (required) (ORIGINAL_ADVANCE_PAYBACK | ADVANCE_PAYBACK | ADVANCE_PAYBACK_ADJUSTMENT | PARTICIPATION_PAYOUT | PARTICIPATION_PAYOUT_ADJUSTMENT | BOUNCE_FEE | WIRE_FEE | UCC_FEE | APPLICATION_FEE | OTHER_FEE | EPO_DISCOUNT | RENEWAL_PAYOFF)
  • status - string (required) (PENDING | SUBMITTED | PAID | BOUNCED | CANCELLED)
  • amount - decimal string (required)
  • scheduledDate - string
  • clearedDate - string
  • accountId - integer
  • syndicatorId - integer
  • bounceCodeId - integer
  • direction - string
  • externalTransferId - string
  • referenceId - string
  • note - string
  • source - string
  • method - string (ACH | WIRE | CHECK | CASH | OTHER | OFFSET)
  • bankAccountTokenId - integer
  • initiatedAt - string
  • returnedAt - string
  • locDrawId - integer
  • madeUpById - integer
  • createdAt - string (required)
  • updatedAt - string (required)
NewPayment
  • dealId - integer (required)
  • type - string (required) (ORIGINAL_ADVANCE_PAYBACK | ADVANCE_PAYBACK | ADVANCE_PAYBACK_ADJUSTMENT | PARTICIPATION_PAYOUT | PARTICIPATION_PAYOUT_ADJUSTMENT | BOUNCE_FEE | WIRE_FEE | UCC_FEE | APPLICATION_FEE | OTHER_FEE | EPO_DISCOUNT | RENEWAL_PAYOFF)
  • amount - decimal string (required)
  • status - string (PENDING | SUBMITTED | PAID | BOUNCED | CANCELLED)
  • method - string (ACH | WIRE | CHECK | CASH | OTHER | OFFSET)
  • accountId - integer
  • syndicatorId - integer
  • bounceCodeId - integer
  • referenceId - string
  • note - string
UpdatePayment
  • type - string (ORIGINAL_ADVANCE_PAYBACK | ADVANCE_PAYBACK | ADVANCE_PAYBACK_ADJUSTMENT | PARTICIPATION_PAYOUT | PARTICIPATION_PAYOUT_ADJUSTMENT | BOUNCE_FEE | WIRE_FEE | UCC_FEE | APPLICATION_FEE | OTHER_FEE | EPO_DISCOUNT | RENEWAL_PAYOFF)
  • amount - decimal string
  • status - string (PENDING | SUBMITTED | PAID | BOUNCED | CANCELLED)
  • method - string (ACH | WIRE | CHECK | CASH | OTHER | OFFSET)
  • accountId - integer
  • syndicatorId - integer
  • bounceCodeId - integer
  • referenceId - string
  • note - string
  • clearedDate - string
  • madeUpById - integer
Submission
  • id - integer (required)
  • dealId - integer (required)
  • funderId - integer (required)
  • statusId - integer (required)
  • underwriterId - integer
  • assignedToId - integer
  • delegatedToId - integer
  • submittedAt - string
  • statusChangedAt - string (required)
  • declineReasonId - integer
  • declinedAt - string
  • createdAt - string (required)
  • updatedAt - string (required)
DecisionResult
  • id - integer (required)
  • dealId - integer (required)
  • policyId - integer
  • recommendation - string (required)
  • score - integer (required)
  • category - string (required)
  • flags - object (required)
  • maxOffer - object
  • metrics - object (required)
  • createdAt - string (required)
RenewalOpportunity
  • id - integer (required)
  • priorDealId - integer (required)
  • merchantId - integer (required)
  • status - string (required)
  • paidDownPct - decimal string (required)
  • outstanding - decimal string (required)
  • renewalDealId - integer
  • createdAt - string (required)
  • updatedAt - string (required)
CreditFacility
  • id - integer (required)
  • dealId - integer (required)
  • creditLimit - decimal string (required)
  • availableRoom - decimal string (required)
  • factorRate - decimal string
  • status - string (required)
  • createdAt - string (required)
  • updatedAt - string (required)
Iso
  • id - integer (required)
  • name - string (required)
  • email - string
  • phone - string
  • contactName - string
  • website - string
  • notes - string
  • addressLine1 - string
  • addressLine2 - string
  • city - string
  • state - string
  • postalCode - string
  • ein - string
  • entityType - string
  • signerName - string
  • signerTitle - string
  • isoType - string
  • type - string (required) (BROKER | SUPER_BROKER | REFERRAL)
  • requires1099 - boolean (required)
  • isActive - boolean (required)
  • domains - string[] (required)
  • emailAddresses - string[] (required)
  • commissionRule - object
  • agreementSignedAt - string
  • idOnFileAt - string
  • voidedCheckAt - string
  • w9OnFileAt - string
  • createdAt - string (required)
  • updatedAt - string (required)
NewIso
  • name - string (required)
  • type - string (BROKER | SUPER_BROKER | REFERRAL)
  • isoType - string
  • contactName - string
  • email - string
  • phone - string
  • website - string
  • domains - string[]
  • emailAddresses - string[]
  • commissionRule - object
  • requires1099 - boolean
  • isActive - boolean
  • notes - string
UpdateIso
  • name - string
  • type - string (BROKER | SUPER_BROKER | REFERRAL)
  • isoType - string
  • contactName - string
  • email - string
  • phone - string
  • website - string
  • domains - string[]
  • emailAddresses - string[]
  • commissionRule - object
  • requires1099 - boolean
  • isActive - boolean
  • notes - string
Funder
  • id - integer (required)
  • name - string (required)
  • email - string
  • phone - string
  • contactName - string
  • website - string
  • notes - string
  • isActive - boolean (required)
  • isHouse - boolean (required)
  • externalSource - string
  • externalRef - string
  • createdAt - string (required)
  • updatedAt - string (required)
NewFunder
  • name - string (required)
  • contactName - string
  • email - string
  • phone - string
  • website - string
  • isHouse - boolean
  • isActive - boolean
  • notes - string
UpdateFunder
  • name - string
  • contactName - string
  • email - string
  • phone - string
  • website - string
  • isHouse - boolean
  • isActive - boolean
  • notes - string
Syndicator
  • id - integer (required)
  • name - string (required)
  • referenceId - string
  • email - string
  • phone - string
  • contactName - string
  • website - string
  • notes - string
  • requires1099 - boolean (required)
  • isActive - boolean (required)
  • isHouse - boolean (required)
  • externalSource - string
  • externalRef - string
  • portfolioId - integer
  • maxPerDeal - decimal string
  • managementFeePercent - decimal string
  • managementFeeBasis - string (PERCENT_OF_PARTICIPATION | PERCENT_OF_COLLECTIONS)
  • profitSplitPercent - decimal string
  • lossProtected - boolean (required)
  • participatesInBankFee - boolean
  • frontsCommission - boolean (required)
  • cafRecognition - string (required) (UPFRONT | AS_COLLECTED)
  • profitAccrual - string (required) (PRO_RATA | COST_FIRST)
  • distributionFrequency - string
  • createdAt - string (required)
  • updatedAt - string (required)
NewSyndicator
  • name - string (required)
  • contactName - string
  • email - string
  • phone - string
  • website - string
  • portfolioId - integer
  • isHouse - boolean
  • isActive - boolean
  • managementFeeBasis - string (PERCENT_OF_PARTICIPATION | PERCENT_OF_COLLECTIONS)
  • managementFeePercent - decimal string
  • profitAccrual - string (PRO_RATA | COST_FIRST)
  • profitSplitPercent - decimal string
  • cafRecognition - string (UPFRONT | AS_COLLECTED)
  • participatesInBankFee - boolean
  • frontsCommission - boolean
  • lossProtected - boolean
  • maxPerDeal - decimal string
  • distributionFrequency - string
  • requires1099 - boolean
  • referenceId - string
  • notes - string
UpdateSyndicator
  • name - string
  • contactName - string
  • email - string
  • phone - string
  • website - string
  • portfolioId - integer
  • isHouse - boolean
  • isActive - boolean
  • managementFeeBasis - string (PERCENT_OF_PARTICIPATION | PERCENT_OF_COLLECTIONS)
  • managementFeePercent - decimal string
  • profitAccrual - string (PRO_RATA | COST_FIRST)
  • profitSplitPercent - decimal string
  • cafRecognition - string (UPFRONT | AS_COLLECTED)
  • participatesInBankFee - boolean
  • frontsCommission - boolean
  • lossProtected - boolean
  • maxPerDeal - decimal string
  • distributionFrequency - string
  • requires1099 - boolean
  • referenceId - string
  • notes - string
Disclosure
  • id - integer (required)
  • dealId - integer (required)
  • state - string (required)
  • computed - object (required)
  • status - string (required)
  • signatureRequestId - integer
  • deliveredAt - string
  • signedAt - string
  • createdAt - string (required)
  • updatedAt - string (required)
UccFiling
  • id - integer (required)
  • dealId - integer (required)
  • provider - string (required)
  • externalId - string
  • fileNumber - string
  • jurisdiction - string (required)
  • type - string (required)
  • status - string (required)
  • collateral - string
  • filedAt - string
  • lapsesAt - string
  • createdAt - string (required)
  • updatedAt - string (required)
PayoutBatch
  • id - integer (required)
  • kind - string (required)
  • periodFrom - string (required)
  • periodTo - string (required)
  • status - string (required)
  • createdByUserId - integer
  • createdAt - string (required)
  • updatedAt - string (required)
ApplicationSubmission
  • id - integer (required)
  • formId - integer (required)
  • payload - object (required)
  • leadId - integer
  • status - string (required)
  • ip - string
  • createdAt - string (required)
Communication
  • id - integer (required)
  • channel - string (required)
  • direction - string (required) (INBOUND | OUTBOUND)
  • merchantId - integer
  • dealId - integer
  • fromAddr - string
  • toAddr - string
  • body - string
  • recordingUrl - string
  • durationSec - integer
  • dispositionReasonId - integer
  • userId - integer
  • occurredAt - string (required)
MerchantContact
  • id - integer (required)
  • merchantId - integer (required)
  • firstName - string (required)
  • lastName - string (required)
  • email - string
  • phone - string
  • ssnLast4 - string
  • title - string
  • ownershipPct - decimal string
  • isGuarantor - boolean (required)
  • isPrimary - boolean (required)
  • createdAt - string (required)
  • updatedAt - string (required)
WebhookEndpoint
  • id - integer (required)
  • url - string (required)
  • events - string[] (required)
  • isActive - boolean (required)
  • failureStreak - integer (required)
  • disabledAt - string
  • disabledReason - string
  • lastDeliveredAt - string
  • createdAt - string (required)
WebhookDelivery
  • id - integer (required)
  • endpointId - integer (required)
  • event - string (required)
  • payload - object (required)
  • status - string (required) (PENDING | DELIVERED | FAILED)
  • attempts - integer (required)
  • responseStatus - integer
  • error - string
  • durationMs - integer
  • responseSnippet - string
  • deliveredAt - string
  • createdAt - string (required)
  • updatedAt - string (required)
StatementAnalysis
  • id - integer (required)
  • dealId - integer (required)
  • merchantId - integer (required)
  • source - string (required)
  • version - string
  • periodStart - string
  • periodEnd - string
  • monthsCovered - integer
  • grossDeposits - decimal string
  • mcaDeposits - decimal string
  • internalTransfers - decimal string
  • trueRevenue3m - decimal string
  • avgMonthlyTrueRevenue - decimal string
  • estimatedMcaMonthly - decimal string
  • positionCount - integer
  • altered - boolean (required)
  • nsfCount - integer
  • negativeDays - integer
  • avgDailyBalance - decimal string
  • depositTypes - object
  • positions - object
  • alteredFlags - object
  • summary - object
  • keyId - integer
  • actorId - integer
  • receivedAt - string (required)
LocDraw
  • id - integer (required)
  • facilityId - integer (required)
  • amount - decimal string (required)
  • feeAmount - decimal string
  • paybackAmount - decimal string
  • status - string (required)
  • requestedBy - string
  • fundedAt - string
  • createdAt - string (required)
  • updatedAt - string (required)
Approval
  • id - integer (required)
  • submissionId - integer (required)
  • factorRate - decimal string
  • fundedAmount - decimal string
  • paybackAmount - decimal string
  • termDays - integer
  • epoDiscount - decimal string
  • notes - string
  • offerSentAt - string
  • acceptedAt - string
  • expiresAt - string
  • shareToken - string
  • counterAmount - decimal string
  • counterFactor - decimal string
  • counterTermDays - integer
  • counterBankFeePercent - decimal string
  • counterNote - string
  • counterAt - string
  • counterResolvedAt - string
  • counterAccepted - boolean
  • createdAt - string (required)
  • updatedAt - string (required)
PayoutItem
  • id - integer (required)
  • batchId - integer (required)
  • isoId - integer
  • referrerId - integer
  • syndicatorId - integer
  • dealId - integer
  • amount - decimal string (required)
  • paymentId - integer
  • status - string (required)
  • clawbackRiskAt - string
  • clawedBackAt - string
  • clawbackNote - string
  • clawbackAmount - decimal string
  • createdAt - string (required)

Can’t find what you need? Return to the app or contact your administrator.

API reference - Help