POST api/v2/pedido/setformapagamento
Request Information
URI Parameters
None.
Body Parameters
SetPagamentoV2BindingModelName | Description | Type | Additional information |
---|---|---|---|
PedidoId | integer |
None. |
|
CanalId | integer |
None. |
|
FormaDePagamento | FormaDePagamento |
None. |
|
EnderecoCobrancaId | integer |
None. |
|
TenantId | globally unique identifier |
None. |
|
PagSeguroSenderHash | string |
None. |
Request Formats
application/json, text/json
Sample:
{ "PedidoId": 1, "CanalId": 2, "FormaDePagamento": { "Codigo": 1, "Forma": "sample string 2", "Bandeira": "sample string 3", "TrocoPara": 1.0, "QuantidadeCheque": 1 }, "EnderecoCobrancaId": 1, "TenantId": "58ceb9af-a518-4765-9db4-589d6e6d5195", "PagSeguroSenderHash": "sample string 4" }
application/xml, text/xml
Sample:
<SetPagamentoV2BindingModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FormulaCertaAPI.Models.v2.BindingModels"> <CanalId>2</CanalId> <EnderecoCobrancaId>1</EnderecoCobrancaId> <FormaDePagamento> <Bandeira>sample string 3</Bandeira> <Codigo>1</Codigo> <Forma>sample string 2</Forma> <QuantidadeCheque>1</QuantidadeCheque> <TrocoPara>1</TrocoPara> </FormaDePagamento> <PagSeguroSenderHash>sample string 4</PagSeguroSenderHash> <PedidoId>1</PedidoId> <TenantId>58ceb9af-a518-4765-9db4-589d6e6d5195</TenantId> </SetPagamentoV2BindingModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
SetPagamentoResultName | Description | Type | Additional information |
---|---|---|---|
BoletoResult | BoletoResult |
None. |
|
Succeeded | boolean |
None. |
|
Errors | Collection of string |
None. |
Response Formats
application/json, text/json
Sample:
{ "BoletoResult": { "Assignor": "sample string 1", "BarCodeNumber": "sample string 2", "BoletoExpirationDate": "sample string 3", "BoletoNumber": "sample string 4", "BoletoUrl": "sample string 5", "Message": "sample string 6", "Amount": 7, "BraspagTransactionId": "513fa1a7-efbb-4ff1-9c3d-5115b40f0392", "PaymentMethod": 9 }, "Succeeded": true, "Errors": [ "sample string 1", "sample string 2" ] }
application/xml, text/xml
Sample:
<SetPagamentoResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FormulaCertaAPI.Models"> <Errors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </Errors> <Succeeded>true</Succeeded> <BoletoResult xmlns:d2p1="http://schemas.datacontract.org/2004/07/FormulaCertaAPI.Pagamento"> <d2p1:Amount>7</d2p1:Amount> <d2p1:Assignor>sample string 1</d2p1:Assignor> <d2p1:BarCodeNumber>sample string 2</d2p1:BarCodeNumber> <d2p1:BoletoExpirationDate>sample string 3</d2p1:BoletoExpirationDate> <d2p1:BoletoNumber>sample string 4</d2p1:BoletoNumber> <d2p1:BoletoUrl>sample string 5</d2p1:BoletoUrl> <d2p1:BraspagTransactionId>513fa1a7-efbb-4ff1-9c3d-5115b40f0392</d2p1:BraspagTransactionId> <d2p1:Message>sample string 6</d2p1:Message> <d2p1:PaymentMethod>9</d2p1:PaymentMethod> </BoletoResult> </SetPagamentoResult>