Create an instant payment

POST /v2/payments/external_entity/instant

Create an instant payment

cURL

curl --request POST \
  --url https://b2b-api.dev-riseworks.io/v2/payments/external_entity/instant \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "from": "<string>",
  "amount_cents": 5000000250,
  "payment_data": {
    "role_description": "<string>",
    "invoice_description": "<string>",
    "rise_sow": true,
    "documents": [
      "<string>"
    ],
    "services_description": "",
    "payment_details": "",
    "sow_link": "<string>",
    "reason_id": 123
  },
  "external_recipient_email": "[e-mail]",
  "currency_symbol": "USD",
  "network": "arbitrum",
  "external_recipient_first_name": "",
  "external_recipient_last_name": "",
  "external_recipient_is_company": false,
  "external_recipient_company_name": ""
}
'

200

{
  "success": true,
  "data": {
    "domain": {
      "name": "<string>",
      "version": "<string>",
      "chainId": 123,
      "verifyingContract": "<string>"
    },
    "types": {
      "CreatePaymentForwardRequest": [
        {
          "name": "<string>",
          "type": "<string>"
        }
      ],
      "RisePayment": [
        {
          "name": "<string>",
          "type": "<string>"
        }
      ]
    },
    "typed_data": {
      "from": "<string>",
      "to": "<string>",
      "salt": "<string>",
      "expires": "<string>",
      "data": {
        "id": "<string>",
        "groupID": "<string>",
        "payAtTime": "<string>",
        "validMinutes": "<string>",
        "payType": "<string>",
        "token": "<string>",
        "recipient": "<string>",
        "amount": "<string>",
        "data": "<string>"
      }
    },
    "primary_type": "<string>"
  }
}

Authorizations

Authorization · string · header · required

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

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-.*

amount_cents · integer · required

Required range: 500 <= x <= 10000000000

payment_data · object · required

Show child attributes

external_recipient_email · string<email> · required

Pattern: ^(?:[A-Za-z0-9_'+\-]+\.)*[A-Za-z0-9_'+\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$

currency_symbol · enum<string> · default: USD

Available options: USD

network · enum<string> · default: arbitrum

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

Available options: arbitrum

external_recipient_first_name · string · default: ""

Maximum string length: 45

external_recipient_last_name · string · default: ""

Maximum string length: 45

external_recipient_is_company · boolean · default: false

external_recipient_company_name · string · default: ""

Maximum string length: 191

Response

200

application/json

Default Response

success · enum<boolean> · required

Available options: true

data · object · required

Show child attributes