Create refund intent

Creates a payment refund. This is the first step in making a refund transaction.

The refund can have two states:

  • Linked Refund: the parentIntentId field must be populated with a valid parent intent that the refund relates to
  • Unlinked refund: no parentIntentId field needs to be present.
Securityapi_key
Request
path Parameters
mid
required
string

Merchant Identifier.

Request Body schema: application/json
amount
required
number

The refund amount, it should not exceed the parent transaction's amount.

postbackUrl
required
string <uri>

The URL including any relevant path for returning information relating to the request, will be used for sending transaction complete requests.

merchantReference
string

A field where you can provide your own reference to send to the host

customerRef
string
Deprecated

Replaced by merchantReference. A field where you can provide your own reference to send to the host

manualCardEntry
boolean

If true, the terminal will not attempt to read a card and will instead prompt the user to enter the card details manually.

parentIntentId
string <uuid>

When performing a linked refund this field is required.

Responses
201
400

Bad payload.

401

Invalid API key/MID.

403

Forbidden from performing this action.

404

The intent to refund could not be found.

500
post/merchant/{mid}/intent/refund
Request samples
application/json
{
  • "amount": 100,
  • "postbackUrl": "http://example.com",
  • "merchantReference": "sale-10-10-2022",
  • "customerRef": "sale-10-10-2022",
  • "manualCardEntry": false,
  • "parentIntentId": "977e752c-43c3-4242-980f-81d18ca08185"
}
Response samples
application/json
{
  • "intentId": "uuid-uuid-uuid-uuid"
}