API reference

List your corridors

GET /corridors

Data-driven corridor discovery for the partner resolved from the key: the brand, the send-to-India corridors for each allowed send currency, and the full supported destination set.

Scope

corridors:read

Sandbox

✓Sandbox keys: yes

Responses

{
  "brand": "Example Remit",
  "corridors": [
    {
      "source_country": "US",
      "source_currency": "USD",
      "destination_country": "IN",
      "destination_currency": "INR"
    }
  ],
  "destinations": [
    "IN",
    "MX"
  ]
}

curl

curl -X GET 'https://smartremit.ai/api/partner/v1/corridors' \
  -H "Authorization: Bearer $SMARTREMIT_TEST_KEY"

Price a transfer

POST /quote

FX and fee quote at the platform reference rate. Nothing is stored. Pass destination_country (resolved to its home currency) or destination_currency (default INR); destination_country wins when both are present. Pass sender.phone to price the sender's first transfer at no fee (first_transfer_free: true); this needs a key that also holds transactions:write. Without it, or with an invalid number, the standard fee is shown. The quote is not binding: the transaction's fee is final. Sandbox transfers never use up the free first transfer.

Scope

quote

Sandbox

✓Sandbox keys: yes

Request body (required, JSON)

{
  "amount_source": 200,
  "source_currency": "USD",
  "destination_country": "IN",
  "sender": {
    "phone": "12025550123"
  }
}

Responses

{
  "amount_source": 200,
  "source_currency": "USD",
  "fee_source": 1.99,
  "total_charge_source": 201.99,
  "amount_destination": 17040,
  "destination_currency": "INR",
  "fx_rate": 85.2,
  "first_transfer_free": false
}

curl

curl -X POST 'https://smartremit.ai/api/partner/v1/quote' \
  -H "Authorization: Bearer $SMARTREMIT_TEST_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
  "amount_source": 200,
  "source_currency": "USD",
  "destination_country": "IN",
  "sender": {
    "phone": "12025550123"
  }
}'

Store a beneficiary

POST /beneficiaries

Validate and store a partner-scoped beneficiary. Payout details are encrypted at rest. Not idempotent: a retry stores a second beneficiary.

Scope

beneficiaries:write

Sandbox

✕Sandbox keys: no

Request body (required, JSON)

{
  "name": "Ravi Example",
  "country": "IN",
  "payout_method": "bank",
  "fields": {
    "accountNumber": "123456789012",
    "ifsc": "HDFC0001234"
  }
}

Responses

curl

curl -X POST 'https://smartremit.ai/api/partner/v1/beneficiaries' \
  -H "Authorization: Bearer $SMARTREMIT_LIVE_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Ravi Example",
  "country": "IN",
  "payout_method": "bank",
  "fields": {
    "accountNumber": "123456789012",
    "ifsc": "HDFC0001234"
  }
}'

Validate payout fields

POST /beneficiaries/validate

Stateless payout-field validation for a destination country (a pre-check before creating a beneficiary or a transaction). Nothing is stored.

Scope

beneficiaries:validate

Sandbox

✓Sandbox keys: yes

Request body (required, JSON)

{
  "country": "IN",
  "fields": {
    "accountNumber": "123456789012",
    "ifsc": "HDFC0001234"
  }
}

Responses

curl

curl -X POST 'https://smartremit.ai/api/partner/v1/beneficiaries/validate' \
  -H "Authorization: Bearer $SMARTREMIT_TEST_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
  "country": "IN",
  "fields": {
    "accountNumber": "123456789012",
    "ifsc": "HDFC0001234"
  }
}'

List your transfers

GET /transactions

Newest-first keyset list, scoped to the partner and the environment of the key.

Scope

transactions:read

Sandbox

✓Sandbox keys: yes

Parameters

Responses

curl

curl -X GET 'https://smartremit.ai/api/partner/v1/transactions' \
  -H "Authorization: Bearer $SMARTREMIT_TEST_KEY"

Mint a transfer

POST /transactions

Mint a transfer. The Idempotency-Key header is required: once a transaction exists under a key, every request with that key and a valid body returns that same transaction with its current state (the body is validated but not compared). Sanctions screening runs on every mint in every mode; a hit is 422 and the attempt is recorded as blocked. Today screening runs against a built-in reference rule set, not yet a live commercial AML feed. A transaction created without sender.name is held for manual review. client_reference is optional: your own order number, 1 to 64 letters, digits and . _ : / # - characters. It is saved once and comes back in every answer and in the settlements statement. It is also in the settlement instruction when your own rail pays the transaction out (never when another payout partner does). A status callback may send payout_reference (for example a bank UTR) with paid_out; it is saved once. purpose is required: why the money is sent, one of family_support, gift, education, medical, savings, bills, business or other (exactly these lower-case values). A missing or unknown purpose is 422 before the Idempotency-Key is bound, so a corrected retry with the same key succeeds. The purpose is saved, comes back in every answer and is in the settlement instruction's compliance block. purpose_detail is required when purpose is other: the sender's reason in their own words, 10 to 120 characters that say what the money is for. A missing, too short, too long or meaningless purpose_detail is 422 before the Idempotency-Key is bound. When the reason names one of the other purposes (for example school fees), the transaction takes that purpose and keeps the reason. With any other purpose, purpose_detail is ignored. SmartRemit checks every reason, and some transactions are held for review (compliance_status flagged).

Scope

transactions:write

Sandbox

✓Sandbox keys: yes

Parameters

Request body (required, JSON)

{
  "amount_source": 200,
  "source_currency": "USD",
  "client_reference": "INV-2026-0042",
  "purpose": "family_support",
  "sender": {
    "phone": "+12025550142",
    "name": "Jane Doe",
    "kyc_status": "verified"
  },
  "beneficiary": {
    "name": "Ravi Example",
    "payout_method": "bank",
    "payout_destination": "123456789012|HDFC0001234"
  }
}

Responses

curl

curl -X POST 'https://smartremit.ai/api/partner/v1/transactions' \
  -H "Authorization: Bearer $SMARTREMIT_TEST_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H 'Content-Type: application/json' \
  -d '{
  "amount_source": 200,
  "source_currency": "USD",
  "client_reference": "INV-2026-0042",
  "purpose": "family_support",
  "sender": {
    "phone": "+12025550142",
    "name": "Jane Doe",
    "kyc_status": "verified"
  },
  "beneficiary": {
    "name": "Ravi Example",
    "payout_method": "bank",
    "payout_destination": "123456789012|HDFC0001234"
  }
}'

Fetch one transfer

GET /transactions/{id}

Partner-scoped read. A transaction outside your partner or your key's environment is 404.

Scope

transactions:read

Sandbox

✓Sandbox keys: yes

Parameters

Responses

curl

curl -X GET 'https://smartremit.ai/api/partner/v1/transactions/{id}' \
  -H "Authorization: Bearer $SMARTREMIT_TEST_KEY"

Confirm funds captured

POST /transactions/{id}/confirm

Confirm that funds were captured, which begins settlement. A flagged transfer is held in_review until compliance staff release it. Confirming a transfer that is already paid, delivered or in_review returns it unchanged.

Scope

transactions:write

Sandbox

✓Sandbox keys: yes

Parameters

Responses

curl

curl -X POST 'https://smartremit.ai/api/partner/v1/transactions/{id}/confirm' \
  -H "Authorization: Bearer $SMARTREMIT_TEST_KEY"

Your rate sheet

GET /rates

Your current rates. fresh says whether the rate is still competing (it has a rate and its expiry is in the future). margin_bps is your platform-configured fallback margin.

Scope

rates:read

Sandbox

✕Sandbox keys: no

Responses

{
  "rates": [
    {
      "source_currency": "USD",
      "destination_currency": "INR",
      "effective_rate": 85.1,
      "expires_at": "2026-09-23T11:00:00.000Z",
      "fresh": true,
      "margin_bps": 150
    }
  ]
}

curl

curl -X GET 'https://smartremit.ai/api/partner/v1/rates' \
  -H "Authorization: Bearer $SMARTREMIT_LIVE_KEY"

Push one corridor rate

PUT /rates

Push the wholesale conversion rate you offer for one corridor. When your fresh rate beats the platform reference rate and your settlement rail is configured, eligible platform transfers are routed to you for settlement. A pushed rate does not change the pricing of your own /quote or /transactions: those stay at the platform reference rate. ttl_seconds defaults to 3600 and is clamped to 60–86400; an expired rate stops competing.

Scope

rates:write

Sandbox

✕Sandbox keys: no

Request body (required, JSON)

{
  "source_currency": "USD",
  "destination_currency": "INR",
  "effective_rate": 85.1,
  "ttl_seconds": 3600
}

Responses

{
  "source_currency": "USD",
  "destination_currency": "INR",
  "effective_rate": 85.1,
  "expires_at": "2026-09-23T11:00:00.000Z",
  "pushed_at": "2026-09-23T10:00:00.000Z"
}

curl

curl -X PUT 'https://smartremit.ai/api/partner/v1/rates' \
  -H "Authorization: Bearer $SMARTREMIT_LIVE_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
  "source_currency": "USD",
  "destination_currency": "INR",
  "effective_rate": 85.1,
  "ttl_seconds": 3600
}'

Settlements statement

GET /settlements

The instruction ledger for reconciliation: every live transfer of yours that was paid and sent for settlement in a half-open [from, to) window on paid_at, in UTC. Oldest first. Listed: paid and delivered transfers, and cancelled ones only if a rail was instructed (see refund_status: none, requested, pending, completed or failed). A transfer held for compliance review (in_review) is never listed; once released it appears on its release day, with paid_at set to the release time. totals cover the returned page only (every listed row, cancelled included), per currency, in integer minor units (cents: 20000 = 200.00). The statement never includes payout account details or sender or recipient identity. reference is the transaction id; on the reference rail, provider_ref and payout_reference are simulated. In CSV, a text cell starting with = + - @, a tab or a carriage return is prefixed with ' so a spreadsheet never runs it as a formula. Any partner_id parameter is ignored. Each row ends with client_reference and payout_reference (the last two CSV columns).

Scope

settlements:read

Sandbox

✕Sandbox keys: no

Parameters

Responses

curl

curl -X GET 'https://smartremit.ai/api/partner/v1/settlements' \
  -H "Authorization: Bearer $SMARTREMIT_LIVE_KEY"

Error

Transaction