x402 requirements

POST

/v1/x402/requirements

curl --request POST \
  --url https://api.flowpayra.com/v1/x402/requirements \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: example' \
  --header 'X-Api-Key: <X-Api-Key>' \
  --header 'X-Nonce: <X-Nonce>' \
  --header 'X-Signature: <X-Signature>' \
  --header 'X-Timestamp: <X-Timestamp>' \
  --data '{ "scheme": "exact", "currency_id": "example", "chain_id": "example", "amount": "example", "splits": [ { "type": "percentage", "merchant_id": "example", "bps": 1 } ], "resource": "https://example.com", "user_id": "example" }'

Authorizations

• HmacApiKey
• HmacSignature
• HmacTimestamp
• HmacNonce

Parameters

Header Parameters

Idempotency-Key

required

string

>= 1 characters <= 128 characters

Request Body^required

Media typeapplication/json

object

scheme

string

default: exact

Allowed values: exact upto

currency_id

required

string

chain_id

required

string

amount

required

string

<= 128 characters /^(0|[1-9][0-9]*)(\.[0-9]+)?$/

splits

Array

One of: discriminator: type

object

object

type

required

Allowed value: percentage

merchant_id

required

string

>= 1 characters <= 128 characters

bps

required

integer format: int32

>= 1 <= 10000

object

object

type

required

Allowed value: fixed

merchant_id

required

string

>= 1 characters <= 128 characters

amounts

required

object

>= 1 properties

key

additional properties

string

<= 128 characters /^(0|[1-9][0-9]*)(\.[0-9]+)?$/

resource

required

string format: uri

<= 2048 characters

user_id

string

>= 1 characters <= 128 characters

Responses

200

Successful response

Media typeapplication/json

object

payment_id

required

string

accepts

required

Array<object>

object

scheme

required

string

Allowed values: exact upto

network

required

string

asset

required

string

pay_to

required

string

max_amount_required

required

string

<= 78 characters /^(0|[1-9][0-9]*)$/

resource

required

string format: uri

nonce

required

string

valid_before

required

integer format: int64

extra

Example

{
  "accepts": [
    {
      "scheme": "exact"
    }
  ]
}

400

Stable API error

Media typeapplication/json

object

code

required

string

message

required

string

details

Example^generated

{
  "code": "example",
  "message": "example",
  "details": "example"
}

401

Stable API error

Media typeapplication/json

object

code

required

string

message

required

string

details

Example^generated

{
  "code": "example",
  "message": "example",
  "details": "example"
}

404

Stable API error

Media typeapplication/json

object

code

required

string

message

required

string

details

Example^generated

{
  "code": "example",
  "message": "example",
  "details": "example"
}

409

Stable API error

Media typeapplication/json

object

code

required

string

message

required

string

details

Example^generated

{
  "code": "example",
  "message": "example",
  "details": "example"
}

422

Stable API error

Media typeapplication/json

object

code

required

string

message

required

string

details

Example^generated

{
  "code": "example",
  "message": "example",
  "details": "example"
}