Reembolso

post

https://api.cryptomus.com/v1/payment/refund

CÓPIA DE

Solicitar

Parâmetros de consulta

Nome	Tipo de parâmetro	Definição
address*	string	O endereço para o qual o reembolso deve ser feito
is_subtract*	boolean	Se deve fazer uma comissão do saldo do comerciante ou do valor do reembolso true - Receba comissão do saldo do trader false - reduza o valor reembolsável pelo valor da comissão
uuid*	uuidrequired_without: order_id	Fatura uuid
order_id*	stringmin:1max:128alpha_dashrequired_without: uuid	ID do pedido da fatura

Tipo de parâmetro

string

Definição

O endereço para o qual o reembolso deve ser feito

Tipo de parâmetro

boolean

Definição

Se deve fazer uma comissão do saldo do comerciante ou do valor do reembolso true - Receba comissão do saldo do trader false - reduza o valor reembolsável pelo valor da comissão

Tipo de parâmetro

uuidrequired_without: order_id

Definição

Fatura uuid

Tipo de parâmetro

stringmin:1max:128alpha_dashrequired_without: uuid

Definição

ID do pedido da fatura

* - parâmetro obrigatório

Fatura é identificada por order_id ou uuid, se você passar os dois, a conta será identificada pelo UUID

Exemplo de solicitação


curl https://api.cryptomus.com/v1/payment/refund \
    -X POST \
    -H 'merchant: 8b03432e-385b-4670-8d06-064591096795' \
    -H 'sign: fe99035f86fa436181717b302b95bacff1' \
    -H 'Content-Type: application/json' \
    -d '{
            "uuid": "8b03432e-385b-4670-8d06-064591096795",
            "address": "TDD97yguPESTpcrJMqU6h2ozZbibv4Vaqm", 
            "is_subtract": "true"
        }'

CÓPIA DE

Resposta

Exemplo de resposta


1{
2  "state": 0,
3  "result": []
4}

CÓPIA DE

Possíveis erros

Erros de validação

código : 422

Exemplo de respostas:

Se a fatura com o uuid ou order_id que você forneceu não existir:


1{
2    "state": 1,
3    "message": "Payment was not found"
4}

CÓPIA DE

Se você não passar um uuid e order_id , você receberá esta mensagem. Isso significa que pelo menos um dos parâmetros é necessário.


1{
2	"state": 1,
3	"errors": {
4		"uuid": ["validation.required_without"],
5		"order_id": ["validation.required_without"]
6	}
7}

CÓPIA DE

Se os pagamentos estiverem bloqueados em seu comerciante, você receberá esta mensagem de erro. Isso acontece, por exemplo, quando você altera sua senha e os pagamentos estão bloqueados por 24 horas.


1{
2    "state": 1,
3    "message": "You are forbidden"
4}
5

CÓPIA DE

Se a carteira do comerciante conectada a uma fatura não existe:


1{
2    "state": 1,
3    "message": "Undefined merchant wallet"
4}

CÓPIA DE

Se a fatura não for finalizada ou não paga.


1{
2    "state": 1,
3    "message": "Refunds are made only for completed payments"
4}

CÓPIA DE

Se o valor a ser reembolsado exceder o valor do pagamento da fatura:


1{
2    "state": 1,
3    "message": "The refund amount should not be more than the amount paid"
4}

CÓPIA DE

Se ocorrer um trabalho técnico e o pagamento estiver temporariamente indisponível, você poderá receber esta mensagem de erro:


1{
2    "state": 1,
3    "message": "Server error"
4}

CÓPIA DE