Create issuing holders
POST {{baseInfraUrl}}/{{version}}/issuing-holder
You can create cardholders to which your cards will be bound when created.They support spending rules that will apply to all underlying cards.
Parameters | Value Type | Description |
---|---|---|
name | REQUIRED | Cardholder's name. |
taxId | REQUIRED | Cardholder's CPF (11 digits formatted or unformatted) or CNPJ (14 digits formatted or unformatted). |
externalId | REQUIRED | Cardholder's unique id, generated by the sub-issuer, to avoid duplicated holders. |
rules | OPTIONAL | List of spending rules for the cardholder. List of dictionaries or a list of Issuing Rule objects containing: amount, currencyCode, id, interval and name. |
tags | OPTIONAL | List of strings for tagging. All tags will be converted to lowercase. |
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
expand | string | Fields to expand information. |
Request Body
{"holders"=>[{"name"=>"Jamie Lannister", "externalId"=>"12346", "rules"=>[{"amount"=>900000, "currencyCode"=>"BRL", "interval"=>"week", "name"=>"Example Rule"}], "tags"=>["iron", "bank"], "taxId"=>"012.345.678-90"}]}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Content-Type | string |
RESPONSES
status: OK
{"holders":[{"created":"2022-05-17T20:03:05.939249+00:00","externalId":"123456789","id":"5055990386917376","name":"Jamie Lannister","rules":[{"amount":900000,"currencyCode":"BRL","id":"6181890293760000","interval":"week","name":"Example Rule"}],"status":"active","tags":["iron","bank"],"taxId":"012.345.678-90","updated":"2022-05-17T20:03:05.971168+00:00"}],"message":"Card Holder(s) successfully created"}