Payment groups

Get payment Group

get

Autorizações

authX-Zydon-Access-Key-TokenX-Zydon-Access-Key-Code

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

idstringObrigatório

Respostas

200

OK

application/json

idstringOpcional

namestringOpcional

404

PaymentGroup was not found

application/json

500

An internal server error was thrown

application/json

get/payment-groups/{id}

HTTPcURLJavaScriptPython

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

{
  "id": "text",
  "name": "text",
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "payment_methods": [
    {
      "id": "text",
      "payment_method_id": "text",
      "attributes": {
        "ANY_ADDITIONAL_PROPERTY": {}
      }
    }
  ],
  "partners": [
    {
      "id": "text",
      "partner_id": "text",
      "partner_name": "text",
      "attributes": {
        "ANY_ADDITIONAL_PROPERTY": {}
      }
    }
  ]
}

Update payment group

put

Autorizações

authX-Zydon-Access-Key-TokenX-Zydon-Access-Key-Code

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

idstringObrigatório

Corpo

application/json

namestringObrigatório

Respostas

200

PaymentGroup updated successfully

application/json

idstringOpcional

namestringOpcional

422

A validation error was thrown

application/json

500

An internal server error was thrown

application/json

put/payment-groups/{id}

HTTPcURLJavaScriptPython

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

{
  "name": "text",
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "payment_methods": [
    {
      "id": "text",
      "payment_method_id": "text",
      "attributes": {
        "ANY_ADDITIONAL_PROPERTY": {}
      }
    }
  ],
  "partners": [
    {
      "id": "text",
      "partner_id": "text",
      "attributes": {
        "ANY_ADDITIONAL_PROPERTY": {}
      }
    }
  ]
}

{
  "id": "text",
  "name": "text",
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "payment_methods": [
    {
      "id": "text",
      "payment_method_id": "text",
      "attributes": {
        "ANY_ADDITIONAL_PROPERTY": {}
      }
    }
  ],
  "partners": [
    {
      "id": "text",
      "partner_id": "text",
      "partner_name": "text",
      "attributes": {
        "ANY_ADDITIONAL_PROPERTY": {}
      }
    }
  ]
}

Delete payment group

delete

Autorizações

authX-Zydon-Access-Key-TokenX-Zydon-Access-Key-Code

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

idstringObrigatório

Respostas

204

PaymentGroup removed successfully

application/json

idstringOpcional

422

A validation error was thrown

application/json

500

An internal server error was thrown

application/json

delete/payment-groups/{id}

HTTPcURLJavaScriptPython

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

{
  "id": "text"
}

List payment Groups

get

Autorizações

authX-Zydon-Access-Key-TokenX-Zydon-Access-Key-Code

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de consulta

searchstringOpcionalDefault: ""

pageinteger · int32OpcionalDefault: 0

perPageinteger · int32OpcionalDefault: 25

sortstringOpcionalDefault: ""

dirstringOpcionalDefault: asc

Respostas

200

OK

application/json

currentPageinteger · int32Opcional

perPageinteger · int32Opcional

totalinteger · int64Opcional

404

PaymentGroup was not found

application/json

500

An internal server error was thrown

application/json

get/payment-groups

HTTPcURLJavaScriptPython

GET /api/sales/payment-groups 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",
      "attributes": {
        "ANY_ADDITIONAL_PROPERTY": {}
      },
      "payment_methods": [
        {
          "id": "text",
          "payment_method_id": "text",
          "payment_method_name": "text",
          "attributes": {
            "ANY_ADDITIONAL_PROPERTY": {}
          }
        }
      ],
      "partners": [
        {
          "id": "text",
          "partner_id": "text",
          "attributes": {
            "ANY_ADDITIONAL_PROPERTY": {}
          }
        }
      ]
    }
  ]
}

Create payment group

post

Autorizações

authX-Zydon-Access-Key-TokenX-Zydon-Access-Key-Code

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Corpo

application/json

idstringOpcional

namestringObrigatório

Respostas

201

PaymentGroup created successfully

application/json

idstringOpcional

namestringOpcional

422

A validation error was thrown

application/json

500

An internal server error was thrown

application/json

post/payment-groups

HTTPcURLJavaScriptPython

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

{
  "id": "text",
  "name": "text",
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "payment_methods": [
    {
      "id": "text",
      "payment_method_id": "text",
      "attributes": {
        "ANY_ADDITIONAL_PROPERTY": {}
      }
    }
  ],
  "partners": [
    {
      "id": "text",
      "partner_id": "text",
      "attributes": {
        "ANY_ADDITIONAL_PROPERTY": {}
      }
    }
  ]
}

{
  "id": "text",
  "name": "text",
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "payment_methods": [
    {
      "id": "text",
      "payment_method_id": "text",
      "attributes": {
        "ANY_ADDITIONAL_PROPERTY": {}
      }
    }
  ],
  "partners": [
    {
      "id": "text",
      "partner_id": "text",
      "partner_name": "text",
      "attributes": {
        "ANY_ADDITIONAL_PROPERTY": {}
      }
    }
  ]
}