Create and lookup

Endpoints

Method	Path	Description
`POST`	`/v1/request-money`	Create a request-money ask and mint the payer fund-request link
`GET`	`/v1/request-money/{referenceId}`	Public status for your 8-char `referenceId`

Auth: X-API-Key (raas_sandbox_* / raas_live_*). Feature: request-money. Host: Partner API overview.

Create — `POST /v1/request-money`

Body (conceptual)

Field	Required	Notes
`referenceId`	Yes	Exactly 8 chars: `a-z`, `A-Z`, `0-9`. Your stable operation code
`amount`	Yes	Numeric amount
`currency`	Yes	ISO 4217 (destination / receive currency for the ask)
`expiresInMinutes`	No	Link TTL
`requestData.userReferenceId`	Yes	Your id for the requester (who is paid). Not the payer.
`requestData.name`	Yes	Requester name
`requestData.address.country`	Yes	Destination country (ISO 3166-1 alpha-2)
`requestData.dob`	No	Recommended when available (`YYYY-MM-DD`)
`requestData.payoutMethod`	Yes	`bank_account`, `card`, or `cash`

For bank_account, bankAccount.accountNumber accepts 1–34 alphanumeric characters (A–Z, 0–9), matching the ISO 13616 electronic IBAN maximum. Spaces are removed and lowercase letters are normalized to uppercase. The legacy bankAccount.number alias follows the same rule. Exact nested shapes are in OpenAPI (CreateRequestMoneyDto). For cash, send cash.provider as before — the platform maps it to the fund-request payer field.

Success response (additive)

Fields you already use remain (referenceId, id, status, statusDetails, waLink, landingLink). RaaS Widgets also returns:

Field	Meaning
`fundRequestLink`	Payer widget URL
`resolved`	Effective corridor/payout the backend inferred
`warnings`	Non-blocking offerability hints (omitted when empty)

The create response keeps the legacy shape: it does not include requestId, operationId, or recipientReferenceId. Persist requestId from the request_money.created webhook, or read it later with GET. Do not send recipientReferenceId on create. After the payer fulfills the link, that value appears on the operation (Partner GET /partner/operations and operation.* webhooks) and equals requestData.userReferenceId.

{
  "referenceId": "Ab3xY9mK",
  "id": "Ab3xY9mK",
  "status": "pending",
  "statusDetails": "The operation is pending because the sender has not yet started the process.",
  "waLink": "https://wa.me/…",
  "landingLink": "https://app.example.com/pay?ref=Ab3xY9mK",
  "fundRequestLink": "https://<fund-request-host>/link_…",
  "resolved": {
    "sourceCountry": "US",
    "destinationCountry": "GT",
    "sourceCurrency": "USD",
    "destinationCurrency": "GTQ",
    "payoutType": "bank_account",
    "payerCode": null,
    "stateCode": "GT-01"
  }
}

Idempotency

Header	Behaviour
`Idempotency-Key`	Optional. Opaque string (UUID recommended). Safe retry of the same body returns the original create instead of `409`

Without a matching key, a duplicate partner + referenceId returns 409 LEGACY_REFERENCE_EXISTS.

Offerability warnings

warnings[] entries such as ROUTE_NOT_OFFERABLE do not fail create. They mean the route can commit but may not appear in the payer widget at that amount. Try another amount/payer or contact your account manager.

Lookup — `GET /v1/request-money/{referenceId}`

Returns the public snapshot for your integrator referenceId, or 404 when unknown.

Lookup fields (additive)

Same link and status fields as create, plus:

Field	When present	Meaning
`requestId`	Money-request record exists	Canonical ask id (`req_…`). Use it to correlate `operation.*` webhooks
`operationId`	After the payer creates the fulfilling transfer	Operation id (`op_…`)
`resolved`	When route dimensions were stored on the ask	Same corridor/payout echo as create

Lookup does not return recipientReferenceId. Use Partner GET /partner/operations/{operationId} (or the operation.* webhook) once operationId is present. Before fulfillment, GET includes requestId and omits operationId. warnings are create-only and are not returned on lookup.

{
  "referenceId": "Ab3xY9mK",
  "id": "Ab3xY9mK",
  "requestId": "req_abc123",
  "operationId": "op_a1b2c3d4e5f6",
  "status": "processing",
  "statusDetails": "Payment in progress; not yet final.",
  "waLink": "https://wa.me/…",
  "landingLink": "https://app.example.com/pay?ref=Ab3xY9mK",
  "fundRequestLink": "https://<fund-request-host>/link_…",
  "resolved": {
    "sourceCountry": "US",
    "destinationCountry": "GT",
    "sourceCurrency": "USD",
    "destinationCurrency": "GTQ",
    "payoutType": "bank_account",
    "payerCode": null,
    "stateCode": "GT-01"
  }
}

Public status values

Status	Meaning
`pending`	Ask created; sender has not completed payment
`processing`	Sender created the fulfilling operation (in progress)
`completed`	Transfer settled / ask funded
`rejected`	Fulfilling operation failed
`cancelled`	Cancelled or expired

How these map from the internal money request / operation: see Lifecycle. After an operation exists, prefer operation webhooks for real-time updates.

Common error codes

Branch on stable error.code (or OFAC body code), never on message.

Code	HTTP	Meaning
`CORRIDOR_UNRESOLVABLE`	422	Could not derive source/destination corridor
`ROUTE_NOT_AVAILABLE`	422	No provider for the route
`STATE_NOT_MAPPED`	422	Payout state not mapped for the provider
`PAYOUT_METHOD_UNSUPPORTED`	422	Payout type not supported on this route
`LEGACY_REFERENCE_EXISTS`	409	Duplicate `referenceId` without matching idempotency key
`OFAC_HIT`	403	Watch-list / OFAC rejection
`USER_BLOCKED`	403	Requester (`userReferenceId`) is blocked
`USER_SUSPENDED`	403	Requester is suspended (view-only)
`API_FEATURE_NOT_ENABLED`	403	Partner lacks `request-money`
`IDENTITY_VALIDATOR_*`	503	Identity screening unavailable

Failed creates may also emit request_money.failed — see Webhooks.

Partner configuration

Optional partner settings power derived links:

landingBaseUrl — landingLink = base + ?ref={referenceId}
whatsappBaseUrl + message template — builds waLink

Configure via Partner Portal / Leap admin. Missing WhatsApp config yields an empty waLink string.

Getting Started

Request API

Concepts

Integration

Flows

Webhooks

Operations

Endpoints

Create — `POST /v1/request-money`

Body (conceptual)

Success response (additive)

Idempotency

Offerability warnings

Lookup — `GET /v1/request-money/{referenceId}`

Lookup fields (additive)

Public status values

Common error codes

Partner configuration

Next steps

Lifecycle

Webhooks

​Endpoints

​Create — POST /v1/request-money

​Body (conceptual)

​Success response (additive)

​Idempotency

​Offerability warnings

​Lookup — GET /v1/request-money/{referenceId}

​Lookup fields (additive)

​Public status values

​Common error codes

​Partner configuration

​Next steps

Lifecycle

Webhooks

Endpoints

Create — `POST /v1/request-money`

Body (conceptual)

Success response (additive)

Idempotency

Offerability warnings

Lookup — `GET /v1/request-money/{referenceId}`

Lookup fields (additive)

Public status values

Common error codes

Partner configuration

Next steps