Skip to main content
POST
Create a Routing
Creates a routing for one (account_code, payment_method) pair. Each routing references connections by their connection_id. Make sure your connections are created and ACTIVE for the requested payment_method before you call routing.

Body

enum
required
E.g., CARD, PIX, WALLET. Immutable per routing — to route a different method, create a new routing.
string
required
Free-form label.
object
required
The route used when no condition_sets[] matches.
object[]
Optional. Ordered by sort_number — first matching set wins.

Response

string
Unique identifier for the routing.

Errors

Authorizations

PUBLIC-API-KEY
string
header
default:<Your PUBLIC-API-KEY>
required
PRIVATE-SECRET-KEY
string
header
default:<Your PRIVATE-SECRET-KEY>
required

Headers

X-Idempotency-Key
string<uuid>
required

Body

application/json
payment_method
string
required
Example:

"CARD"

name
string
required
Example:

"Card routing"

default_route
object
required

Response

201 - application/json

Created

id
string
account_code
string
payment_method
string
name
string
default_route
object
created_at
string<date-time>
updated_at
string<date-time>