Bunq · Schema

PaymentServiceProviderDraftPayment

Banking

Properties

Name	Type	Description
sender_iban	string	The IBAN of the sender.
sender_name	string	The name of the sender.
counterparty_iban	string	The IBAN of the counterparty.
counterparty_name	string	The name of the counterparty.
description	string	Description of the payment.
amount	object	The Amount to transfer with the Payment. Must be bigger than 0.
status	string	The new status of the Draft Payment. Can only be set to REJECTED or CANCELLED by update.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PaymentServiceProviderDraftPayment",
  "title": "PaymentServiceProviderDraftPayment",
  "type": "object",
  "properties": {
    "sender_iban": {
      "type": "string",
      "description": "The IBAN of the sender.",
      "readOnly": false,
      "writeOnly": false
    },
    "sender_name": {
      "type": "string",
      "description": "The name of the sender.",
      "readOnly": false,
      "writeOnly": true
    },
    "counterparty_iban": {
      "type": "string",
      "description": "The IBAN of the counterparty.",
      "readOnly": false,
      "writeOnly": true
    },
    "counterparty_name": {
      "type": "string",
      "description": "The name of the counterparty.",
      "readOnly": false,
      "writeOnly": true
    },
    "description": {
      "type": "string",
      "description": "Description of the payment.",
      "readOnly": false,
      "writeOnly": true
    },
    "amount": {
      "type": "object",
      "description": "The Amount to transfer with the Payment. Must be bigger than 0.",
      "readOnly": false,
      "writeOnly": false,
      "$ref": "#/components/schemas/Amount"
    },
    "status": {
      "type": "string",
      "description": "The new status of the Draft Payment. Can only be set to REJECTED or CANCELLED by update.",
      "readOnly": false,
      "writeOnly": false
    }
  },
  "required": [
    "sender_iban",
    "counterparty_iban",
    "counterparty_name",
    "description",
    "amount"
  ]
}