GET api/v2/pedido/getformadepagamento?PedidoID={PedidoID}&TenantId={TenantId}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
PedidoID

integer

None.

TenantId

globally unique identifier

None.

Body Parameters

None.

Response Information

Resource Description

FormaDePagamentoResult
NameDescriptionTypeAdditional information
FormasDePagamento

FormasDePagamentoBindingModel

None.

Succeeded

boolean

None.

Errors

Collection of string

None.

Response Formats

application/json, text/json

Sample:
{
  "FormasDePagamento": {
    "FormasDePagamento": {
      "Entrega": {
        "PagarAgora": {
          "Boleto": {
            "Ativo": true
          },
          "Pix": {
            "Ativo": true
          },
          "CartaoCredito": {
            "Ativo": true,
            "Bandeiras": [
              {
                "Bandeira": "sample string 1",
                "Codigo": 2,
                "ParcelamentoMaximo": 3,
                "Parcela": [
                  {
                    "Id": 1,
                    "Texto": "sample string 2",
                    "TipoParcelamento": "sample string 3",
                    "TaxaJuros": "sample string 4"
                  },
                  {
                    "Id": 1,
                    "Texto": "sample string 2",
                    "TipoParcelamento": "sample string 3",
                    "TaxaJuros": "sample string 4"
                  }
                ]
              },
              {
                "Bandeira": "sample string 1",
                "Codigo": 2,
                "ParcelamentoMaximo": 3,
                "Parcela": [
                  {
                    "Id": 1,
                    "Texto": "sample string 2",
                    "TipoParcelamento": "sample string 3",
                    "TaxaJuros": "sample string 4"
                  },
                  {
                    "Id": 1,
                    "Texto": "sample string 2",
                    "TipoParcelamento": "sample string 3",
                    "TaxaJuros": "sample string 4"
                  }
                ]
              }
            ]
          },
          "CartaoDebito": {
            "Ativo": true,
            "Bandeiras": [
              {
                "Bandeira": "sample string 1",
                "Codigo": 2
              },
              {
                "Bandeira": "sample string 1",
                "Codigo": 2
              }
            ]
          }
        },
        "PagarRetirada": {
          "Maquininha": {
            "CartaoCredito": {
              "Ativo": true,
              "Bandeiras": [
                {
                  "Bandeira": "sample string 1",
                  "Codigo": 2,
                  "ParcelamentoMaximo": 3
                },
                {
                  "Bandeira": "sample string 1",
                  "Codigo": 2,
                  "ParcelamentoMaximo": 3
                }
              ]
            },
            "CartaoDebito": {
              "Ativo": true,
              "Bandeiras": [
                {
                  "Bandeira": "sample string 1",
                  "Codigo": 2
                },
                {
                  "Bandeira": "sample string 1",
                  "Codigo": 2
                }
              ]
            }
          },
          "Cheque": {
            "Ativo": true,
            "NumeroCheques": 2
          },
          "Dinheiro": {
            "Ativo": true,
            "AceitaTroco": true
          }
        }
      },
      "Retirada": {
        "PagarAgora": {
          "Boleto": {
            "Ativo": true
          },
          "CartaoCredito": {
            "Ativo": true,
            "Bandeiras": [
              {
                "Bandeira": "sample string 1",
                "Codigo": 2,
                "ParcelamentoMaximo": 3,
                "Parcela": [
                  {
                    "Id": 1,
                    "Texto": "sample string 2",
                    "TipoParcelamento": "sample string 3",
                    "TaxaJuros": "sample string 4"
                  },
                  {
                    "Id": 1,
                    "Texto": "sample string 2",
                    "TipoParcelamento": "sample string 3",
                    "TaxaJuros": "sample string 4"
                  }
                ]
              },
              {
                "Bandeira": "sample string 1",
                "Codigo": 2,
                "ParcelamentoMaximo": 3,
                "Parcela": [
                  {
                    "Id": 1,
                    "Texto": "sample string 2",
                    "TipoParcelamento": "sample string 3",
                    "TaxaJuros": "sample string 4"
                  },
                  {
                    "Id": 1,
                    "Texto": "sample string 2",
                    "TipoParcelamento": "sample string 3",
                    "TaxaJuros": "sample string 4"
                  }
                ]
              }
            ]
          },
          "CartaoDebito": {
            "Ativo": true,
            "Bandeiras": [
              {
                "Bandeira": "sample string 1",
                "Codigo": 2
              },
              {
                "Bandeira": "sample string 1",
                "Codigo": 2
              }
            ]
          },
          "Pix": {
            "Ativo": true
          }
        },
        "PagarRetirada": {
          "Maquininha": {
            "CartaoCredito": {
              "Ativo": true,
              "Bandeiras": [
                {
                  "Bandeira": "sample string 1",
                  "Codigo": 2,
                  "ParcelamentoMaximo": 3
                },
                {
                  "Bandeira": "sample string 1",
                  "Codigo": 2,
                  "ParcelamentoMaximo": 3
                }
              ]
            },
            "CartaoDebito": {
              "Ativo": true,
              "Bandeiras": [
                {
                  "Bandeira": "sample string 1",
                  "Codigo": 2
                },
                {
                  "Bandeira": "sample string 1",
                  "Codigo": 2
                }
              ]
            }
          },
          "Cheque": {
            "Ativo": true,
            "NumeroCheques": 2
          },
          "Dinheiro": {
            "Ativo": true,
            "AceitaTroco": true
          }
        }
      }
    }
  },
  "Succeeded": true,
  "Errors": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:
<FormaDePagamentoResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FormulaCertaAPI.Models.v2.Result">
  <Errors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/FormulaCertaAPI.Models">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Errors>
  <Succeeded xmlns="http://schemas.datacontract.org/2004/07/FormulaCertaAPI.Models">true</Succeeded>
  <FormasDePagamento xmlns:d2p1="http://schemas.datacontract.org/2004/07/FormulaCertaAPI.Models.v2.BindingModels">
    <d2p1:FormasDePagamento>
      <d2p1:Entrega>
        <d2p1:PagarAgora>
          <d2p1:Boleto>
            <d2p1:Ativo>true</d2p1:Ativo>
          </d2p1:Boleto>
          <d2p1:CartaoCredito>
            <d2p1:Ativo>true</d2p1:Ativo>
            <d2p1:Bandeiras>
              <d2p1:Bandeira1>
                <d2p1:Bandeira>sample string 1</d2p1:Bandeira>
                <d2p1:Codigo>2</d2p1:Codigo>
                <d2p1:Parcela>
                  <d2p1:Parcela>
                    <d2p1:Id>1</d2p1:Id>
                    <d2p1:TaxaJuros>sample string 4</d2p1:TaxaJuros>
                    <d2p1:Texto>sample string 2</d2p1:Texto>
                    <d2p1:TipoParcelamento>sample string 3</d2p1:TipoParcelamento>
                  </d2p1:Parcela>
                  <d2p1:Parcela>
                    <d2p1:Id>1</d2p1:Id>
                    <d2p1:TaxaJuros>sample string 4</d2p1:TaxaJuros>
                    <d2p1:Texto>sample string 2</d2p1:Texto>
                    <d2p1:TipoParcelamento>sample string 3</d2p1:TipoParcelamento>
                  </d2p1:Parcela>
                </d2p1:Parcela>
                <d2p1:ParcelamentoMaximo>3</d2p1:ParcelamentoMaximo>
              </d2p1:Bandeira1>
              <d2p1:Bandeira1>
                <d2p1:Bandeira>sample string 1</d2p1:Bandeira>
                <d2p1:Codigo>2</d2p1:Codigo>
                <d2p1:Parcela>
                  <d2p1:Parcela>
                    <d2p1:Id>1</d2p1:Id>
                    <d2p1:TaxaJuros>sample string 4</d2p1:TaxaJuros>
                    <d2p1:Texto>sample string 2</d2p1:Texto>
                    <d2p1:TipoParcelamento>sample string 3</d2p1:TipoParcelamento>
                  </d2p1:Parcela>
                  <d2p1:Parcela>
                    <d2p1:Id>1</d2p1:Id>
                    <d2p1:TaxaJuros>sample string 4</d2p1:TaxaJuros>
                    <d2p1:Texto>sample string 2</d2p1:Texto>
                    <d2p1:TipoParcelamento>sample string 3</d2p1:TipoParcelamento>
                  </d2p1:Parcela>
                </d2p1:Parcela>
                <d2p1:ParcelamentoMaximo>3</d2p1:ParcelamentoMaximo>
              </d2p1:Bandeira1>
            </d2p1:Bandeiras>
          </d2p1:CartaoCredito>
          <d2p1:CartaoDebito>
            <d2p1:Ativo>true</d2p1:Ativo>
            <d2p1:Bandeiras>
              <d2p1:Bandeira2>
                <d2p1:Bandeira>sample string 1</d2p1:Bandeira>
                <d2p1:Codigo>2</d2p1:Codigo>
              </d2p1:Bandeira2>
              <d2p1:Bandeira2>
                <d2p1:Bandeira>sample string 1</d2p1:Bandeira>
                <d2p1:Codigo>2</d2p1:Codigo>
              </d2p1:Bandeira2>
            </d2p1:Bandeiras>
          </d2p1:CartaoDebito>
          <d2p1:Pix>
            <d2p1:Ativo>true</d2p1:Ativo>
          </d2p1:Pix>
        </d2p1:PagarAgora>
        <d2p1:PagarRetirada>
          <d2p1:Cheque>
            <d2p1:Ativo>true</d2p1:Ativo>
            <d2p1:NumeroCheques>2</d2p1:NumeroCheques>
          </d2p1:Cheque>
          <d2p1:Dinheiro>
            <d2p1:AceitaTroco>true</d2p1:AceitaTroco>
            <d2p1:Ativo>true</d2p1:Ativo>
          </d2p1:Dinheiro>
          <d2p1:Maquininha>
            <d2p1:CartaoCredito>
              <d2p1:Ativo>true</d2p1:Ativo>
              <d2p1:Bandeiras>
                <d2p1:Bandeira3>
                  <d2p1:Bandeira>sample string 1</d2p1:Bandeira>
                  <d2p1:Codigo>2</d2p1:Codigo>
                  <d2p1:ParcelamentoMaximo>3</d2p1:ParcelamentoMaximo>
                </d2p1:Bandeira3>
                <d2p1:Bandeira3>
                  <d2p1:Bandeira>sample string 1</d2p1:Bandeira>
                  <d2p1:Codigo>2</d2p1:Codigo>
                  <d2p1:ParcelamentoMaximo>3</d2p1:ParcelamentoMaximo>
                </d2p1:Bandeira3>
              </d2p1:Bandeiras>
            </d2p1:CartaoCredito>
            <d2p1:CartaoDebito>
              <d2p1:Ativo>true</d2p1:Ativo>
              <d2p1:Bandeiras>
                <d2p1:Bandeira4>
                  <d2p1:Bandeira>sample string 1</d2p1:Bandeira>
                  <d2p1:Codigo>2</d2p1:Codigo>
                </d2p1:Bandeira4>
                <d2p1:Bandeira4>
                  <d2p1:Bandeira>sample string 1</d2p1:Bandeira>
                  <d2p1:Codigo>2</d2p1:Codigo>
                </d2p1:Bandeira4>
              </d2p1:Bandeiras>
            </d2p1:CartaoDebito>
          </d2p1:Maquininha>
        </d2p1:PagarRetirada>
      </d2p1:Entrega>
      <d2p1:Retirada>
        <d2p1:PagarAgora>
          <d2p1:Boleto>
            <d2p1:Ativo>true</d2p1:Ativo>
          </d2p1:Boleto>
          <d2p1:CartaoCredito>
            <d2p1:Ativo>true</d2p1:Ativo>
            <d2p1:Bandeiras>
              <d2p1:Bandeira5>
                <d2p1:Bandeira>sample string 1</d2p1:Bandeira>
                <d2p1:Codigo>2</d2p1:Codigo>
                <d2p1:Parcela>
                  <d2p1:Parcela2>
                    <d2p1:Id>1</d2p1:Id>
                    <d2p1:TaxaJuros>sample string 4</d2p1:TaxaJuros>
                    <d2p1:Texto>sample string 2</d2p1:Texto>
                    <d2p1:TipoParcelamento>sample string 3</d2p1:TipoParcelamento>
                  </d2p1:Parcela2>
                  <d2p1:Parcela2>
                    <d2p1:Id>1</d2p1:Id>
                    <d2p1:TaxaJuros>sample string 4</d2p1:TaxaJuros>
                    <d2p1:Texto>sample string 2</d2p1:Texto>
                    <d2p1:TipoParcelamento>sample string 3</d2p1:TipoParcelamento>
                  </d2p1:Parcela2>
                </d2p1:Parcela>
                <d2p1:ParcelamentoMaximo>3</d2p1:ParcelamentoMaximo>
              </d2p1:Bandeira5>
              <d2p1:Bandeira5>
                <d2p1:Bandeira>sample string 1</d2p1:Bandeira>
                <d2p1:Codigo>2</d2p1:Codigo>
                <d2p1:Parcela>
                  <d2p1:Parcela2>
                    <d2p1:Id>1</d2p1:Id>
                    <d2p1:TaxaJuros>sample string 4</d2p1:TaxaJuros>
                    <d2p1:Texto>sample string 2</d2p1:Texto>
                    <d2p1:TipoParcelamento>sample string 3</d2p1:TipoParcelamento>
                  </d2p1:Parcela2>
                  <d2p1:Parcela2>
                    <d2p1:Id>1</d2p1:Id>
                    <d2p1:TaxaJuros>sample string 4</d2p1:TaxaJuros>
                    <d2p1:Texto>sample string 2</d2p1:Texto>
                    <d2p1:TipoParcelamento>sample string 3</d2p1:TipoParcelamento>
                  </d2p1:Parcela2>
                </d2p1:Parcela>
                <d2p1:ParcelamentoMaximo>3</d2p1:ParcelamentoMaximo>
              </d2p1:Bandeira5>
            </d2p1:Bandeiras>
          </d2p1:CartaoCredito>
          <d2p1:CartaoDebito>
            <d2p1:Ativo>true</d2p1:Ativo>
            <d2p1:Bandeiras>
              <d2p1:Bandeira6>
                <d2p1:Bandeira>sample string 1</d2p1:Bandeira>
                <d2p1:Codigo>2</d2p1:Codigo>
              </d2p1:Bandeira6>
              <d2p1:Bandeira6>
                <d2p1:Bandeira>sample string 1</d2p1:Bandeira>
                <d2p1:Codigo>2</d2p1:Codigo>
              </d2p1:Bandeira6>
            </d2p1:Bandeiras>
          </d2p1:CartaoDebito>
          <d2p1:Pix>
            <d2p1:Ativo>true</d2p1:Ativo>
          </d2p1:Pix>
        </d2p1:PagarAgora>
        <d2p1:PagarRetirada>
          <d2p1:Cheque>
            <d2p1:Ativo>true</d2p1:Ativo>
            <d2p1:NumeroCheques>2</d2p1:NumeroCheques>
          </d2p1:Cheque>
          <d2p1:Dinheiro>
            <d2p1:AceitaTroco>true</d2p1:AceitaTroco>
            <d2p1:Ativo>true</d2p1:Ativo>
          </d2p1:Dinheiro>
          <d2p1:Maquininha>
            <d2p1:CartaoCredito>
              <d2p1:Ativo>true</d2p1:Ativo>
              <d2p1:Bandeiras>
                <d2p1:Bandeira7>
                  <d2p1:Bandeira>sample string 1</d2p1:Bandeira>
                  <d2p1:Codigo>2</d2p1:Codigo>
                  <d2p1:ParcelamentoMaximo>3</d2p1:ParcelamentoMaximo>
                </d2p1:Bandeira7>
                <d2p1:Bandeira7>
                  <d2p1:Bandeira>sample string 1</d2p1:Bandeira>
                  <d2p1:Codigo>2</d2p1:Codigo>
                  <d2p1:ParcelamentoMaximo>3</d2p1:ParcelamentoMaximo>
                </d2p1:Bandeira7>
              </d2p1:Bandeiras>
            </d2p1:CartaoCredito>
            <d2p1:CartaoDebito>
              <d2p1:Ativo>true</d2p1:Ativo>
              <d2p1:Bandeiras>
                <d2p1:Bandeira8>
                  <d2p1:Bandeira>sample string 1</d2p1:Bandeira>
                  <d2p1:Codigo>2</d2p1:Codigo>
                </d2p1:Bandeira8>
                <d2p1:Bandeira8>
                  <d2p1:Bandeira>sample string 1</d2p1:Bandeira>
                  <d2p1:Codigo>2</d2p1:Codigo>
                </d2p1:Bandeira8>
              </d2p1:Bandeiras>
            </d2p1:CartaoDebito>
          </d2p1:Maquininha>
        </d2p1:PagarRetirada>
      </d2p1:Retirada>
    </d2p1:FormasDePagamento>
  </FormasDePagamento>
</FormaDePagamentoResult>