v13

latestOpenAPI 3.1.0Proprietaryraw.githubusercontent.com2026-03-243075159.3 KB

Webhooks

Outgoing payment status webhook

Webhook that is called when an outgoing payment's status changes. This endpoint should be implemented by clients of the UMAaas API.

Authentication

The webhook includes a signature in the X-UMAaas-Signature header that allows you to verify that the webhook was sent by UMAaas. To verify the signature:

Get the UMAaas public key provided to you during integration
Decode the base64 signature from the header
Create a SHA-256 hash of the request body
Verify the signature using the public key and the hash

If the signature verification succeeds, the webhook is authentic. If not, it should be rejected.

This webhook is informational only and is sent when an outgoing payment completes successfully or fails.

postWebhookoutgoing-payment

Payload

timestampstring date-time required

ISO8601 timestamp when the webhook was sent (can be used to prevent replay attacks)

webhookIdstring required

Unique identifier for this webhook delivery (can be used for idempotency)

type'INCOMING_PAYMENT' | 'OUTGOING_PAYMENT' | 'TEST' | 'BULK_UPLOAD' | 'INVITATION_CLAIMED' required

Type of webhook event, used by the receiver to identify which webhook is being received

Example payload

{
  "timestamp": "2023-08-15T14:32:00Z",
  "webhookId": "Webhook:019542f5-b3e7-1d02-0000-000000000007",
  "transaction": {
    "id": "Transaction:019542f5-b3e7-1d02-0000-000000000004",
    "senderUmaAddress": "$sender@external.domain",
    "receiverUmaAddress": "$recipient@uma.domain",
    "userId": "User:019542f5-b3e7-1d02-0000-000000000001",
    "platformUserId": "18d3e5f7b4a9c2",
    "settledAt": "2023-08-15T14:30:00Z",
    "createdAt": "2023-08-15T14:25:18Z",
    "description": "Payment for invoice #1234",
    "counterpartyInformation": {
      "FULL_NAME": "John Sender",
      "BIRTH_DATE": "1985-06-15",
      "NATIONALITY": "DE"
    },
    "sentAmount": {
      "amount": 12550,
      "currency": {
        "code": "USD",
        "name": "United States Dollar",
        "symbol": "$",
        "decimals": 2
      }
    },
    "receivedAmount": {
      "amount": 12550,
      "currency": {
        "code": "USD",
        "name": "United States Dollar",
        "symbol": "$",
        "decimals": 2
      }
    },
    "exchangeRate": 1.08,
    "fees": 10,
    "quoteId": "Quote:019542f5-b3e7-1d02-0000-000000000006",
    "originalTransactionId": "Transaction:019542f5-b3e7-1d02-0000-000000000003",
    "paymentInstructions": {
      "reference": "UMA-Q12345-REF",
      "instructionsNotes": "Please ensure the reference code is included in the payment memo/description field",
      "bankAccountInfo": {
        "clabeNumber": "123456789012345678",
        "bankName": "BBVA Mexico",
        "accountHolderName": "John Doe"
      }
    },
    "refund": {
      "reference": "UMA-Q12345-REFUND",
      "initiatedAt": "2023-08-15T14:30:00Z",
      "settledAt": "2023-08-15T14:30:00Z"
    },
    "rateDetails": {
      "counterpartyMultiplier": 1.08,
      "counterpartyFixedFee": 10,
      "umaaasMultiplier": 0.925,
      "umaaasFixedFee": 10,
      "umaaasVariableFeeRate": 0.003,
      "umaaasVariableFeeAmount": 30
    }
  }
}

Response

Webhook received successfully