URL Expired

The URL for this request expired after 30 days.

account_id

string

required

ID of the Account

Body of request to create refund.

effective_at

date-time

The Date-Time that the refund is made applicable to the account. Although a refund may be made today, it can be set effective 10 days prior.

line_item_id

string

The ID associated to be with the line item for future requests. If not provided on line item creation, Canopy will generate this field.

line_item_status

string

enum

Defaults to VALID

The status of a line item.

VALIDINVALIDOFFSETPENDINGAUTHORIZEDDECLINEDVOIDPOSTED

Show 8 enum values

original_amount_cents

integer

required

Defaults to 0

The amount to be refunded (in cents).

merchant_data

object | null

merchant_dataobject | null

external_fields

array,null | object,null

external_fieldsarray,null | object,null

``200 Refund Created

``401

Unauthorized.

``403

Forbidden.

``422

Invalid input

``429

Too many requests.

``default

Unexpected Error.

Updated about 1 year ago

ShellNodeRubyPHPPython

Bearer

Base URL

https://Contact sales to enable your sandbox/accounts/{account_id}/line_items/refunds

xxxxxxxxxx

curl --request POST \

--url https://contact/%20sales%20to%20enable%20your%20sandbox/accounts//line_items/refunds \

--header 'accept: application/json' \

--header 'content-type: application/json' \

--data '

{

"line_item_status": "VALID",

"original_amount_cents": 0

}

'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

``200

Updatedabout 1 year ago