Sign in

v33

latestOpenAPI 3.1.0Proprietaryraw.githubusercontent.com2026-05-28103497709.6 KB
Invitations

Create an UMA invitation

Create an UMA invitation from a given platform customer.

post/invitations

Request body

inviterUmastring required

The UMA address of the customer creating the invitation

firstNamestring

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

amountToSendinteger

An amount to send (in the smallest unit of the customer'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": "2025-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

Example response

{
  "code": "019542f5",
  "createdAt": "2025-09-01T14:30:00Z",
  "claimedAt": "2025-09-01T14:30:00Z",
  "url": "https://uma.me/i/019542f5",
  "expiresAt": "2025-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
    }
  }
}