Refund a deposit

Refunds a completed deposit in full, returning the funds to the original payer.

POST /v1/operations/{operationId}/refund

cURL

customerRequest

curl --request POST \ --url https://api.sandbox.tracefinance.com/v1/operations/{operationId}/refund \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --header 'X-Idempotency-Key: <x-idempotency-key>' \ --data ' { "motive": { "code": "CUSTOMER_REQUEST", "message": "Customer requested the deposit be returned" } } '

202

Authorizations

Authorization · string · header · required

JWT bearer token. Include as Authorization: Bearer <token>. See the Authentication guide for how to obtain one.

Headers

X-Idempotency-Key · string<uuid> · required

Unique key to ensure idempotent request processing. Required on all POST, PUT, and PATCH requests.

X-Trace-Version · string

API version. Omit to use the default version.

Example:

"1"

Path Parameters

operationId · string<uuid> · required

UUID of the operation.

Body

application/json

Request to refund a completed deposit. The refund is always for the full deposit amount and returns the funds to the original payer.

motive · object · required

Why the deposit is being refunded. Recorded as the reason on the operation's REFUNDED state.

Show child attributes

Response

202

Refund accepted for processing. No response body. Poll GET /v1/operations/{operationId} to follow the deposit to REFUNDED.