Reembolso

post

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

COPIAR

Pedido

Parámetros de consulta

Nombre	Tipo de parámetro	Definición
address*	string	La dirección a la que se debe hacer el reembolso
is_subtract*	boolean	Si tomar una comisión del saldo del comerciante o del monto del reembolso true - Toma la comisión del saldo comercial false - Reducir el monto reembolsable por el monto de la comisión
uuid*	uuidrequired_without: order_id	Factura uuid
order_id*	stringmin:1max:128alpha_dashrequired_without: uuid	ID de orden de factura

Tipo de parámetro

string

Definición

La dirección a la que se debe hacer el reembolso

Tipo de parámetro

boolean

Definición

Si tomar una comisión del saldo del comerciante o del monto del reembolso true - Toma la comisión del saldo comercial false - Reducir el monto reembolsable por el monto de la comisión

Tipo de parámetro

uuidrequired_without: order_id

Definición

Factura uuid

Tipo de parámetro

stringmin:1max:128alpha_dashrequired_without: uuid

Definición

ID de orden de factura

* - parámetro obligatorio

La factura se identifica por order_id o uuid, si pasa ambos, la cuenta será identificada por UUID

Ejemplo de solicitud


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"
        }'

COPIAR

Respuesta

Ejemplo de respuesta


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

COPIAR

Posibles errores

Errores de validación

código : 422

Respuestas de ejemplo:

Si la factura con el uuid o order_id que proporcionó no existe:


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

COPIAR

Si no pasará un uuid y orden_id , recibirá este mensaje. Significa que se requiere al menos uno de los parámetros.


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

COPIAR

Si los pagos están bloqueados en su comerciante, recibirá este mensaje de error. Esto sucede, por ejemplo, cuando cambia su contraseña y los pagos están bloqueados durante 24 horas.


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

COPIAR

Si no existe una billetera comercial que esté conectada a una factura:


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

COPIAR

Si la factura no se finaliza o no se paga.


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

COPIAR

Si el monto que se reembolsará excede el monto del pago de la factura:


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

COPIAR

Si se produce un trabajo técnico y el pago no está disponible temporalmente, puede recibir este mensaje de error:


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

COPIAR