Contract Refund

post

https://sbx-origination.heidipay.io/api/checkout/v1/refund/

An endpoint that accepts an request for a refund on a given contract.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

external_uuid

uuid

required

The UUID of the contract to be refunded.

amount

string

required

Amount to be refunded

amount_format

string

enum

Defaults to DECIMAL

The format of the amount provided. MINOR_UNIT = amount is an integer of the minor unit of the currency. eg 1000 is 10CHF. DECIMAL = Decimal representation as string. e.g. "10.00" is 10CHF

MINOR_UNIT - MINOR_UNIT
DECIMAL - DECIMAL

Allowed:

external_reference

string

length ≤ 128

An optional reference that will be stored with the refund transaction.

currency

string

required

length between 1 and 10

The currency to refund.

Headers

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

Language

Credentials

Bearer

JWT

Loading…

Response

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

application/json

200

500