{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/Payment",
"title": "Payment",
"type": "object",
"properties": {
"amount": {
"type": "object",
"description": "The Amount transferred by the Payment. Will be negative for outgoing Payments and positive for incoming Payments (relative to the MonetaryAccount indicated by monetary_account_id).",
"readOnly": false,
"writeOnly": false,
"$ref": "#/components/schemas/Amount"
},
"counterparty_alias": {
"type": "object",
"description": "The LabelMonetaryAccount containing the public information of the other (counterparty) side of the Payment.",
"readOnly": false,
"writeOnly": false,
"$ref": "#/components/schemas/LabelMonetaryAccount"
},
"description": {
"type": "string",
"description": "The description for the Payment. Maximum 140 characters for Payments to external IBANs, 9000 characters for Payments to only other bunq MonetaryAccounts.",
"readOnly": false,
"writeOnly": false
},
"attachment": {
"type": "array",
"description": "The Attachments attached to the Payment.",
"readOnly": false,
"writeOnly": false,
"items": {
"$ref": "#/components/schemas/AttachmentMonetaryAccountPayment"
}
},
"merchant_reference": {
"type": "string",
"description": "Optional data included with the Payment specific to the merchant.",
"readOnly": false,
"writeOnly": false
},
"allow_bunqto": {
"type": "boolean",
"description": "Whether or not sending a bunq.to payment is allowed.",
"readOnly": false,
"writeOnly": true
},
"id": {
"type": "integer",
"description": "The id of the created Payment.",
"readOnly": true,
"writeOnly": false
},
"created": {
"type": "string",
"description": "The timestamp when the Payment was done.",
"readOnly": true,
"writeOnly": false
},
"updated": {
"type": "string",
"description": "The timestamp when the Payment was last updated (will be updated when chat messages are received).",
"readOnly": true,
"writeOnly": false
},
"monetary_account_id": {
"type": "integer",
"description": "The id of the MonetaryAccount the Payment was made to or from (depending on whether this is an incoming or outgoing Payment).",
"readOnly": true,
"writeOnly": false
},
"alias": {
"type": "object",
"description": "The LabelMonetaryAccount containing the public information of 'this' (party) side of the Payment.",
"readOnly": true,
"writeOnly": false,
"$ref": "#/components/schemas/LabelMonetaryAccount"
},
"type": {
"type": "string",
"description": "The type of Payment, can be BUNQ, EBA_SCT, EBA_SDD, IDEAL, SWIFT or FIS (card).",
"readOnly": true,
"writeOnly": false
},
"sub_type": {
"type": "string",
"description": "The sub-type of the Payment, can be PAYMENT, WITHDRAWAL, REVERSAL, REQUEST, BILLING, SCT, SDD or NLO.",
"readOnly": true,
"writeOnly": false
},
"bunqto_status": {
"type": "string",
"description": "The status of the bunq.to payment.",
"readOnly": true,
"writeOnly": false
},
"bunqto_sub_status": {
"type": "string",
"description": "The sub status of the bunq.to payment.",
"readOnly": true,
"writeOnly": false
},
"bunqto_share_url": {
"type": "string",
"description": "The status of the bunq.to payment.",
"readOnly": true,
"writeOnly": false
},
"bunqto_expiry": {
"type": "string",
"description": "When bunq.to payment is about to expire.",
"readOnly": true,
"writeOnly": false
},
"bunqto_time_responded": {
"type": "string",
"description": "The timestamp of when the bunq.to payment was responded to.",
"readOnly": true,
"writeOnly": false
},
"batch_id": {
"type": "integer",
"description": "The id of the PaymentBatch if this Payment was part of one.",
"readOnly": true,
"writeOnly": false
},
"scheduled_id": {
"type": "integer",
"description": "The id of the JobScheduled if the Payment was scheduled.",
"readOnly": true,
"writeOnly": false
},
"address_shipping": {
"type": "object",
"description": "A shipping Address provided with the Payment, currently unused.",
"readOnly": true,
"writeOnly": false,
"$ref": "#/components/schemas/Address"
},
"address_billing": {
"type": "object",
"description": "A billing Address provided with the Payment, currently unused.",
"readOnly": true,
"writeOnly": false,
"$ref": "#/components/schemas/Address"
},
"geolocation": {
"type": "object",
"description": "The Geolocation where the Payment was done from.",
"readOnly": true,
"writeOnly": false,
"$ref": "#/components/schemas/Geolocation"
},
"request_reference_split_the_bill": {
"type": "array",
"description": "The reference to the object used for split the bill. Can be RequestInquiry or RequestInquiryBatch",
"readOnly": true,
"writeOnly": false,
"items": {
"$ref": "#/components/schemas/RequestInquiryReference"
}
},
"balance_after_mutation": {
"type": "object",
"description": "The new balance of the monetary account after the mutation.",
"readOnly": true,
"writeOnly": false,
"$ref": "#/components/schemas/Amount"
},
"payment_auto_allocate_instance": {
"type": "object",
"description": "A reference to the PaymentAutoAllocateInstance if it exists.",
"readOnly": true,
"writeOnly": false,
"$ref": "#/components/schemas/PaymentAutoAllocateInstance"
}
}
}