Sign in

v13

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

Trigger payment from a FBO account

This endpoint should only be used for when your account is configured for FBO payments. It triggers funding a quote from your FBO account to initiate payment.

post/fbo/confirm/{quoteId}

Path parameters

quoteIdstring required

ID of the quote to pay from FBO

Response

Payment successful. This updates the transaction to PROCESSING.

idstring required

Unique identifier for the transaction

status'CREATED' | 'PENDING' | 'PROCESSING' | 'COMPLETED' | 'REJECTED' | 'FAILED' | 'REFUNDED' | 'EXPIRED' required

Status of a payment transaction

type'INCOMING' | 'OUTGOING' required

Type of transaction (incoming payment or outgoing payment)

senderUmaAddressstring required

UMA address of the payment sender

receiverUmaAddressstring required

UMA address of the payment recipient

userIdstring required

System ID of the user (sender for outgoing, recipient for incoming)

platformUserIdstring required

Platform-specific ID of the user (sender for outgoing, recipient for incoming)

settledAtstring date-time

When the payment was or will be settled

createdAtstring date-time

When the transaction was created

descriptionstring

Optional memo or description for the payment

counterpartyInformationobject

Additional information about the counterparty, if available

Example response

{
  "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"
  }
}