Pay
Instructions
Pay
Instructions
Instructions determine how the payment has or should be made.
Schema ID
https://gobl.org/draft-0/pay/instructions
Properties
| Title | Property | Type | Req. | Description |
|---|---|---|---|---|
| Key | key | cbc.Key | true | The payment means expected or that have been arranged to be used to make the payment. |
| Detail | detail | string | Optional text description of the payment method | |
| Reference | ref | string | Remittance information or concept, a text value used to link the payment with the invoice. | |
| Credit Transfer | credit_transfer | array of pay.CreditTransfer | Instructions for sending payment via a bank transfer. | |
| Card | card | pay.Card | Details of the payment that will be made via a credit or debit card. | |
| Direct Debit | direct_debit | pay.DirectDebit | A group of terms that can be used by the customer or payer to consolidate direct debit payments. | |
| Online | online | array of pay.Online | Array of online payment options | |
| Notes | notes | string | Any additional instructions that may be required to make the payment. | |
| Extensions | ext | tax.Extensions | Extension key-pairs values defined by a tax regime. | |
| Meta | meta | cbc.Meta | Non-structured additional data that may be useful. |
Key Values
| Value | Description |
|---|---|
any | Any method available, no preference. |
card | Payment card. |
credit-transfer | Sender initiated bank or wire transfer. |
debit-transfer | Receiver initiated bank or wire transfer. |
cash | Cash in hand. |
cheque | Cheque from bank. |
bank-draft | Bankers Draft or Bank Cheque. |
direct-debit | Direct debit from the customers bank account. |
online | Online or web payment. |
promissory-note | Promissory note contract. |
netting | Intercompany clearing or clearing between partners. |
other | Other or mutually defined means of payment. |