Refundacja
Wniosek
Parametry zapytania
| Nazwa | Typ parametru | Definicja |
|---|---|---|
| address* | string | Adres, na który należy dokonać zwrotu |
| is_subtract* | boolean | Czy wziąć prowizję z salda sprzedawcy, czy kwoty zwrotu True - Weź prowizję od salda handlowca false - Zmniejsz kwotę podlegającą zwrotowi przez kwotę Komisji |
| uuid* | uuidrequired_without: order_id | Faktura uuid |
| order_id* | stringmin:1max:128alpha_dashrequired_without: uuid | Identyfikator zamówienia faktury |
Typ parametru
stringDefinicja
Adres, na który należy dokonać zwrotuTyp parametru
booleanDefinicja
Czy wziąć prowizję z salda sprzedawcy, czy kwoty zwrotu True - Weź prowizję od salda handlowca false - Zmniejsz kwotę podlegającą zwrotowi przez kwotę KomisjiTyp parametru
uuidrequired_without: order_idDefinicja
Faktura uuidTyp parametru
stringmin:1max:128alpha_dashrequired_without: uuidDefinicja
Identyfikator zamówienia faktury
* - obowiązkowy parametr
Przykład żądania
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"
}'Odpowiedź
Przykład odpowiedzi
1{
2 "state": 0,
3 "result": []
4}Możliwe błędy
Błędy walidacji
kod : 422
Przykładowe odpowiedzi:
Jeśli faktura z dostarczonym uuid lub order_id nie istnieje:
1{
2 "state": 1,
3 "message": "Payment was not found"
4} Jeśli nie zdasz uuid i order_id , otrzymasz tę wiadomość. Oznacza to, że wymagane jest przynajmniej jeden z parametrów.
1{
2 "state": 1,
3 "errors": {
4 "uuid": ["validation.required_without"],
5 "order_id": ["validation.required_without"]
6 }
7}Jeśli wypłaty zostaną zablokowane na sprzedawcy, otrzymasz ten komunikat o błędzie. Dzieje się tak na przykład po zmianie hasła, a wypłaty są blokowane na 24 godziny.
1{
2 "state": 1,
3 "message": "You are forbidden"
4}
5Jeśli portfel handlowy jest podłączony do faktury, nie istnieje:
1{
2 "state": 1,
3 "message": "Undefined merchant wallet"
4}Jeśli faktura nie jest sfinalizowana lub nie zapłacona.
1{
2 "state": 1,
3 "message": "Refunds are made only for completed payments"
4}Jeśli kwota do zwrotu, przekracza kwotę płatności faktury:
1{
2 "state": 1,
3 "message": "The refund amount should not be more than the amount paid"
4}Jeśli nastąpi praca techniczna, a płatność jest tymczasowo niedostępna, możesz otrzymać ten komunikat o błędzie:
1{
2 "state": 1,
3 "message": "Server error"
4}