Generate a new refund from a deposit transaction

POST 
/api/refunds

Generate a new refund from a deposit transaction

Request

application/json

Body

required

value floatrequired

Value to be refunded

description description (string)

Description of the return

transaction_uuid transaction_uuid (string)required

Uuid of the transaction that should be refunded

merchant_id merchant_id (string)required

Field to use as identification purpose

Responses

201

Successful operation

application/json

Schema

Schema

status status (string)required

Possible values: [awaiting, failed]

Status about the refund

message message (string)

Description of the return

transaction_uuid transaction_uuid (string)

Uuid of the transaction that should be refunded

merchant_id merchant_id (string)

Field to use as identification purpose

Example (from schema)

{
  "status": "awaiting",
  "message": "Refund of funds",
  "transaction_uuid": "1a3259d0-f3b9-40dd-ab60-f594996a6453",
  "merchant_id": "refund_001"
}

400

Bad Request

401

Unauthenticated

application/json

Schema

Schema

message message (integer)

Response 401

Example (from schema)

{
  "message": "Invalid x-api-key"
}

403

Forbidden

404

Not Found

408

Request timeout

422

Unprocessable entity

application/json

Schema

Schema

message message (string)

Error message

errors undefined[]

Occurred errors during request data validation

Example (from schema)

{
  "message": "string",
  "errors": [
    null
  ]
}

500

Error

Loading...