Create a refund

post
Create invoice refund

https://business-sandbox.cryptopay.me/api/invoices/:invoice_id/refunds
This endpoint allows you to create invoice refund.
Request
Response
Headers
Authorization
required
string
HMAC using API key and signature
Content-Type
required
string
application/json
Date
required
string
Current date in HTTP-date format
Query Parameters
invoice_id
required
string
Invoice ID
address
optional
string
External wallet address. If not specified, the refund will be performed to your cryptocurrency account. The account currency will be the same as the currency of the received transaction
201: Created
{
"id": "36b4f740-6efa-4e89-b5ac-9cfceb05030c",
"custom_id": "637962007",
"invoice_id": "f956a2fb-5e5c-4e03-b588-2d9b65671412",
"amount": "0.0096664",
"amount_currency": "BTC",
"fee": "0.00009667",
"fee_currency": "BTC",
"address": null,
"txid": null,
"risk_score": null,
"created_at"=>"2019-05-02T15:26:12+00:00"
}

Response schema.

Parameter

Type

Description

id

string

Refund ID

custom_id

string

Refund custom_id. The value is being inherited from the parent invoice

invoice_id

string

Invoice ID

amount

string

Refund amount

amount_currency

string

Refund currency

fee

string

Processing fee

fee_currency

string

Processing fee currency

adress

string

Cryptocurrency address the refund transaction sent to

txid

string

Cryptocurrency transaction ID on the blockchain

risk_score

string

Cryptocurrency transaction risk score

created_at

string

Refund transaction creation date and time