Payment methods

Get payment method

get

Autorizações

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

idstringObrigatório

Respostas

200

OK

application/json

404

PaymentMethod was not found

application/json

500

An internal server error was thrown

application/json

get

/payment-methods/{id}

GET /api/sales/payment-methods/{id} HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "name": "text",
  "type": "text",
  "minimum_value": 1,
  "maximum_value": 1,
  "has_online_payment_integration": true,
  "active": true,
  "adjustment_rate": 1,
  "minimum_installment_value": 1,
  "installments": [
    {
      "id": "text",
      "payment_method_id": "text",
      "sequence": 1,
      "installment_id": "text",
      "tax": 1,
      "discount": 1
    }
  ],
  "vendor": "text",
  "rede_merchant_id": "text",
  "rede_merchant_key": "text",
  "cielo_merchant_id": "text",
  "cielo_merchant_key": "text",
  "getnet_merchant_id": "text",
  "getnet_merchant_key": "text",
  "getnet_merchant_seller_id": "text",
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}

Update payment method

put

Autorizações

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

idstringObrigatório

Corpo

namestringObrigatório

typestringObrigatório

minimum_valuenumberObrigatório

maximum_valuenumberObrigatório

has_online_payment_integrationbooleanObrigatório

activebooleanObrigatório

adjustment_ratenumberOpcional

minimum_installment_valuenumberOpcional

vendorstringOpcional

rede_merchant_idstringOpcional

rede_merchant_keystringOpcional

cielo_merchant_idstringOpcional

cielo_merchant_keystringOpcional

getnet_merchant_idstringOpcional

getnet_merchant_keystringOpcional

getnet_merchant_seller_idstringOpcional

Respostas

200

PaymentMethod updated successfully

application/json

422

A validation error was thrown

application/json

500

An internal server error was thrown

application/json

put

/payment-methods/{id}

PUT /api/sales/payment-methods/{id} HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 516

{
  "name": "text",
  "type": "text",
  "minimum_value": 1,
  "maximum_value": 1,
  "has_online_payment_integration": true,
  "active": true,
  "adjustment_rate": 1,
  "minimum_installment_value": 1,
  "installments": [
    {
      "id": "text",
      "sequence": 1,
      "installment_id": "text",
      "tax": 1,
      "discount": 1
    }
  ],
  "vendor": "text",
  "rede_merchant_id": "text",
  "rede_merchant_key": "text",
  "cielo_merchant_id": "text",
  "cielo_merchant_key": "text",
  "getnet_merchant_id": "text",
  "getnet_merchant_key": "text",
  "getnet_merchant_seller_id": "text",
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}

{
  "id": "text",
  "name": "text",
  "type": "text",
  "minimum_value": 1,
  "maximum_value": 1,
  "has_online_payment_integration": true,
  "active": true,
  "adjustment_rate": 1,
  "minimum_installment_value": 1,
  "installments": [
    {
      "id": "text",
      "payment_method_id": "text",
      "sequence": 1,
      "installment_id": "text",
      "tax": 1,
      "discount": 1
    }
  ],
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}

Delete payment method

delete

Autorizações

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

idstringObrigatório

Respostas

204

PaymentMethod removed successfully

application/json

422

A validation error was thrown

application/json

500

An internal server error was thrown

application/json

delete

/payment-methods/{id}

DELETE /api/sales/payment-methods/{id} HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text"
}

Get payment methods

get

Autorizações

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de consulta

searchstringOpcionalDefault: ""

pageinteger · int32OpcionalDefault: 0

perPageinteger · int32OpcionalDefault: 25

sortstringOpcionalDefault: ""

dirstringOpcionalDefault: asc

only_activebooleanOpcional

Respostas

200

OK

application/json

404

PaymentMethod was not found

application/json

500

An internal server error was thrown

application/json

get

/payment-methods

GET /api/sales/payment-methods HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "currentPage": 1,
  "perPage": 1,
  "total": 1,
  "items": [
    {
      "id": "text",
      "name": "text",
      "type": "text",
      "minimum_value": 1,
      "maximum_value": 1,
      "has_online_payment_integration": true,
      "active": true,
      "adjustment_rate": 1,
      "minimum_installment_value": 1,
      "vendor": "text",
      "rede_merchant_id": "text",
      "rede_merchant_key": "text",
      "cielo_merchant_id": "text",
      "cielo_merchant_key": "text",
      "getnet_merchant_id": "text",
      "getnet_merchant_key": "text",
      "getnet_merchant_seller_id": "text",
      "attributes": {
        "ANY_ADDITIONAL_PROPERTY": {}
      }
    }
  ]
}

Create payment method

post

Autorizações

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Corpo

idstringOpcional

namestringObrigatório

typestringObrigatório

minimum_valuenumberObrigatório

maximum_valuenumberObrigatório

has_online_payment_integrationbooleanObrigatório

activebooleanObrigatório

adjustment_ratenumberOpcional

minimum_installment_valuenumberOpcional

vendorstringOpcional

rede_merchant_idstringOpcional

rede_merchant_keystringOpcional

cielo_merchant_idstringOpcional

cielo_merchant_keystringOpcional

getnet_merchant_idstringOpcional

getnet_merchant_keystringOpcional

getnet_merchant_seller_idstringOpcional

Respostas

201

PaymentMethod created successfully

application/json

422

A validation error was thrown

application/json

500

An internal server error was thrown

application/json

post

/payment-methods

POST /api/sales/payment-methods HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 516

{
  "id": "text",
  "name": "text",
  "type": "text",
  "minimum_value": 1,
  "maximum_value": 1,
  "has_online_payment_integration": true,
  "active": true,
  "adjustment_rate": 1,
  "minimum_installment_value": 1,
  "installments": [
    {
      "sequence": 1,
      "installment_id": "text",
      "tax": 1,
      "discount": 1
    }
  ],
  "vendor": "text",
  "rede_merchant_id": "text",
  "rede_merchant_key": "text",
  "cielo_merchant_id": "text",
  "cielo_merchant_key": "text",
  "getnet_merchant_id": "text",
  "getnet_merchant_key": "text",
  "getnet_merchant_seller_id": "text",
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}

{
  "id": "text",
  "name": "text",
  "type": "text",
  "minimum_value": 1,
  "maximum_value": 1,
  "has_online_payment_integration": true,
  "active": true,
  "adjustment_rate": 1,
  "minimum_installment_value": 1,
  "installments": [
    {
      "id": "text",
      "payment_method_id": "text",
      "sequence": 1,
      "installment_id": "text",
      "tax": 1,
      "discount": 1
    }
  ],
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}