Update RFI for Payout

Docs/

API reference

Request

Security

JWT

Path

idstringrequired

The unique identifier for the payout.

Example:payout_E602dMzgjpDC

Bodyapplication/jsonrequired

documentsArray of objects(AttachedDocument)required

curl -i -X PATCH \
  https://api.glomopay.com/api/v1/payouts/payout_E602dMzgjpDC/update_rfi \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "documents": [
      {
        "id": "doc_nYUqLpuYQ0M8",
        "rfi_doc_id": "rfidoc_nYUqLpuYQ0M8"
      }
    ]
  }'

Responses

Document attached successfully

Bodyapplication/json

idstring, (uuid)read-only

The unique identifier for the payin.

Example:"payout_DdWp_HUbOnlg"

statusstringread-only

The status of the payout.

Enum:"pending_approval""queued""in_progress""action_required""success""failed""cancelled"

Example:"success"

destination_amountnumber, >= 1

The amount the beneficiary will receive, expressed in the smallest unit of the specified currency (e.g., cents for USD, paisa for INR). For example, 1000 represents $10.00 in USD. The actual currency is determined by the currency field. Note: "cents" is used generically to denote the minimal currency unit, not necessarily USD.

Example:1000

destination_currencystring, (iso-4217)

The currency code in ISO 4217 format. For example, USD.

Example:"USD"

source_amountnumber, >= 1

The amount you intend to send, also specified in the smallest unit of the selected currency. For example, 1000 equates to $10.00 in USD. The currency field determines which currency is used. As with destination_amount, "cents" is a placeholder for the minimal unit, not specifically USD.

Example:1000

source_currencystring, (iso-4217)

The currency code in ISO 4217 format. For example, USD.

Example:"USD"

beneficiary_idstring, (uuid)

The unique identifier for the beneficiary.

Example:"bene_5JU9yv0lGSUP"

documentsArray of objects(AttachedDocument)

The attached documents for the payout.

purpose_codestring

Purpose code for why you want to receive this payment

Example:"S0017"

mid_market_rateobjectread-only

The mid-market rate at the time of payout creation. The currency represents the destination currency and rate represents the factor of conversion. Example: 1 EUR = 1.17 USD. Rate corresponds to 1.17 and currency is USD.

feesobjectread-only

The fees applied to this payout

created_atstring, (timestamp)read-only

Timestamp representing when the payout was created

Example:"2021-06-01T12:00:00Z"

updated_atstring, (timestamp)read-only

Timestamp representing when the payout was last updated

Example:"2021-06-01T12:00:00Z"

utrstring or nullread-only

(Optional) Unique Transaction Reference for the payout. This is a unique identifier assigned by the bank to track the transaction.

Example:"AXISN52024112000001234"

request_idstring or null, <= 64 charactersread-only

The client-provided unique identifier for this payout request. Can be used to look up the payout via GET /v1/payouts?request_id=<your_request_id>.

Example:"your-internal-id"

payment_railstring or nullread-only

The payment rail used to settle this payout. Each local rail serves one corridor: upi, imps, neft, rtgs for INR; ipp, fts for AED; sepa for EUR; fps for GBP. swift is used for international transfers.

Enum:"swift""imps""neft""rtgs""upi""ipp""fts""sepa""fps"null

Example:"swift"

invoice_numberstring or null, <= 50 charactersread-only

The invoice reference provided when the payout was created.

Example:"INV-2026-001"

fee_collection_modestringread-only

How fees for this payout are collected.

Example:"merchant"

error_codestring or nullread-only

A machine-readable code describing why the payout failed or was cancelled. null unless the payout is in an error state. The accompanying error_description carries the human-readable text.

Code	Description
`QUOTE_EXPIRED`	Quote has expired. Please create a new payout with a valid quote.
`QUEUE_EXPIRED`	Payout stayed queued for 30 days because the balance did not cover it. No funds were held.
`PAYOUT_REJECTED`	Payout was rejected by the bank. Please reach out to support. (default fallback)
`INVALID_BENE_ACCOUNT_NUMBER`	Beneficiary account number is invalid.
`INVALID_BENE_ACCOUNT_TYPE`	Beneficiary account type is invalid.
`INVALID_BENE_IFSC`	Beneficiary IFSC code is invalid.
`INVALID_VPA`	VPA/UPI address is invalid.
`INVALID_BENE_NAME`	Beneficiary name is invalid.
`INVALID_BENE_ADDRESS`	Beneficiary address or PIN/ZIP code is invalid.
`INVALID_BENE_EMAIL`	Beneficiary email is invalid.
`INVALID_BENE_CONTACT`	Beneficiary contact/mobile number is invalid.
`NAME_MISMATCH`	Remitter and beneficiary names do not match for the selected purpose.

Enum:"QUOTE_EXPIRED""QUEUE_EXPIRED""PAYOUT_REJECTED""INVALID_BENE_ACCOUNT_NUMBER""INVALID_BENE_ACCOUNT_TYPE""INVALID_BENE_IFSC""INVALID_VPA""INVALID_BENE_NAME""INVALID_BENE_ADDRESS""INVALID_BENE_EMAIL"

Example:null

error_descriptionstring or nullread-only

A merchant-facing, human-readable description of the error. Operational copy for the merchant. null unless the payout is in an error state. See customer_error_description for the copy meant for the end-customer.

Example:null

customer_error_descriptionstring or nullread-only

Customer-facing error copy, written for the merchant to relay to their end-customer. Derives from the same error_code as error_description but targets a different audience. null when there is no error_code, or when the error code has no customer-facing variant (some codes are merchant-only).

Example:null

quote_idstring or nullread-only

The identifier of the quote this payout was created against. null for payouts that were not created from a quote.

Example:"quote_3m4n5o6p7q"

taxesArray of objectsread-only

Taxes withheld on this payout, deducted from the amount before it reached the beneficiary. Present on repatriation payouts (purpose code P0001), where the remitting bank withholds GST on the currency conversion; empty for every other purpose, and empty until the bank has confirmed the payout.

notesobject or null(Notes)

Optional key-value pairs for attaching custom metadata (e.g. invoice references, project codes). Keys must be strings and cannot collide with reserved field names. If your business has custom field rules configured (e.g. enum constraints), values are validated against those rules. Each key appears as a separate column in CSV report exports, with corresponding values populating the rows.

Example:

{
  "invoice_ref": "INV-2026-001",
  "project": "Alpha"
}

Response

{
  "id": "payout_DdWp_HUbOnlg",
  "status": "success",
  "destination_amount": 1000,
  "destination_currency": "USD",
  "source_amount": 1000,
  "source_currency": "USD",
  "beneficiary_id": "bene_5JU9yv0lGSUP",
  "documents": [
    { … }
  ],
  "purpose_code": "S0017",
  "mid_market_rate": {
    "currency": "USD",
    "rate": 1.17
  },
  "fees": {
    "fx_fee": { … },
    "txn_fee": { … }
  },
  "created_at": "2021-06-01T12:00:00Z",
  "updated_at": "2021-06-01T12:00:00Z",
  "utr": "AXISN52024112000001234",
  "request_id": "your-internal-id",
  "payment_rail": "swift",
  "invoice_number": "INV-2026-001",
  "fee_collection_mode": "merchant",
  "error_code": null,
  "error_description": null,
  "customer_error_description": null,
  "quote_id": "quote_3m4n5o6p7q",
  "taxes": [
    { … }
  ],
  "notes": {
    "invoice_ref": "INV-2026-001",
    "project": "Alpha"
  }
}