create payment

POST

/v1/payments

curl --request POST \
  --url https://api.flowpayra.com/v1/payments \
  --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 '{ "merchant_order_no": "example", "quotes": { "additionalProperty": { "amount": "example", "chain_ids": [ "example" ] } }, "user_id": "example", "splits": [ { "type": "percentage", "merchant_id": "example", "bps": 1 } ], "overpay_policy": "pro_rata", "expires_in_secs": 1, "memo": "example", "redirect_url": "https://example.com" }'

Authorizations

• HmacApiKey
• HmacSignature
• HmacTimestamp
• HmacNonce

Parameters

Header Parameters

Idempotency-Key

required

string

>= 1 characters <= 128 characters

Request Body^required

Media typeapplication/json

object

merchant_order_no

required

string

>= 1 characters <= 128 characters

quotes

required

object

>= 1 properties

key

additional properties

object

amount

required

string

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

chain_ids

Array<string>

>= 1 items <= 32 items unique items

user_id

string

>= 1 characters <= 128 characters

splits

Array

>= 1 items <= 32 items

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]+)?$/

overpay_policy

string

Allowed values: pro_rata to_primary

expires_in_secs

integer format: int64

>= 1

memo

string

<= 2048 characters

redirect_url

string format: uri

<= 2048 characters

Responses

200

Successful response

Media typeapplication/json

object

id

required

string

>= 1 characters <= 128 characters

status

required

string

>= 1 characters <= 64 characters

quotes

required

object

>= 1 properties

key

additional properties

object

amount

required

string

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

code

required

string

symbol

required

string

name

required

string

deployments

required

Array<object>

>= 1 items

object

currency_chain_id

required

string

>= 1 characters <= 128 characters

chain_id

required

string

>= 1 characters <= 128 characters

decimals

required

integer format: int32

raw_amount

required

string

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

asset_kind

required

string

Allowed values: native token

token_standard

required

string

contract_address

required

One of:

string

string

null

null

expires_at

required

string format: date-time

merchant_order_no

required

string

>= 1 characters <= 128 characters

checkout_url

required

string format: uri

Example

{
  "quotes": {
    "additionalProperty": {
      "deployments": [
        {
          "asset_kind": "native"
        }
      ]
    }
  }
}

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