DocumentaçãoReferência APIJourneyGitHub
Cadastro sandboxLogin sandboxen/us

4. Reembolsos

Aconteceu algum problema e precisará estornar a compra para o seu cliente? Sem problemas!

O Reembolso é a devolução de um pagamento para o consumidor. Por meio desta API é possível realizar reembolsos e consultar os detalhes de determinado reembolso.

Atributos

Nome, descrição e tipo

amount

Valores do reembolso. Em centavos. Ex: R$10,32 deve ser informado 1032. Obrigatório apenas caso deseje fazer um reembolso parcial.

structured

refundingInstrument

Meio de pagamento utilizado no reembolso.

structured,
obrigatório

├─method

Meio de pagamento. Valores possíveis: CREDIT_CARD, BANK_ACCOUNT, MOIP_ACCOUNT.

string,
obrigatório

├─creditCard

Cartão de crédito usado no reembolso.

object

├ ├─number

Número do cartão de crédito. (Necessário estar dentro do escopo PCI para enviar esse campo sem criptografia)

string(19)

├ ├─expirationMonth

Mês de expiração do cartão. (Necessário estar dentro do escopo PCI para enviar esse campo sem criptografia)

integer(2)

├ ├─expirationYear

Ano de expiração do cartão. (Necessário estar dentro do escopo PCI para enviar esse campo sem criptografia)

integer(4)

├ ├─cvc

Código de segurança do cartão. (Necessário estar dentro do escopo PCI para enviar esse campo sem criptografia)

integer

├ ├─holder

Portador do cartão.

structured,
obrigatório

├ ├ ├─fullname

Nome do portador impresso no cartão.

string(90),
obrigatório

├ ├ ├─birthDate

Data de nascimento do cliente.

date(AAAA-MM-DD), obrigatório

├ ├ ├─taxDocument

Documento fiscal.

structured,
obrigatório

├ ├ ├ ├─type

Tipo do documento. Valor possível: CPF.

string(3),
obrigatório

├ ├ ├ └─number

Número do documento.

string(11),
obrigatório

├ ├ ├─ phone

Telefone do cliente.

structured,
obrigatório

├ ├ ├ ├─countryCode

DDI (código internacional) do telefone. Valores possíveis: 55.

string(2),
obrigatório

├ ├ ├ ├─areaCode

DDD (código local) do telefone.

string(2),
obrigatório

├ ├ └ └─ number

Número do telefone.

string(9),
obrigatório

├ ├─billingAddress

Endereços de cobrança do cartão de crédito.

object

├ ├ ├─street

Logradouro do endereço.

string(140),

├ ├ ├─streetNumber

Número.

string(10),

├ ├ ├─complement

Complemento do endereço.

string(140)

├ ├ ├─district

Bairro.

string(45)

├ ├ ├─city

Cidade.

string(32)

├ ├ ├─state

Estado.

string(32)

├ ├ ├─country

País em formato ISO-alpha3, exemplo BRA

string(3),

├ └ └─zipCode

O CEP do endereço de cobrança.

string(8),

├─bankAccount

Conta bancária usada no reembolso.

object

├ ├─type

Tipo da conta. Valores possíveis: CHECKING (conta corrente), SAVING (conta poupança).

string,
obrigatório

├ ├─bankNumber

Número do banco (padrão Febraban).Ver lista de bancos e códigos FEBRABAN.

string,
obrigatório

├ ├─agencyNumber

Número da agência.

integer,
obrigatório

├ ├─agencyCheckNumber

Dígito verificador da agência.

integer,
obrigatório

├ ├─accountNumber

Número da conta.

integer,
obrigatório

├ ├─ accountCheckNumber

Dígito verificador da conta.

integer,
obrigatório

├ ├─holder

Titular da conta.

structured,
obrigatório

├ ├ ├─fullname

Nome do titular da conta.

string,
obrigatório

├ ├ ├─taxDocument

Documento fiscal do titular.

structured,
obrigatório

├ ├ ├─type

Tipo do documento. Valores possíveis: CPF, CNPJ.

string,
obrigatório

└ └ └─number

Número do documento.

integer,
obrigatório

👍

DICA

Caso queira fazer uma busca por pedidos reembolsados você pode usar Filtros de Busca. Abaixo um exemplo de endpoint para localizar os reembolsos:

GET
https://sandbox.moip.com.br/v2/orders?filters=status::in(REVERTED)

ATENÇÂO

O status REVERTED abrange tanto os pedidos reembolsados quanto aqueles que sofreram chargeback.

🚧

IMPORTANTE

1. Reembolso só pode ser realizado para conta bancária do mesmo titular do pagamento.

2. Pagamento só pode ser reembolsado no cartão de crédito no período inferior a 180 dias após autorização pagamento.

3. Pagamento feito por cartão de crédito deve ter reembolso via cartão de crédito.

4. O prazo do reembolso pode variar de 30 a 60 dias para constar na fatura do cliente dependendo do seu banco emissor. Nessa situação pode ocorrer do comprador contestar o pagamento direto no banco e com isso gerar um chargeback. Caso isso ocorra e se o cliente não utilizar nossa análise de risco, o chargeback será encerrado como estornado considerando que o reembolso já foi realizado. Isso significa que o pagamento ficará com status reembolsado e posteriormente estornado.

Atributos Response (resposta/callback)

Nome, descrição e tipo

id

Código (id Moip) identificado do Reembolso.

string(16)

status

Status do reembolso. Valores possíveis: REQUESTED, COMPLETED, FAILED.

string

amount

Valores do reembolso.

structured

├─fees

Valor da tarifa do reembolso.

integer(12)

├─currency

Moeda utilizada no pedido. Valores possíveis: BRL.

string

└─total

Total reembolsado. Em centavos. Ex: R$10,32 será informado 1032

integer(12)

type

Tipo do reembolso. Valores possíveis: FULL, PARTIAL.

string

creditCard

Cartão de crédito usado no reembolso.

object

├─brand

Bandeira do cartão. Valores possíveis: VISA, MASTERCARD, AMEX, DINERS, ELO, HIPER,HIPERCARD.

string

├─first6

Primeiros 6 dígitos do cartão.

string

├─last4

Últimos 4 dígitos do cartão.

string

moipAccount

Conta Moip usado no reembolso.

object

├─id

Id da conta.

string

events

Eventos do reembolso.

structured

├─createdAt

Data de criação do reembolso.

integer(12)

└─type

Tipo do reembolso. Valores possíveis: REFUND.REQUESTED, REFUND.WAITING, REFUND.FAILED, REFUND.COMPLETED.

string

createdAt

Data da criação do recurso.

datetime

_links

Estrutura de links Hypermedia (HATEOAS) do recurso.

structured

├─order

Referência para o Pedido.

structured

├ ├─title

Identificador do Pedido

string

├ └─href

Hyperlink para o Pedido.

link

├─payment

Referência para o Pagamento.

structured

├ ├─title

Identificador do Pagamento.

string

└ └─href

Hyperlink para o Pagamento.

link