@@ -298,14 +298,30 @@ export type BillingRequest = {
298298 // up to 50 characters and values up to 500 characters.
299299 metadata ?: JsonMap ;
300300
301+ // Specifies the context or scenario in which the payment is being made.
302+ // Defines whether the payment is for advance/arrears billing, point of sale
303+ // transactions, ecommerce, or account transfers. This helps banks and payment
304+ // processors understand the payment scenario and apply appropriate processing
305+ // rules and risk controls.
306+ payment_context_code ?: BillingRequestPaymentContextCode ;
307+
308+ // Specifies the underlying purpose of the payment. Defines the specific
309+ // reason or type of service/goods the payment relates to, improving
310+ // straight-through processing and compliance.
311+ // See [VRP Commercial Payment Purpose
312+ // Codes](https://developer.gocardless.com/vrp-commercial-payment-purpose-codes/)
313+ // for the complete list of valid codes.
314+ payment_purpose_code ?: string ;
315+
301316 // Request for a one-off strongly authorised payment
302317 payment_request ?: BillingRequestPaymentRequest ;
303318
304- // Specifies the high-level purpose of a mandate and/or payment using a set of
305- // pre-defined categories. Required for the PayTo scheme, optional for all
306- // others. Currently `mortgage`, `utility`, `loan`, `dependant_support`,
307- // `gambling`, `retail`, `salary`, `personal`, `government`, `pension`, `tax`
308- // and `other` are supported.
319+ // Specifies the high-level purpose/category of a mandate and/or payment using
320+ // a set of pre-defined categories. Provides context on the nature and reason
321+ // for the payment to facilitate processing and compliance.
322+ // See [Billing Request Purpose
323+ // Codes](https://developer.gocardless.com/billing-request-purpose-codes/) for
324+ // the complete list of valid codes.
309325 purpose_code ?: BillingRequestPurposeCode ;
310326
311327 //
@@ -345,6 +361,15 @@ export type BillingRequestCreateRequestLinks = {
345361 customer_bank_account ?: string ;
346362} ;
347363
364+ export enum BillingRequestPaymentContextCode {
365+ BillingGoodsAndServicesInAdvance = 'billing_goods_and_services_in_advance' ,
366+ BillingGoodsAndServicesInArrears = 'billing_goods_and_services_in_arrears' ,
367+ FaceToFacePointOfSale = 'face_to_face_point_of_sale' ,
368+ EcommerceMerchantInitiatedPayment = 'ecommerce_merchant_initiated_payment' ,
369+ TransferToSelf = 'transfer_to_self' ,
370+ TransferToThirdParty = 'transfer_to_third_party' ,
371+ }
372+
348373export enum BillingRequestPurposeCode {
349374 Mortgage = 'mortgage' ,
350375 Utility = 'utility' ,
@@ -358,10 +383,49 @@ export enum BillingRequestPurposeCode {
358383 Pension = 'pension' ,
359384 Tax = 'tax' ,
360385 Other = 'other' ,
386+ BonusPayment = 'bonus_payment' ,
387+ CashManagementTransfer = 'cash_management_transfer' ,
388+ CardBulkClearing = 'card_bulk_clearing' ,
389+ CreditCardPayment = 'credit_card_payment' ,
390+ TradeSettlementPayment = 'trade_settlement_payment' ,
391+ DebitCardPayment = 'debit_card_payment' ,
392+ Dividend = 'dividend' ,
393+ DeliverAgainstPayment = 'deliver_against_payment' ,
361394 Epayment = 'epayment' ,
395+ FeeCollectionAndInterest = 'fee_collection_and_interest' ,
396+ FeeCollection = 'fee_collection' ,
397+ PersonToPersonPayment = 'person_to_person_payment' ,
398+ GovernmentPayment = 'government_payment' ,
399+ HedgingTransaction = 'hedging_transaction' ,
400+ IrrevocableCreditCardPayment = 'irrevocable_credit_card_payment' ,
401+ IrrevocableDebitCardPayment = 'irrevocable_debit_card_payment' ,
402+ IntraCompanyPayment = 'intra_company_payment' ,
403+ Interest = 'interest' ,
404+ LockboxTransactions = 'lockbox_transactions' ,
362405 Commercial = 'commercial' ,
406+ Consumer = 'consumer' ,
363407 OtherPayment = 'other_payment' ,
408+ PensionPayment = 'pension_payment' ,
409+ Represented = 'represented' ,
410+ ReimbursementReceivedCreditTransfer = 'reimbursement_received_credit_transfer' ,
411+ ReceiveAgainstPayment = 'receive_against_payment' ,
412+ SalaryPayment = 'salary_payment' ,
413+ Securities = 'securities' ,
414+ SocialSecurityBenefit = 'social_security_benefit' ,
415+ SupplierPayment = 'supplier_payment' ,
416+ TaxPayment = 'tax_payment' ,
364417 Trade = 'trade' ,
418+ TreasuryPayment = 'treasury_payment' ,
419+ ValueAddedTaxPayment = 'value_added_tax_payment' ,
420+ WithHolding = 'with_holding' ,
421+ CashManagementSweepAccount = 'cash_management_sweep_account' ,
422+ CashManagementTopAccount = 'cash_management_top_account' ,
423+ CashManagementZeroBalanceAccount = 'cash_management_zero_balance_account' ,
424+ CrossborderMiPayments = 'crossborder_mi_payments' ,
425+ ForeignCurrencyDomesticTransfer = 'foreign_currency_domestic_transfer' ,
426+ CashInPreCredit = 'cash_in_pre_credit' ,
427+ CashOutNotesCoins = 'cash_out_notes_coins' ,
428+ CarrierGuardedWholesaleValuables = 'carrier_guarded_wholesale_valuables' ,
365429}
366430
367431/** Type for a billingrequestcustomer resource. */
@@ -2098,6 +2162,15 @@ export enum BillingRequestWithActionMandateRequestVerify {
20982162 Always = 'always' ,
20992163}
21002164
2165+ export enum BillingRequestWithActionPaymentContextCode {
2166+ BillingGoodsAndServicesInAdvance = 'billing_goods_and_services_in_advance' ,
2167+ BillingGoodsAndServicesInArrears = 'billing_goods_and_services_in_arrears' ,
2168+ FaceToFacePointOfSale = 'face_to_face_point_of_sale' ,
2169+ EcommerceMerchantInitiatedPayment = 'ecommerce_merchant_initiated_payment' ,
2170+ TransferToSelf = 'transfer_to_self' ,
2171+ TransferToThirdParty = 'transfer_to_third_party' ,
2172+ }
2173+
21012174/** Type for a billingrequestwithactionpaymentrequest resource. */
21022175export type BillingRequestWithActionPaymentRequest = {
21032176 // Amount in minor unit (e.g. pence in GBP, cents in EUR).
@@ -2175,10 +2248,49 @@ export enum BillingRequestWithActionPurposeCode {
21752248 Pension = 'pension' ,
21762249 Tax = 'tax' ,
21772250 Other = 'other' ,
2251+ BonusPayment = 'bonus_payment' ,
2252+ CashManagementTransfer = 'cash_management_transfer' ,
2253+ CardBulkClearing = 'card_bulk_clearing' ,
2254+ CreditCardPayment = 'credit_card_payment' ,
2255+ TradeSettlementPayment = 'trade_settlement_payment' ,
2256+ DebitCardPayment = 'debit_card_payment' ,
2257+ Dividend = 'dividend' ,
2258+ DeliverAgainstPayment = 'deliver_against_payment' ,
21782259 Epayment = 'epayment' ,
2260+ FeeCollectionAndInterest = 'fee_collection_and_interest' ,
2261+ FeeCollection = 'fee_collection' ,
2262+ PersonToPersonPayment = 'person_to_person_payment' ,
2263+ GovernmentPayment = 'government_payment' ,
2264+ HedgingTransaction = 'hedging_transaction' ,
2265+ IrrevocableCreditCardPayment = 'irrevocable_credit_card_payment' ,
2266+ IrrevocableDebitCardPayment = 'irrevocable_debit_card_payment' ,
2267+ IntraCompanyPayment = 'intra_company_payment' ,
2268+ Interest = 'interest' ,
2269+ LockboxTransactions = 'lockbox_transactions' ,
21792270 Commercial = 'commercial' ,
2271+ Consumer = 'consumer' ,
21802272 OtherPayment = 'other_payment' ,
2273+ PensionPayment = 'pension_payment' ,
2274+ Represented = 'represented' ,
2275+ ReimbursementReceivedCreditTransfer = 'reimbursement_received_credit_transfer' ,
2276+ ReceiveAgainstPayment = 'receive_against_payment' ,
2277+ SalaryPayment = 'salary_payment' ,
2278+ Securities = 'securities' ,
2279+ SocialSecurityBenefit = 'social_security_benefit' ,
2280+ SupplierPayment = 'supplier_payment' ,
2281+ TaxPayment = 'tax_payment' ,
21812282 Trade = 'trade' ,
2283+ TreasuryPayment = 'treasury_payment' ,
2284+ ValueAddedTaxPayment = 'value_added_tax_payment' ,
2285+ WithHolding = 'with_holding' ,
2286+ CashManagementSweepAccount = 'cash_management_sweep_account' ,
2287+ CashManagementTopAccount = 'cash_management_top_account' ,
2288+ CashManagementZeroBalanceAccount = 'cash_management_zero_balance_account' ,
2289+ CrossborderMiPayments = 'crossborder_mi_payments' ,
2290+ ForeignCurrencyDomesticTransfer = 'foreign_currency_domestic_transfer' ,
2291+ CashInPreCredit = 'cash_in_pre_credit' ,
2292+ CashOutNotesCoins = 'cash_out_notes_coins' ,
2293+ CarrierGuardedWholesaleValuables = 'carrier_guarded_wholesale_valuables' ,
21822294}
21832295
21842296/** Type for a billingrequestwithactionbankauthorisations resource. */
@@ -2303,14 +2415,30 @@ export type BillingRequestWithActionBillingRequests = {
23032415 // up to 50 characters and values up to 500 characters.
23042416 metadata ?: JsonMap ;
23052417
2418+ // Specifies the context or scenario in which the payment is being made.
2419+ // Defines whether the payment is for advance/arrears billing, point of sale
2420+ // transactions, ecommerce, or account transfers. This helps banks and payment
2421+ // processors understand the payment scenario and apply appropriate processing
2422+ // rules and risk controls.
2423+ payment_context_code ?: BillingRequestWithActionBillingRequestsPaymentContextCode ;
2424+
2425+ // Specifies the underlying purpose of the payment. Defines the specific
2426+ // reason or type of service/goods the payment relates to, improving
2427+ // straight-through processing and compliance.
2428+ // See [VRP Commercial Payment Purpose
2429+ // Codes](https://developer.gocardless.com/vrp-commercial-payment-purpose-codes/)
2430+ // for the complete list of valid codes.
2431+ payment_purpose_code ?: string ;
2432+
23062433 // Request for a one-off strongly authorised payment
23072434 payment_request ?: BillingRequestWithActionBillingRequestsPaymentRequest ;
23082435
2309- // Specifies the high-level purpose of a mandate and/or payment using a set of
2310- // pre-defined categories. Required for the PayTo scheme, optional for all
2311- // others. Currently `mortgage`, `utility`, `loan`, `dependant_support`,
2312- // `gambling`, `retail`, `salary`, `personal`, `government`, `pension`, `tax`
2313- // and `other` are supported.
2436+ // Specifies the high-level purpose/category of a mandate and/or payment using
2437+ // a set of pre-defined categories. Provides context on the nature and reason
2438+ // for the payment to facilitate processing and compliance.
2439+ // See [Billing Request Purpose
2440+ // Codes](https://developer.gocardless.com/billing-request-purpose-codes/) for
2441+ // the complete list of valid codes.
23142442 purpose_code ?: BillingRequestWithActionBillingRequestsPurposeCode ;
23152443
23162444 //
@@ -2350,6 +2478,15 @@ export type BillingRequestWithActionBillingRequestsCreateRequestLinks = {
23502478 customer_bank_account ?: string ;
23512479} ;
23522480
2481+ export enum BillingRequestWithActionBillingRequestsPaymentContextCode {
2482+ BillingGoodsAndServicesInAdvance = 'billing_goods_and_services_in_advance' ,
2483+ BillingGoodsAndServicesInArrears = 'billing_goods_and_services_in_arrears' ,
2484+ FaceToFacePointOfSale = 'face_to_face_point_of_sale' ,
2485+ EcommerceMerchantInitiatedPayment = 'ecommerce_merchant_initiated_payment' ,
2486+ TransferToSelf = 'transfer_to_self' ,
2487+ TransferToThirdParty = 'transfer_to_third_party' ,
2488+ }
2489+
23532490export enum BillingRequestWithActionBillingRequestsPurposeCode {
23542491 Mortgage = 'mortgage' ,
23552492 Utility = 'utility' ,
@@ -2363,10 +2500,49 @@ export enum BillingRequestWithActionBillingRequestsPurposeCode {
23632500 Pension = 'pension' ,
23642501 Tax = 'tax' ,
23652502 Other = 'other' ,
2503+ BonusPayment = 'bonus_payment' ,
2504+ CashManagementTransfer = 'cash_management_transfer' ,
2505+ CardBulkClearing = 'card_bulk_clearing' ,
2506+ CreditCardPayment = 'credit_card_payment' ,
2507+ TradeSettlementPayment = 'trade_settlement_payment' ,
2508+ DebitCardPayment = 'debit_card_payment' ,
2509+ Dividend = 'dividend' ,
2510+ DeliverAgainstPayment = 'deliver_against_payment' ,
23662511 Epayment = 'epayment' ,
2512+ FeeCollectionAndInterest = 'fee_collection_and_interest' ,
2513+ FeeCollection = 'fee_collection' ,
2514+ PersonToPersonPayment = 'person_to_person_payment' ,
2515+ GovernmentPayment = 'government_payment' ,
2516+ HedgingTransaction = 'hedging_transaction' ,
2517+ IrrevocableCreditCardPayment = 'irrevocable_credit_card_payment' ,
2518+ IrrevocableDebitCardPayment = 'irrevocable_debit_card_payment' ,
2519+ IntraCompanyPayment = 'intra_company_payment' ,
2520+ Interest = 'interest' ,
2521+ LockboxTransactions = 'lockbox_transactions' ,
23672522 Commercial = 'commercial' ,
2523+ Consumer = 'consumer' ,
23682524 OtherPayment = 'other_payment' ,
2525+ PensionPayment = 'pension_payment' ,
2526+ Represented = 'represented' ,
2527+ ReimbursementReceivedCreditTransfer = 'reimbursement_received_credit_transfer' ,
2528+ ReceiveAgainstPayment = 'receive_against_payment' ,
2529+ SalaryPayment = 'salary_payment' ,
2530+ Securities = 'securities' ,
2531+ SocialSecurityBenefit = 'social_security_benefit' ,
2532+ SupplierPayment = 'supplier_payment' ,
2533+ TaxPayment = 'tax_payment' ,
23692534 Trade = 'trade' ,
2535+ TreasuryPayment = 'treasury_payment' ,
2536+ ValueAddedTaxPayment = 'value_added_tax_payment' ,
2537+ WithHolding = 'with_holding' ,
2538+ CashManagementSweepAccount = 'cash_management_sweep_account' ,
2539+ CashManagementTopAccount = 'cash_management_top_account' ,
2540+ CashManagementZeroBalanceAccount = 'cash_management_zero_balance_account' ,
2541+ CrossborderMiPayments = 'crossborder_mi_payments' ,
2542+ ForeignCurrencyDomesticTransfer = 'foreign_currency_domestic_transfer' ,
2543+ CashInPreCredit = 'cash_in_pre_credit' ,
2544+ CashOutNotesCoins = 'cash_out_notes_coins' ,
2545+ CarrierGuardedWholesaleValuables = 'carrier_guarded_wholesale_valuables' ,
23702546}
23712547
23722548/** Type for a billingrequestwithactionbillingrequestscustomer resource. */
0 commit comments