API Reference
Smartpay Home page日本語
Start typing to search…

Update a refund

patch
https://api.smartpay.co/v1/refunds/
Errors

In addition to the Errors applicable to all API endpoints, the following errors are specific to updating a refund:

status code error code description
404 refund.not-found No refund was found meeting the requirements. Make sure to use the right refundId and API key. test objects can only be accessed using test keys and live object with live keys.
Path Params
string
required
Defaults to refund_test_123456789

A valid refund ID

Body Params

Update Refund

string
length between 1 and 80

An arbitrary - ideally descriptive - long form explanation of the Refund, meant to be displayed to the customer.

metadata
object

Set of up to 20 key-value pairs that you can attach to the object.

string
length between 1 and 40

A - ideally unique - string to reference the Refund which can be used to reconcile the Refund with your internal systems.

Responses

Updated 7 months ago

Language
Credentials
Header
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 7 months ago