LIlightsparkdev
Invitations

Create an UMA invitation from a given platform user.

Changed on

Create an UMA invitation from a given platform user.

post/invitations

Request

  • Base URL
    https://api.uma.money/umaaas/2025-05-15
  • URL
    https://api.uma.money/umaaas/2025-05-15/invitations
  • Auth
    HTTP basic

Request body

inviterUmastring required

The UMA address of the user creating the invitation

firstNamestring

First name of the inviter to show as part of the invite

amountToSendinteger

An amount to send (in the smallest unit of the user's currency) to the invitee when the invitation is claimed. This is optional and if not provided, the invitee will not receive any amount. Note that the actual sending of the amount must be done by the inviter platform once the INVITATION_CLAIMED webhook is received. If the inviter platform either does not send the payment or the payment fails, the invitee will not receive this amount. This field is primarily used for display purposes on the claiming side of the invitation.

expiresAtstring date-time

When the invitation expires (if at all)

Example request

{
  "inviterUma": "$inviter@uma.domain",
  "firstName": "Alice",
  "amountToSend": 12550,
  "expiresAt": "2023-09-01T14:30:00Z"
}

Response

Invitation created successfully

codestring required

The unique code of the invitation

createdAtstring date-time required

When the invitation was created

claimedAtstring date-time

When the invitation was claimed if it has been claimed

urlstring required

The URL where this invitation can be claimed.

expiresAtstring date-time

When the invitation expires (if at all)

inviterUmastring required

The UMA address of the inviter

inviteeUmastring

The UMA address of the invitee

status'PENDING' | 'CLAIMED' | 'EXPIRED' | 'CANCELLED' required

The status of the invitation

firstNamestring

The inviter's first name. Will be displayed when the recipient clicks the invite link

inviteeCountryCodestring

The country of the invitee (ISO 3166-1 alpha-2 code). Only available for CLAIMED invitations when provided by the invitee.

Example response

{
  "code": "019542f5",
  "createdAt": "2023-09-01T14:30:00Z",
  "claimedAt": "2023-09-01T14:30:00Z",
  "url": "https://uma.me/i/019542f5",
  "expiresAt": "2023-09-01T14:30:00Z",
  "inviterUma": "$inviter@uma.domain",
  "inviteeUma": "$invitee@uma.domain",
  "status": "PENDING",
  "firstName": "Jane",
  "amountToSend": {
    "amount": 12550,
    "currency": {
      "code": "USD",
      "name": "United States Dollar",
      "symbol": "$",
      "decimals": 2
    }
  },
  "inviteeCountryCode": "US"
}

Changes

  • 723ce326c29cRevision changes
    • info

      removed the INVALID_PAYREQ_RESPONSE enum value from the response property for the response status

    • info

      removed the LOOKUP_REQUEST_FAILED enum value from the response property for the response status

    • info

      removed the QUOTE_REQUEST_FAILED enum value from the response property for the response status

  • 4eecbca2b491Revision changes
    • info

      added the optional property to the response with the status