Create a refund

post

https://services.taxamo.com/api/v2/transactions/:key/refunds/

Create a refund

Authentication

Private token is required.

Examples

$ curl -X 'POST' 'https://services.taxamo.com/api/v2/transactions/T60YAAAABteWsHwfho8xUz1l4fuo/refunds?line_key=SQ0Kuuvp4P9VnEzq&private_token=priv_***********&total_amount=100'

{
    "total_amount": 100,
    "tax_amount":   16.67
}

Body Params

private_token

string

Private token.

key

string

required

Transaction key.

line_key

string

Line identifier. If neither line key or custom id is provided, the refund amount will be assigned to lines in order.

custom_id

string

Line custom identifier. If neither line key or custom id is provided, the refund amount will be assigned to lines in order.

refund_timestamp

string

Refund timestamp in yyyy-MM-dd HH:mm:ss or yyyy-MM-dd'T'HH:mm:ss'Z' format. No timezone conversion is applied.

amount

number

Amount (without tax) to be refunded. Either amount or total amount is required. In case of line key and custom id missing, only total_amount can be used.

total_amount

number

Total amount, including tax, to be refunded. Either amount or total amount is required. In case of line key and custom id missing, only total_amount can be used.

refund_reason

string

Refund reason, displayed on the credit note.

Response

Language

Response

Choose an example:

application/json

Authentication

Examples

200Success