Cria um recebedor

POST

/api/v2/payment_recipients

Servidor do ambiente de produção
Servidor do ambiente de testes

Cria um recebedor

Authorizations

Token
X-Shop-Host

Request Body

object

tag_id

integer

recipient_id

integer

percentage

required

number

<= 100

active

boolean

default: true

charge_processing_fee

boolean

liable

boolean

code

string

place_id

integer

user_id

integer

include_shipping

Indica se o frete deve ser incluído no split do pagamento

boolean

default: true

Responses

200

Quando o recebedor foi criado com sucesso

Payment Recipient

Modelo que representa um recebedor na API

object

required

integer

percentage

required

number

<= 100

active

boolean

default: true

charge_processing_fee

boolean

liable

boolean

code

string

name

string

tag_name

string

place_id

integer

recipient_id

required

integer

tag_id

integer

user_id

integer

include_shipping

Indica se o frete deve ser incluído no split do pagamento

boolean

default: true

422

Quando os parâmetros enviados são inválidos

422

Modelo que representa um erro de validação na criação e atualização de registros

object

errors

object

{field}

Array<string>

Examples

{
  "errors": {
    "percentage": [
      "não pode ficar em branco"
    ]
  }
}