Create typed data for payments

Create typed data for payments. The typed data can be signed and then executed to create the payments on-chain. With a Viewer SIWE session the signed-in wallet signs and must hold a role on the team Rise Account: PaymentInitiator for intents (pay_now=false), or Payer, Owner or Treasurer to also pay now. Every session must sign with the wallet it signed in with. Requires the x-idempotency-key header; a key that has already created payments returns 409.

POST /v2/payments

Create typed data for payments

cURL

curl --request POST \
  --url https://b2b-api.dev-riseworks.io/v2/payments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-idempotency-key: <x-idempotency-key>' \
  --data '
{
  "from": "<string>",
  "to": [
    {
      "to": "<string>",
      "amount_cents": 5000000050,
      "currency_symbol": "USD",
      "invoice_description": "<string>",
      "role_description": "<string>",
      "external_id": "<string>"
    }
  ],
  "pay_now": true,
  "network": "arbitrum"
}
'

200

{
  "success": true,
  "data": {
    "to_sign": {
      "domain": {
        "name": "<string>",
        "version": "<string>",
        "chainId": 123,
        "verifyingContract": "<string>"
      },
      "types": {
        "CreatePaymentAuthorizationForwardRequest": [
          {
            "name": "<string>",
            "type": "<string>"
          }
        ],
        "RisePaymentAuthorizationRequest": [
          {
            "name": "<string>",
            "type": "<string>"
          }
        ]
      },
      "typed_data": {
        "from": "<string>",
        "to": "<string>",
        "salt": "<string>",
        "expires": "<string>",
        "data": {
          "groupID": "<string>",
          "merkleRoot": "<string>",
          "paymentsCount": "<string>",
          "maxAmountPerPayment": "<string>",
          "deadline": "<string>"
        }
      },
      "primary_type": "<string>"
    },
    "payment_data": {
      "checksum": "<string>"
    },
    "failed_payments": [
      {
        "userNanoid": "<string>",
        "error": "<string>"
      }
    ],
    "duplicates": {
      "payments": [
        {
          "to": "<string>",
          "amount_cents": 5000000050,
          "currency_symbol": "AED",
          "invoice_description": "<string>",
          "role_description": "<string>",
          "external_id": "<string>"
        }
      ],
      "days_checked": 0
    }
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-idempotency-key · string · required

Required. A key you generate for each request (1–255 characters). Send the same key on the create (POST) and execute (PUT) of that request, including retries, so a retry is not applied twice. Use a new key for each new request.

Required string length: 1 - 255

Body

application/json

from · string<starts_with> · required

Identifier of a Rise team (a workspace below a company). 15-character nanoid prefixed with te-.

Required string length: 15

Pattern: ^te-.*

to · object[] · required

Show child attributes

pay_now · boolean · required

true: the payment is created and executed immediately. false: the payment is created as an intent and is not processed straight away — it must be approved by a user with payment execution permission before it is sent.

network · enum<string> · default: arbitrum

Optional. Defaults to arbitrum, currently the only supported network, so you can leave it out.

Available options: arbitrum

Response

200

application/json

Default Response

success · enum<boolean> · required

Available options: true

data · object · required

Show child attributes