Adyen · Schema

ReturnTransferRequest

ReturnTransferRequest schema from Adyen API

PaymentsFinancial ServicesFintech

Properties

Name Type Description
amount object Contains information about the amount to be returned.
reference string Your internal reference for the return. If you don't provide this in the request, Adyen generates a unique reference. This reference is used in all communication with you about the instruction status.
View JSON Schema on GitHub

JSON Schema

transfers-return-transfer-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/adyen/refs/heads/main/json-schema/transfers-return-transfer-request-schema.json",
  "title": "ReturnTransferRequest",
  "description": "ReturnTransferRequest schema from Adyen API",
  "type": "object",
  "properties": {
    "amount": {
      "description": "Contains information about the amount to be returned.",
      "$ref": "#/components/schemas/Amount"
    },
    "reference": {
      "description": "Your internal reference for the return. If you don't provide this in the request, Adyen generates a unique reference. This reference is used in all communication with you about the instruction status.\n\nWe recommend using a unique value per instruction.\nIf you need to provide multiple references for a transaction, separate them with hyphens (\"-\").\n",
      "maxLength": 80,
      "type": "string"
    }
  },
  "required": [
    "amount"
  ]
}