Skip to content
FlowPayraFlowPayra Docs

replace default split template

PUT
/v1/split-template
curl --request PUT \
  --url https://api.flowpayra.com/v1/split-template \
  --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 '{ "shares": [ { "merchant_id": "example", "bps": 1 } ] }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Header Parameters

Section titled “Header Parameters”
Idempotency-Key
required
string
>= 1 characters <= 128 characters

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
shares
required
Array<object>
<= 32 items
object
merchant_id
required
string
>= 1 characters <= 128 characters
bps
required
integer format: int32
>= 1 <= 10000
Examplegenerated
{
  "shares": [
    {
      "merchant_id": "example",
      "bps": 1
    }
  ]
}

Responses

Section titled “Responses”

200

Section titled “200”

Successful response

Media typeapplication/json
object
default_template
required
One of:
object
type
required
Allowed value: percentage
shares
required
Array<object>
<= 32 items
object
merchant_id
required
string
>= 1 characters <= 128 characters
bps
required
integer format: int32
>= 1 <= 10000
enforce_recipient_allowlist
required
boolean
allowed_merchant_ids
required
Array<string>
<= 32 items unique items
Example
{
  "default_template": {
    "type": "percentage"
  }
}

400

Section titled “400”

Stable API error

Media typeapplication/json
object
code
required
string
message
required
string
details
Examplegenerated
{
  "code": "example",
  "message": "example",
  "details": "example"
}

401

Section titled “401”

Stable API error

Media typeapplication/json
object
code
required
string
message
required
string
details
Examplegenerated
{
  "code": "example",
  "message": "example",
  "details": "example"
}

404

Section titled “404”

Stable API error

Media typeapplication/json
object
code
required
string
message
required
string
details
Examplegenerated
{
  "code": "example",
  "message": "example",
  "details": "example"
}

409

Section titled “409”

Stable API error

Media typeapplication/json
object
code
required
string
message
required
string
details
Examplegenerated
{
  "code": "example",
  "message": "example",
  "details": "example"
}

422

Section titled “422”

Stable API error

Media typeapplication/json
object
code
required
string
message
required
string
details
Examplegenerated
{
  "code": "example",
  "message": "example",
  "details": "example"
}