API Reference

Criar e pagar com SDWO

Esse guia descreve como criar e pagar um pedido para carteiras digitais escalonadas (SDWO), sendo possível realizar esses pedidos nas modalidades de purchase (compra simultânea) ou transferência de valores (pagamento de boletos, recarga de carteira, transferência entre contas).

Cadastros junto as bandeiras

É importante pontuar que para utilizar SDWO é obrigatório ter um cadastro junto as bandeiras, correlacionando carteiras e adquirente. Clientes que já integram em outros adquirentes necessitam realizar um novo cadastro para integrar com o Pagbank, entre em contato com suporte Pagbank e tenha mais informações.

📘

Bandeira Elo

Além de compartilhar o Wallet Id, você também deve compartilhar o ID de facilitadores de pagamento ao usar a bandeira Elo.

Crie o pedido

De posse dos dados do cartão e do pedido, você pode criar o pedido utilizando o endpoint Criar pedido.

Para realizar a requisição ao endpoint Criar pedido, você precisa fornecer no corpo da requisição os dados descritos no Objeto Order. Os dados do pagamento devem ser adicionados ao objeto charge. A página Objeto Charge descreve em detalhes cada um dos parâmetros que devem ser incluídos.

Para transações de DWO se faz necessário o envio do objeto dwo e seus respectivos sub-objetos, que podem sofrer impactos conforme o tipo de transação.

ParâmetroDescrição
charges.dwo.typeTipo de carteira, para esse tipo de transação sempre será "STAGED_DIGITAL_WALLET"
charges.dwo.mccMCC da transação que irá variar conforme a operação realizada.
charges.dwo.tax_idDocumento de identificação do dono da carteira (CPF ou CNPJ).

📘

Regras sobre os valores do campo type

Mastercard

  • Transferência de valores: Utilizar o tipo conforme a operação que será executada:
    • SDW_ME2ME (Recarga da carteira do usuário dono do cartão)
    • SDW_P2P (Transferência de valores para outra carteira de portador diferente do dono do cartão)
    • SDW_OTHER_ARRANGEMENT (Envio de valores realizando a mudança de arranjo, PIX, TED...)
    • SDW_IDENTIFIED_BOLETO (Pagamento de boletos identificados, onde se tem os dados do recebedor)
    • SDW_UNIDENTIFIED_BOLETO (Pagamento de boletos não identificados, onde não se tem os dados do recebedor)
  • Purchase: Utilizar sempre o valor SDW_PURCHASE

Elo

  • Transferência de valores: Utilizar sempre o valor SDW_ME2ME
  • Purchase: Utilizar sempre o valor SDW_PURCHASE

Visa

  • Transferência de valores: STAGED_DIGITAL_WALLET
  • Purchase: Utilizar sempre o valor SDW_PURCHASE

Para transações de Purchase são obrigatórios os dados do sub_merchant da transação:

ParâmetroDescrição
charges.dwo.sub_merchant.idId do Sub_Merchant no cadastro da Carteira.
charges.dwo.sub_merchant.nameNome do Sub_Merchant no cadastro da Carteira.
charges.dwo.sub_merchant.addressObjeto com os dados do endereço do subcomerciante.
charges.dwo.submerchant.phonesObjeto com os dados do endereço do subcomerciante.

Para transações de Transferência de valores são obrigatórios os dados do receiver:

ParâmetroDescrição
charges.dwo.receiver.nameNome do proprietário da carteira.
charges.dwo.receiver.tax_idCPF ou CNPJ do proprietário da carteira.
charges.dwo.receiver.account_numberIdentificador da conta para onde os fundos serão enviados (chave pix, id da wallet, id da conta bancária, IBAN, other).
charges.dwo.receiver.account_number_typeTipificação do identificador da conta (OTHER, RTN_BANK_ACCOUNT, IBAN, CARD_ACCOUNT, EMAIL, PHONE_NUMBER, BAN_BIC, WALLET_ID, SOCIAL_NETWORK_ID).

📘

Para transações do tipo SDW_UNIDENTIFIED_BOLETO os dados do recebedor podem não ser obtidos durante a transação. Portanto, para esse tipo de transação, os dados do receiver são opcionais.

📘

Nas transações com a bandeira Visa, é obrigatório enviar o parâmetro charges.dwo.cash_in. Não é necessário incluir os dados do recebedor.

Os dados do cartão utilizado no pagamento devem ser adicionados ao objeto charges.payment_method.

O envio dos dados do titular do cartão é obrigatório, pois essas informações são utilizadas pela bandeira para validações:

ParâmetroDescrição
charges.payment_method.card.holder.nameNome do dono do cartão.
charges.payment_method.card.holder.tax_idDocumento do dono do cartão (CPF, ou CNPJ).

Exemplo de Purchase

Para transações de Purchase é obrigatório realizar o envio do MCC referente ao sub-merchant da transação O MCC nesse cenário é variável, dependendo do produto ou serviço comercializado.

Abaixo você encontra um exemplo de requisição e resposta ao endpoint Criar pedido.

curl --location --request POST 'https: //sandbox.api.pagseguro.com/orders' \
--header 'Authorization: Bearer {
  {token
  }
}' \
--header 'Content-Type: application/json' \
--data-raw '{
  "reference_id": "ex-00001",
  "customer": {
    "name": "Jose da Silva",
    "email": "[email protected]",
    "tax_id": "12345678909",
    "phones": [
      {
        "country": "55",
        "area": "11",
        "number": "999999999",
        "type": "MOBILE"
      }
    ]
  },
  "items": [
    {
      "reference_id": "referencia do item",
      "name": "nome do item",
      "quantity": 1,
      "unit_amount": 500
    }
  ],
  "shipping": {
    "address": {
      "street": "Avenida Brigadeiro Faria Lima",
      "number": "1384",
      "complement": "apto 12",
      "locality": "Pinheiros",
      "city": "São Paulo",
      "region_code": "SP",
      "country": "BRA",
      "postal_code": "01452002"
    }
  },
  "notification_urls": [
    "https://meusite.com/notificacoes"
  ],
  "charges": [
    {
      "reference_id": "ex-00001",
      "description": "motivo da cobrança",
      "amount": {
        "value": 10526,
        "currency": "BRL"
      },
      "payment_method": {
        "type": "CREDIT_CARD",
        "installments": 2,
        "capture": true,
        "card": {
          "store": true,
          "number": "4111111111111111",
          "exp_month": "03",
          "exp_year": "2026",
          "security_code": "123",
          "holder": {
            "name": "Jose da Silva",
			"tax_id": "42167200803"
          }
        }
      },
      "dwo": {
        "type": "SDW_PURCHASE",
        "mcc": "1234",
        "tax_id": "42167200803",
        "sub_merchant": {
          "id": "123",
          "name": "abc",
          "address": {
            "postal_code": "99054440",
            "street": "SUB RUA HELENA PS4",
            "number": "127",
            "city": "SAO PAULO",
            "region_code": "SP",
            "region": "Sao Paulo",
            "country": "BRA",
            "complement": "Apto 16",
            "locality": "Pinheiros"
          },
          "phones": [
            {
              "country": "55",
              "area": "11",
              "number": "965438314",
              "type": "MOBILE"
            }
          ]
        }
      },
      "notification_urls": [
        "https://yourserver.com/nas_ecommerce/277be731-3b7c-4dac-8c4e-4c3f4a1fdc46/"
      ]
    }
  ]
}'

{
  "id": "ORDE_3F3EA44E-6A82-4D52-BC23-94DF2096A1FD",
  "reference_id": "ex-00001",
  "created_at": "2023-02-08T17:44:34.959-03:00",
  "customer": {
    "name": "Jose da Silva",
    "email": "[email protected]",
    "tax_id": "12345678909",
    "phones": [
      {
        "type": "MOBILE",
        "country": "55",
        "area": "11",
        "number": "999999999"
      }
    ]
  },
  "items": [
    {
      "reference_id": "referencia do item",
      "name": "nome do item",
      "quantity": 1,
      "unit_amount": 500
    }
  ],
  "shipping": {
    "address": {
      "street": "Avenida Brigadeiro Faria Lima",
      "number": "1384",
      "complement": "apto 12",
      "locality": "Pinheiros",
      "city": "São Paulo",
      "region_code": "SP",
      "country": "BRA",
      "postal_code": "01452002"
    }
  },
  "charges": [
    {
      "id": "CHAR_FE98711C-8BB9-416C-A943-536F32C5CAAE",
      "reference_id": "ex-00001",
      "status": "PAID",
      "created_at": "2023-08-25T11:08:52.900-03:00",
      "description": "motivo da cobrança",
      "amount": {
        "value": 500,
        "currency": "BRL",
        "summary": {
          "total": 500,
          "paid": 0,
          "refunded": 0
        }
      },
      "payment_response": {
        "code": "20000",
        "message": "SUCESSO",
		"reference": "ex-00001"
      },
      "payment_method": {
        "type": "CREDIT_CARD",
        "installments": 2,
        "capture": false,
        "card": {
          "id": "CARD_495F7673-E200-468C-9AD7-50017BCC81A9",
          "brand": "visa",
          "first_digits": "411111",
          "last_digits": "1111",
          "exp_month": "3",
          "exp_year": "2026",
          "holder": {
            "name": "Jose da Silva",
			"tax_id": "42167200803"
          },
          "store": true
        },
        "soft_descriptor": "Teste001"
      },
      "dwo": {
        "type": "SDW_PURCHASE",
        "mcc": "1234",
        "tax_id": "42167200803",
        "sub_merchant": {
          "id": "123",
          "name": "abc",
          "address": {
            "postal_code": "99054440",
            "street": "SUB RUA HELENA PS4",
            "number": "127",
            "city": "SAO PAULO",
            "region_code": "SP",
            "region": "Sao Paulo",
            "country": "BRA",
            "complement": "Apto 16",
            "locality": "Pinheiros"
          },
          "phones": [
            {
              "country": "55",
              "area": "11",
              "number": "965438314",
              "type": "MOBILE"
            }
          ]
        }
      },
      "notification_urls": [
        "https://yourserver.com/nas_ecommerce/277be731-3b7c-4dac-8c4e-4c3f4a1fdc46/"
      ],
}

Exemplo de Transferência de Valores

Para transações de Transferência de Valores, o MCC da transação poderá sofrer variações de acordo com o tipo e a bandeira utilizada na transação:

  • Mastercard
    • MCC 6540 (ME2ME, P2P, OTHER_ARRANGEMENT, UNIDENTIFIED_BOLETO).
    • MCC do recebedor dos valores (IDENTIFIED_BOLETO).
  • Visa
    • MCC 6051 (ME2ME).
  • Elo
    • MCC 6540 (ME2ME).

Abaixo você encontra exemplos de requisição e resposta ao endpoint Criar pedido.

curl --location --request POST 'https: //sandbox.api.pagseguro.com/orders' \
--header 'Authorization: Bearer {
  {token
  }
}' \
--header 'Content-Type: application/json' \
--data-raw '{
  "reference_id": "ex-00001",
  "customer": {
    "name": "Jose da Silva",
    "email": "[email protected]",
    "tax_id": "12345678909",
    "phones": [
      {
        "country": "55",
        "area": "11",
        "number": "999999999",
        "type": "MOBILE"
      }
    ]
  },
  "items": [
    {
      "reference_id": "referencia do item",
      "name": "nome do item",
      "quantity": 1,
      "unit_amount": 500
    }
  ],
  "shipping": {
    "address": {
      "street": "Avenida Brigadeiro Faria Lima",
      "number": "1384",
      "complement": "apto 12",
      "locality": "Pinheiros",
      "city": "São Paulo",
      "region_code": "SP",
      "country": "BRA",
      "postal_code": "01452002"
    }
  },
  "notification_urls": [
    "https://meusite.com/notificacoes"
  ],
  "charges": [
    {
      "reference_id": "ex-00001",
      "description": "motivo da cobrança",
      "amount": {
        "value": 10526,
        "currency": "BRL"
      },
      "payment_method": {
        "type": "CREDIT_CARD",
        "installments": 2,
        "capture": true,
        "card": {
          "store": true,
          "number": "4111111111111111",
          "exp_month": "03",
          "exp_year": "2026",
          "security_code": "123",
          "holder": {
            "name": "Jose da Silva",
            "tax_id": "42167200803"
          }
        }
      },
      "dwo": {
        "type": "SDW_ME2ME",
        "mcc": "6540",
        "tax_id": "42167200803",
        "receiver": { 
          "name": "Jose da Silva", 
          "tax_id": "42167200803", 
          "account_number": "123456789", 
          "account_number_type": "WALLET_ID" }
      }
      "notification_urls": [
        "https://yourserver.com/nas_ecommerce/277be731-3b7c-4dac-8c4e-4c3f4a1fdc46/"
      ]
    }
  ]
}'


{
  "id": "ORDE_3F3EA44E-6A82-4D52-BC23-94DF2096A1FD",
  "reference_id": "ex-00001",
  "created_at": "2023-02-08T17:44:34.959-03:00",
  "customer": {
    "name": "Jose da Silva",
    "email": "[email protected]",
    "tax_id": "12345678909",
    "phones": [
      {
        "type": "MOBILE",
        "country": "55",
        "area": "11",
        "number": "999999999"
      }
    ]
  },
  "items": [
    {
      "reference_id": "referencia do item",
      "name": "nome do item",
      "quantity": 1,
      "unit_amount": 500
    }
  ],
  "shipping": {
    "address": {
      "street": "Avenida Brigadeiro Faria Lima",
      "number": "1384",
      "complement": "apto 12",
      "locality": "Pinheiros",
      "city": "São Paulo",
      "region_code": "SP",
      "country": "BRA",
      "postal_code": "01452002"
    }
  },
  "charges": [
    {
      "id": "CHAR_FE98711C-8BB9-416C-A943-536F32C5CAAE",
      "reference_id": "ex-00001",
      "status": "PAID",
      "created_at": "2023-08-25T11:08:52.900-03:00",
      "description": "motivo da cobrança",
      "amount": {
        "value": 500,
        "currency": "BRL",
        "summary": {
          "total": 500,
          "paid": 0,
          "refunded": 0
        }
      },
      "payment_response": {
        "code": "20000",
        "message": "SUCESSO",
		"reference": "ex-00001"
      },
      "payment_method": {
        "type": "CREDIT_CARD",
        "installments": 2,
        "capture": false,
        "card": {
          "id": "CARD_495F7673-E200-468C-9AD7-50017BCC81A9",
          "brand": "mastercard",
          "first_digits": "411111",
          "last_digits": "1111",
          "exp_month": "3",
          "exp_year": "2026",
          "holder": {
            "name": "Jose da Silva",
			"tax_id": "42167200803"
          },
          "store": true
        },
        "soft_descriptor": "Teste001"
      },
      "dwo": {
        "type": "SDW_ME2ME",
        "mcc": "6540",
        "tax_id": "42167200803",
        "receiver": { 
          "name": "Jose da Silva", 
          "tax_id": "42167200803", 
          "account_number": "123456789", 
          "account_number_type": "WALLET_ID" }
      }
      },
      "notification_urls": [
        "https://yourserver.com/nas_ecommerce/277be731-3b7c-4dac-8c4e-4c3f4a1fdc46/"
      ],
}


curl --location --request POST 'https: //sandbox.api.pagseguro.com/orders' \
--header 'Authorization: Bearer {
  {token
  }
}' \
--header 'Content-Type: application/json' \
--data-raw '{
  "reference_id": "ex-00001",
  "customer": {
    "name": "Jose da Silva",
    "email": "[email protected]",
    "tax_id": "12345678909",
    "phones": [
      {
        "country": "55",
        "area": "11",
        "number": "999999999",
        "type": "MOBILE"
      }
    ]
  },
  "items": [
    {
      "reference_id": "referencia do item",
      "name": "nome do item",
      "quantity": 1,
      "unit_amount": 500
    }
  ],
  "shipping": {
    "address": {
      "street": "Avenida Brigadeiro Faria Lima",
      "number": "1384",
      "complement": "apto 12",
      "locality": "Pinheiros",
      "city": "São Paulo",
      "region_code": "SP",
      "country": "BRA",
      "postal_code": "01452002"
    }
  },
  "notification_urls": [
    "https://meusite.com/notificacoes"
  ],
  "charges": [
    {
      "reference_id": "ex-00001",
      "description": "motivo da cobrança",
      "amount": {
        "value": 10526,
        "currency": "BRL"
      },
      "payment_method": {
        "type": "CREDIT_CARD",
        "installments": 2,
        "capture": true,
        "card": {
          "store": true,
          "number": "4111111111111111",
          "exp_month": "03",
          "exp_year": "2026",
          "security_code": "123",
          "holder": {
            "name": "Jose da Silva",
            "tax_id": "42167200803"
          }
        }
      },
      "dwo": {
        "type": "STAGED_DIGITAL_WALLET",
        "mcc": "6051",
        "tax_id": "42167200803",
        “cash_in”: “true”
      }
      "notification_urls": [
        "https://yourserver.com/nas_ecommerce/277be731-3b7c-4dac-8c4e-4c3f4a1fdc46/"
      ]
    }
  ]
}'


{
  "id": "ORDE_3F3EA44E-6A82-4D52-BC23-94DF2096A1FD",
  "reference_id": "ex-00001",
  "created_at": "2023-02-08T17:44:34.959-03:00",
  "customer": {
    "name": "Jose da Silva",
    "email": "[email protected]",
    "tax_id": "12345678909",
    "phones": [
      {
        "type": "MOBILE",
        "country": "55",
        "area": "11",
        "number": "999999999"
      }
    ]
  },
  "items": [
    {
      "reference_id": "referencia do item",
      "name": "nome do item",
      "quantity": 1,
      "unit_amount": 500
    }
  ],
  "shipping": {
    "address": {
      "street": "Avenida Brigadeiro Faria Lima",
      "number": "1384",
      "complement": "apto 12",
      "locality": "Pinheiros",
      "city": "São Paulo",
      "region_code": "SP",
      "country": "BRA",
      "postal_code": "01452002"
    }
  },
  "charges": [
    {
      "id": "CHAR_FE98711C-8BB9-416C-A943-536F32C5CAAE",
      "reference_id": "ex-00001",
      "status": "PAID",
      "created_at": "2023-08-25T11:08:52.900-03:00",
      "description": "motivo da cobrança",
      "amount": {
        "value": 500,
        "currency": "BRL",
        "summary": {
          "total": 500,
          "paid": 0,
          "refunded": 0
        }
      },
      "payment_response": {
        "code": "20000",
        "message": "SUCESSO",
		"reference": "ex-00001"
      },
      "payment_method": {
        "type": "CREDIT_CARD",
        "installments": 2,
        "capture": false,
        "card": {
          "id": "CARD_495F7673-E200-468C-9AD7-50017BCC81A9",
          "brand": "visa",
          "first_digits": "411111",
          "last_digits": "1111",
          "exp_month": "3",
          "exp_year": "2026",
          "holder": {
            "name": "Jose da Silva",
			"tax_id": "42167200803"
          },
          "store": true
        },
        "soft_descriptor": "Teste001"
      },
      "dwo": {
        "type": "STAGED_DIGITAL _WALLET",
        "mcc": "6051",
        "tax_id": "42167200803",
        "cash_in": “true”
 }
      },
      "notification_urls": [
        "https://yourserver.com/nas_ecommerce/277be731-3b7c-4dac-8c4e-4c3f4a1fdc46/"
      ],
}



curl --location --request POST 'https: //sandbox.api.pagseguro.com/orders' \
--header 'Authorization: Bearer {
  {token
  }
}' \
--header 'Content-Type: application/json' \
--data-raw '{
  "reference_id": "ex-00001",
  "customer": {
    "name": "Jose da Silva",
    "email": "[email protected]",
    "tax_id": "12345678909",
    "phones": [
      {
        "country": "55",
        "area": "11",
        "number": "999999999",
        "type": "MOBILE"
      }
    ]
  },
  "items": [
    {
      "reference_id": "referencia do item",
      "name": "nome do item",
      "quantity": 1,
      "unit_amount": 500
    }
  ],
  "shipping": {
    "address": {
      "street": "Avenida Brigadeiro Faria Lima",
      "number": "1384",
      "complement": "apto 12",
      "locality": "Pinheiros",
      "city": "São Paulo",
      "region_code": "SP",
      "country": "BRA",
      "postal_code": "01452002"
    }
  },
  "notification_urls": [
    "https://meusite.com/notificacoes"
  ],
  "charges": [
    {
      "reference_id": "ex-00001",
      "description": "motivo da cobrança",
      "amount": {
        "value": 10526,
        "currency": "BRL"
      },
      "payment_method": {
        "type": "CREDIT_CARD",
        "installments": 2,
        "capture": true,
        "card": {
          "store": true,
          "number": "4111111111111111",
          "exp_month": "03",
          "exp_year": "2026",
          "security_code": "123",
          "holder": {
            "name": "Jose da Silva",
            "tax_id": "42167200803"
          }
        }
      },
      "dwo": {
        "type": "SDW_ME2ME",
        "mcc": "6540",
        "tax_id": "42167200803",
        "receiver": { 
          "name": "Jose da Silva", 
          "tax_id": "42167200803", 
          "account_number": "123456789", 
          "account_number_type": "WALLET_ID" }
      }
      "notification_urls": [
        "https://yourserver.com/nas_ecommerce/277be731-3b7c-4dac-8c4e-4c3f4a1fdc46/"
      ]
    }
  ]
}'


{
  "id": "ORDE_3F3EA44E-6A82-4D52-BC23-94DF2096A1FD",
  "reference_id": "ex-00001",
  "created_at": "2023-02-08T17:44:34.959-03:00",
  "customer": {
    "name": "Jose da Silva",
    "email": "[email protected]",
    "tax_id": "12345678909",
    "phones": [
      {
        "type": "MOBILE",
        "country": "55",
        "area": "11",
        "number": "999999999"
      }
    ]
  },
  "items": [
    {
      "reference_id": "referencia do item",
      "name": "nome do item",
      "quantity": 1,
      "unit_amount": 500
    }
  ],
  "shipping": {
    "address": {
      "street": "Avenida Brigadeiro Faria Lima",
      "number": "1384",
      "complement": "apto 12",
      "locality": "Pinheiros",
      "city": "São Paulo",
      "region_code": "SP",
      "country": "BRA",
      "postal_code": "01452002"
    }
  },
  "charges": [
    {
      "id": "CHAR_FE98711C-8BB9-416C-A943-536F32C5CAAE",
      "reference_id": "ex-00001",
      "status": "PAID",
      "created_at": "2023-08-25T11:08:52.900-03:00",
      "description": "motivo da cobrança",
      "amount": {
        "value": 500,
        "currency": "BRL",
        "summary": {
          "total": 500,
          "paid": 0,
          "refunded": 0
        }
      },
      "payment_response": {
        "code": "20000",
        "message": "SUCESSO",
		"reference": "ex-00001"
      },
      "payment_method": {
        "type": "CREDIT_CARD",
        "installments": 2,
        "capture": false,
        "card": {
          "id": "CARD_495F7673-E200-468C-9AD7-50017BCC81A9",
          "brand": "elo",
          "first_digits": "411111",
          "last_digits": "1111",
          "exp_month": "3",
          "exp_year": "2026",
          "holder": {
            "name": "Jose da Silva",
			"tax_id": "42167200803"
          },
          "store": true
        },
        "soft_descriptor": "Teste001"
      },
      "dwo": {
        "type": "SDW_ME2ME",
        "mcc": "6540",
        "tax_id": "42167200803",
        "receiver": { 
          "name": "Jose da Silva", 
          "tax_id": "42167200803", 
          "account_number": "123456789", 
          "account_number_type": "WALLET_ID" }
      }
      },
      "notification_urls": [
        "https://yourserver.com/nas_ecommerce/277be731-3b7c-4dac-8c4e-4c3f4a1fdc46/"
      ],
}

© 1996- Todos os direitos reservados.

PAGSEGURO INTERNET INSTITUIÇÃO DE PAGAMENTO S/A - CNPJ/MF 08.561.701/0001-01

Av. Brigadeiro Faria Lima, 1.384, São Paulo - SP - CEP 01451-001