v1

latestOpenAPI 3.0.32026-07-26206388.3 KB

MCA

Get Upload Presigned URL

Generates a presigned upload URL for attaching a supporting document (e.g. invoice) to an FFMS transaction. Upload the file to the returned URL via HTTP PUT.

post/gcc/v1/ffms/external/transaction/{gid}/upload-presigned

Path parameters

gidstring required

Unique FFMS transaction identifier (from the MCA_FUND_RECEIVED webhook).

Request body

amountstring required

Transaction amount.

currencystring required

ISO 4217 currency code.

invoiceTypestring required

Type of document being uploaded.

paymentTypestring required

Payment type classification.

merchantIdstring required

Merchant identifier. Must match the transaction.

customerFullNamestring

Full name of the customer (3–150 characters).

shippingDetailsstring

Shipping information (1–120 characters).

invoiceNumberstring

Invoice reference number (1–100 characters).

purposeCodestring

Purpose code for remittance reporting.

fxRatestring

Foreign exchange rate applied.

fileNamestring required

File name including extension (extension max 10 characters).

Example request

{
  "amount": "1000.00",
  "currency": "USD",
  "invoiceType": "INVOICE",
  "paymentType": "CARD",
  "merchantId": "merchant_001",
  "customerFullName": "John Doe",
  "shippingDetails": "Bangalore, India",
  "invoiceNumber": "INV-2026-00321",
  "purposeCode": "P0102",
  "fxRate": "83.12",
  "fileName": "invoice_INV-2026-00321.pdf"
}

Response

Presigned URL generated successfully.

gidstring

Transaction identifier.

statusstring

messagestring

timestampstring

reasonCodestring

presignedUrlstring uri

Temporary URL — upload the file immediately via HTTP PUT.

fileNamestring

invoiceTypestring

paymentTypestring

dataobject nullable

errorsobject nullable

Example response

{
  "gid": "gl_XXXXXXXXXXXXXXXX",
  "status": "201 CREATED",
  "message": "Request completed",
  "timestamp": "05/03/2026 17:35:10",
  "reasonCode": "GL-201-001",
  "fileName": "invoice_INV-2026-00321.pdf",
  "invoiceType": "INVOICE",
  "paymentType": "CARD"
}