Consulta de Formas de Pagamentos – GET

Filtros


Atalhos para busca

Objetivo

A finalidade deste método é permitir consultar formas de pagamentos.

Chamada

GET api/v1/sm/payment-form?
DATE_UPDATE={DATE_UPDATE}&NUMBER_PAYMENT_FORM=
{NUMBER_PAYMENT_FORM}&SPECIE_PAYMENT_FORM=
{SPECIE_PAYMENT_FORM}&STATUS=
{STATUS}&_pageNo=
{_pageNo}&_pageSize=
{_pageSize}

Informações para Requisição (Request Information)

Parâmetros URI (URI Parameters)

Nome (Name) Descrição (Description) Tipo (Type) Informações Adicionais (Adittional Information)
date_update Update Date – (dd/MM/aaaa hh:MM ou ddMMaaaahhmm) – (Optional) string Não há.
number_payment_form Number Payment Form – (00000) – (Optional) integer Não há.
specie_payment_form Form of Payment – Can be a list, separated by commas. Eg.: A,B A – Cumulative Agreement, B – Bank Slip, C – Bank Check, D – Money, E – Debit Card, F – Financial Services, I – Financial POS, N – Promissory Note, O – Others, P – Own Card, R – Credit Card, S – POS Card, T – Food Card, U – Worth (Debit), V – Agreement, X – Change, x – Change Coupon, Y – Gift Card – (Optional) string Não há.
status Status of Associated Companies of Payment Forms – (A = Active or I = Inactive) – (Optional – Default = “A”) If “A” will be returned to the active payment forms for the company, otherwise the inactive ones will be returned. string Não há.
_pageNo integer Não há.
_pageSize integer Não há.

Parâmetros do Corpo (Body Parameters)

Não há.

Informações para Resposta (Response Information)

Códigos do Recurso (Response Codes)

  • OK (200)
  • NotFound (404)
  • BadRequest (400)
  • Unauthorized (401)
  • InternalServerError (500)

Descrição do Recurso (Resource Description)

PaymentFormResponseDTO – List of Payment Forms

Collection of PaymentFormResponseDTO

Nome (Name) Descrição (Description) Tipo (Type) Informações Adicionais (Adittional Information)
description_payment_form Description of Payment Form string Não há.
indicates_bank_slip Indicates if Payment Form is Bank Slip string Não há.
indicates_credit_card Indicates if Payment Form is Credit Card string Não há.
code_payment_form Number of Payment Form integer Não há.
specie_payment_form Form of Payment string Não há.
value_minimum_payment_form Minimum amount for this Payment Form decimal number Não há.
company Companies that Accept the Payment form Collection of PaymentFormCompanyResponseDTO Não há.
 

 

number_company Number Company integer Não há.
name_company Company Name string Não há.
code_payment_form Number of Payment Form integer Não há.
reg_number Legal Entity – Brazilian Registry of Corporate Taxpayers integer Não há.
reg_number_digit Digit of Legal Entity – Brazilian Registry of Corporate Taxpayers integer Não há.
status Status string Não há.

Formatos de Resposta (Response Formats)

application/json, text/json

Exemplo (Sample):

[
  {
    "description_payment_form": "sample string 1",
    "indicates_bank_slip": "sample string 2",
    "indicates_credit_card": "sample string 3",
    "code_payment_form": 4,
    "specie_payment_form": "sample string 5",
    "value_minimum_payment_form": 1.1,
    "company": [
      {
        "number_company": 1,
        "name_company": "sample string 2",
        "code_payment_form": 3,
        "reg_number": 1,
        "reg_number_digit": 1,
        "status": "sample string 4"
      },
      {
        "number_company": 1,
        "name_company": "sample string 2",
        "code_payment_form": 3,
        "reg_number": 1,
        "reg_number_digit": 1,
        "status": "sample string 4"
      }
    ]
  },
  {
    "description_payment_form": "sample string 1",
    "indicates_bank_slip": "sample string 2",
    "indicates_credit_card": "sample string 3",
    "code_payment_form": 4,
    "specie_payment_form": "sample string 5",
    "value_minimum_payment_form": 1.1,
    "company": [
      {
        "number_company": 1,
        "name_company": "sample string 2",
        "code_payment_form": 3,
        "reg_number": 1,
        "reg_number_digit": 1,
        "status": "sample string 4"
      },
      {
        "number_company": 1,
        "name_company": "sample string 2",
        "code_payment_form": 3,
        "reg_number": 1,
        "reg_number_digit": 1,
        "status": "sample string 4"
      }
    ]
  }
]
application/xml, text/xml 

Exemplo (Sample):

<ArrayOfPaymentFormResponseDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" 
xmlns="http://schemas.datacontract.org/2004/07/Consinco.SM.Api.Entities.Entities.v1.Common">
  <PaymentFormResponseDTO>
    <DESCRIPTION_PAYMENT_FORM>sample string 1</DESCRIPTION_PAYMENT_FORM>
    <INDICATES_BANK_SLIP>sample string 2</INDICATES_BANK_SLIP>
    <INDICATES_CREDIT_CARD>sample string 3</INDICATES_CREDIT_CARD>
    <NUMBER_PAYMENT_FORM>4</NUMBER_PAYMENT_FORM>
    <PaymentFormCompanyResponseDTO>
      <PaymentFormCompanyResponseDTO>
        <NAME_COMPANY>sample string 2</NAME_COMPANY>
        <NUMBER_COMPANY>1</NUMBER_COMPANY>
        <NUMBER_PAYMENT_FORM>3</NUMBER_PAYMENT_FORM>
        <REG_NUMBER>1</REG_NUMBER>
        <REG_NUMBER_DIGIT>1</REG_NUMBER_DIGIT>
        <STATUS>sample string 4</STATUS>
      </PaymentFormCompanyResponseDTO>
      <PaymentFormCompanyResponseDTO>
        <NAME_COMPANY>sample string 2</NAME_COMPANY>
        <NUMBER_COMPANY>1</NUMBER_COMPANY>
        <NUMBER_PAYMENT_FORM>3</NUMBER_PAYMENT_FORM>
        <REG_NUMBER>1</REG_NUMBER>
        <REG_NUMBER_DIGIT>1</REG_NUMBER_DIGIT>
        <STATUS>sample string 4</STATUS>
      </PaymentFormCompanyResponseDTO>
    </PaymentFormCompanyResponseDTO>
    <SPECIE_PAYMENT_FORM>sample string 5</SPECIE_PAYMENT_FORM>
    <VALUE_MINIMUM_PAYMENT_FORM>1.1</VALUE_MINIMUM_PAYMENT_FORM>
  </PaymentFormResponseDTO>
  <PaymentFormResponseDTO>
    <DESCRIPTION_PAYMENT_FORM>sample string 1</DESCRIPTION_PAYMENT_FORM>
    <INDICATES_BANK_SLIP>sample string 2</INDICATES_BANK_SLIP>
    <INDICATES_CREDIT_CARD>sample string 3</INDICATES_CREDIT_CARD>
    <NUMBER_PAYMENT_FORM>4</NUMBER_PAYMENT_FORM>
    <PaymentFormCompanyResponseDTO>
      <PaymentFormCompanyResponseDTO>
        <NAME_COMPANY>sample string 2</NAME_COMPANY>
        <NUMBER_COMPANY>1</NUMBER_COMPANY>
        <NUMBER_PAYMENT_FORM>3</NUMBER_PAYMENT_FORM>
        <REG_NUMBER>1</REG_NUMBER>
        <REG_NUMBER_DIGIT>1</REG_NUMBER_DIGIT>
        <STATUS>sample string 4</STATUS>
      </PaymentFormCompanyResponseDTO>
      <PaymentFormCompanyResponseDTO>
        <NAME_COMPANY>sample string 2</NAME_COMPANY>
        <NUMBER_COMPANY>1</NUMBER_COMPANY>
        <NUMBER_PAYMENT_FORM>3</NUMBER_PAYMENT_FORM>
        <REG_NUMBER>1</REG_NUMBER>
        <REG_NUMBER_DIGIT>1</REG_NUMBER_DIGIT>
        <STATUS>sample string 4</STATUS>
      </PaymentFormCompanyResponseDTO>
    </PaymentFormCompanyResponseDTO>
    <SPECIE_PAYMENT_FORM>sample string 5</SPECIE_PAYMENT_FORM>
    <VALUE_MINIMUM_PAYMENT_FORM>1.1</VALUE_MINIMUM_PAYMENT_FORM>
  </PaymentFormResponseDTO>
</ArrayOfPaymentFormResponseDTO>

 

Este artigo foi útil para você?
Sim
Não
Confirmar que o artigo não foi útil