@augustusbank/typescript-sdk 0.33.0 → 0.34.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -69,11 +69,9 @@ export declare namespace PayoutInitiatedWebhookEvent {
69
69
  [key: string]: string;
70
70
  };
71
71
  /**
72
- * Purpose of the payout. Use an ISO 20022 external purpose code unless the
73
- * beneficiary bank country requires a national code. Only supported on fedwire and
74
- * swift payouts.
72
+ * ISO 20022 external purpose code. Only supported on fedwire and swift payouts.
75
73
  */
76
- purpose_code: 'BKDF' | 'BKFE' | 'BKFM' | 'BKIP' | 'BKPP' | 'CBLK' | 'CDCB' | 'CDCD' | 'CDCS' | 'CDDP' | 'CDOC' | 'CDQC' | 'ETUP' | 'FCOL' | 'MTUP' | 'ACCT' | 'CASH' | 'COLL' | 'CSDB' | 'DEPT' | 'INTC' | 'INTP' | 'LIMA' | 'NETT' | 'BFWD' | 'CCIR' | 'CCPC' | 'CCPM' | 'CCSM' | 'CRDS' | 'CRPR' | 'CRSP' | 'CRTL' | 'EQPT' | 'EQUS' | 'EXPT' | 'EXTD' | 'FIXI' | 'FWBC' | 'FWCC' | 'FWSB' | 'FWSC' | 'MARG' | 'MBSB' | 'MBSC' | 'MGCC' | 'MGSC' | 'OCCC' | 'OPBC' | 'OPCC' | 'OPSB' | 'OPSC' | 'OPTN' | 'OTCD' | 'REPO' | 'RPBC' | 'RPCC' | 'RPSB' | 'RPSC' | 'RVPO' | 'SBSC' | 'SCIE' | 'SCIR' | 'SCRP' | 'SHBC' | 'SHCC' | 'SHSL' | 'SLEB' | 'SLOA' | 'SWBC' | 'SWCC' | 'SWPT' | 'SWSB' | 'SWSC' | 'TBAS' | 'TBBC' | 'TBCC' | 'TRCP' | 'AGRT' | 'AREN' | 'BEXP' | 'BOCE' | 'COMC' | 'CPYR' | 'GDDS' | 'GDSV' | 'GSCB' | 'LICF' | 'MP2B' | 'POPE' | 'ROYA' | 'SCVE' | 'SERV' | 'SUBS' | 'SUPP' | 'TRAD' | 'CHAR' | 'COMT' | 'MP2P' | 'ECPG' | 'ECPR' | 'ECPU' | 'EPAY' | 'CLPR' | 'COMP' | 'DBTC' | 'GOVI' | 'HLRP' | 'HLST' | 'INPC' | 'INPR' | 'INSC' | 'INSU' | 'INTE' | 'LBRI' | 'LIFI' | 'LOAN' | 'LOAR' | 'PENO' | 'PPTI' | 'RELG' | 'RINP' | 'TRFD' | 'FORW' | 'FXNT' | 'ADMG' | 'ADVA' | 'BCDM' | 'BCFG' | 'BLDM' | 'BNET' | 'CBFF' | 'CBFR' | 'CCRD' | 'CDBL' | 'CFEE' | 'CGDD' | 'CORT' | 'COST' | 'CPKC' | 'DCRD' | 'DSMT' | 'DVPM' | 'EDUC' | 'FACT' | 'FAND' | 'FCPM' | 'FEES' | 'GIFT' | 'GOVT' | 'ICCP' | 'IDCP' | 'IHRP' | 'INSM' | 'IVPT' | 'MCDM' | 'MCFG' | 'MSVC' | 'NOWS' | 'OCDM' | 'OCFG' | 'OFEE' | 'OTHR' | 'PADD' | 'PTSP' | 'RCKE' | 'RCPT' | 'REBT' | 'REFU' | 'RENT' | 'REOD' | 'RIMB' | 'RPNT' | 'RRBN' | 'RRCT' | 'RRTP' | 'RVPM' | 'SLPI' | 'SPLT' | 'STDY' | 'TBAN' | 'TBIL' | 'TCSC' | 'TELI' | 'TMPG' | 'TPRI' | 'TPRP' | 'TRNC' | 'TRVC' | 'WEBI' | 'IPAY' | 'IPCA' | 'IPDO' | 'IPEA' | 'IPEC' | 'IPEW' | 'IPPS' | 'IPRT' | 'IPU2' | 'IPUW' | 'ANNI' | 'CAFI' | 'CFDI' | 'CMDT' | 'DERI' | 'DIVD' | 'FREX' | 'HEDG' | 'INVS' | 'PRME' | 'SAVG' | 'SECU' | 'SEPI' | 'TREA' | 'UNIT' | 'FNET' | 'FUTR' | 'ANTS' | 'CVCF' | 'DMEQ' | 'DNTS' | 'HLTC' | 'HLTI' | 'HSPC' | 'ICRF' | 'LTCF' | 'MAFC' | 'MARF' | 'MDCS' | 'VIEW' | 'CDEP' | 'SWFP' | 'SWPP' | 'SWRS' | 'SWUF' | 'ADCS' | 'AEMP' | 'ALLW' | 'ALMY' | 'BBSC' | 'BECH' | 'BENE' | 'BONU' | 'CCHD' | 'COMM' | 'CSLP' | 'GFRP' | 'GVEA' | 'GVEB' | 'GVEC' | 'GVED' | 'GWLT' | 'HREC' | 'PAYR' | 'PEFC' | 'PENS' | 'PRCP' | 'RHBS' | 'SALA' | 'SPSP' | 'SSBE' | 'LBIN' | 'LCOL' | 'LFEE' | 'LMEQ' | 'LMFI' | 'LMRK' | 'LREB' | 'LREV' | 'LSFL' | 'ESTX' | 'FWLV' | 'GSTX' | 'HSTX' | 'INTX' | 'NITX' | 'PTXP' | 'RDTX' | 'TAXS' | 'VATX' | 'WHLD' | 'TAXR' | 'B112' | 'BR12' | 'TLRF' | 'TLRR' | 'AIRB' | 'BUSB' | 'FERB' | 'RLWY' | 'TRPT' | 'CBTV' | 'ELEC' | 'ENRG' | 'GASB' | 'NWCH' | 'NWCM' | 'OTLC' | 'PHON' | 'UBIL' | 'WTER' | 'BOND' | 'CABD' | 'CAEQ' | 'CBCR' | 'DBCR' | 'DICL' | 'EQTS' | 'FLCR' | 'EFTC' | 'EFTD' | 'MOMA' | 'RAPI' | 'GAMB' | 'LOTT' | 'AMEX' | 'SASW' | 'AUCO' | 'PCOM' | 'PDEP' | 'PLDS' | 'PLRF' | 'GAFA' | 'GAHO' | 'CPEN' | 'DEPD' | 'RETL' | 'DEBT' | 'CAP' | 'GDS' | 'SRV' | 'CAC' | 'FTF' | (string & {}) | null;
74
+ purpose_code: 'BKDF' | 'BKFE' | 'BKFM' | 'BKIP' | 'BKPP' | 'CBLK' | 'CDCB' | 'CDCD' | 'CDCS' | 'CDDP' | 'CDOC' | 'CDQC' | 'ETUP' | 'FCOL' | 'MTUP' | 'ACCT' | 'CASH' | 'COLL' | 'CSDB' | 'DEPT' | 'INTC' | 'INTP' | 'LIMA' | 'NETT' | 'BFWD' | 'CCIR' | 'CCPC' | 'CCPM' | 'CCSM' | 'CRDS' | 'CRPR' | 'CRSP' | 'CRTL' | 'EQPT' | 'EQUS' | 'EXPT' | 'EXTD' | 'FIXI' | 'FWBC' | 'FWCC' | 'FWSB' | 'FWSC' | 'MARG' | 'MBSB' | 'MBSC' | 'MGCC' | 'MGSC' | 'OCCC' | 'OPBC' | 'OPCC' | 'OPSB' | 'OPSC' | 'OPTN' | 'OTCD' | 'REPO' | 'RPBC' | 'RPCC' | 'RPSB' | 'RPSC' | 'RVPO' | 'SBSC' | 'SCIE' | 'SCIR' | 'SCRP' | 'SHBC' | 'SHCC' | 'SHSL' | 'SLEB' | 'SLOA' | 'SWBC' | 'SWCC' | 'SWPT' | 'SWSB' | 'SWSC' | 'TBAS' | 'TBBC' | 'TBCC' | 'TRCP' | 'AGRT' | 'AREN' | 'BEXP' | 'BOCE' | 'COMC' | 'CPYR' | 'GDDS' | 'GDSV' | 'GSCB' | 'LICF' | 'MP2B' | 'POPE' | 'ROYA' | 'SCVE' | 'SERV' | 'SUBS' | 'SUPP' | 'TRAD' | 'CHAR' | 'COMT' | 'MP2P' | 'ECPG' | 'ECPR' | 'ECPU' | 'EPAY' | 'CLPR' | 'COMP' | 'DBTC' | 'GOVI' | 'HLRP' | 'HLST' | 'INPC' | 'INPR' | 'INSC' | 'INSU' | 'INTE' | 'LBRI' | 'LIFI' | 'LOAN' | 'LOAR' | 'PENO' | 'PPTI' | 'RELG' | 'RINP' | 'TRFD' | 'FORW' | 'FXNT' | 'ADMG' | 'ADVA' | 'BCDM' | 'BCFG' | 'BLDM' | 'BNET' | 'CBFF' | 'CBFR' | 'CCRD' | 'CDBL' | 'CFEE' | 'CGDD' | 'CORT' | 'COST' | 'CPKC' | 'DCRD' | 'DSMT' | 'DVPM' | 'EDUC' | 'FACT' | 'FAND' | 'FCPM' | 'FEES' | 'GIFT' | 'GOVT' | 'ICCP' | 'IDCP' | 'IHRP' | 'INSM' | 'IVPT' | 'MCDM' | 'MCFG' | 'MSVC' | 'NOWS' | 'OCDM' | 'OCFG' | 'OFEE' | 'OTHR' | 'PADD' | 'PTSP' | 'RCKE' | 'RCPT' | 'REBT' | 'REFU' | 'RENT' | 'REOD' | 'RIMB' | 'RPNT' | 'RRBN' | 'RRCT' | 'RRTP' | 'RVPM' | 'SLPI' | 'SPLT' | 'STDY' | 'TBAN' | 'TBIL' | 'TCSC' | 'TELI' | 'TMPG' | 'TPRI' | 'TPRP' | 'TRNC' | 'TRVC' | 'WEBI' | 'IPAY' | 'IPCA' | 'IPDO' | 'IPEA' | 'IPEC' | 'IPEW' | 'IPPS' | 'IPRT' | 'IPU2' | 'IPUW' | 'ANNI' | 'CAFI' | 'CFDI' | 'CMDT' | 'DERI' | 'DIVD' | 'FREX' | 'HEDG' | 'INVS' | 'PRME' | 'SAVG' | 'SECU' | 'SEPI' | 'TREA' | 'UNIT' | 'FNET' | 'FUTR' | 'ANTS' | 'CVCF' | 'DMEQ' | 'DNTS' | 'HLTC' | 'HLTI' | 'HSPC' | 'ICRF' | 'LTCF' | 'MAFC' | 'MARF' | 'MDCS' | 'VIEW' | 'CDEP' | 'SWFP' | 'SWPP' | 'SWRS' | 'SWUF' | 'ADCS' | 'AEMP' | 'ALLW' | 'ALMY' | 'BBSC' | 'BECH' | 'BENE' | 'BONU' | 'CCHD' | 'COMM' | 'CSLP' | 'GFRP' | 'GVEA' | 'GVEB' | 'GVEC' | 'GVED' | 'GWLT' | 'HREC' | 'PAYR' | 'PEFC' | 'PENS' | 'PRCP' | 'RHBS' | 'SALA' | 'SPSP' | 'SSBE' | 'LBIN' | 'LCOL' | 'LFEE' | 'LMEQ' | 'LMFI' | 'LMRK' | 'LREB' | 'LREV' | 'LSFL' | 'ESTX' | 'FWLV' | 'GSTX' | 'HSTX' | 'INTX' | 'NITX' | 'PTXP' | 'RDTX' | 'TAXS' | 'VATX' | 'WHLD' | 'TAXR' | 'B112' | 'BR12' | 'TLRF' | 'TLRR' | 'AIRB' | 'BUSB' | 'FERB' | 'RLWY' | 'TRPT' | 'CBTV' | 'ELEC' | 'ENRG' | 'GASB' | 'NWCH' | 'NWCM' | 'OTLC' | 'PHON' | 'UBIL' | 'WTER' | 'BOND' | 'CABD' | 'CAEQ' | 'CBCR' | 'DBCR' | 'DICL' | 'EQTS' | 'FLCR' | 'EFTC' | 'EFTD' | 'MOMA' | 'RAPI' | 'GAMB' | 'LOTT' | 'AMEX' | 'SASW' | 'AUCO' | 'PCOM' | 'PDEP' | 'PLDS' | 'PLRF' | 'GAFA' | 'GAHO' | 'CPEN' | 'DEPD' | 'RETL' | 'DEBT' | null;
77
75
  /**
78
76
  * Payment scheme or blockchain used for the payout, or null when unknown.
79
77
  */
@@ -204,11 +202,9 @@ export declare namespace PayoutSubmittedWebhookEvent {
204
202
  [key: string]: string;
205
203
  };
206
204
  /**
207
- * Purpose of the payout. Use an ISO 20022 external purpose code unless the
208
- * beneficiary bank country requires a national code. Only supported on fedwire and
209
- * swift payouts.
205
+ * ISO 20022 external purpose code. Only supported on fedwire and swift payouts.
210
206
  */
211
- purpose_code: 'BKDF' | 'BKFE' | 'BKFM' | 'BKIP' | 'BKPP' | 'CBLK' | 'CDCB' | 'CDCD' | 'CDCS' | 'CDDP' | 'CDOC' | 'CDQC' | 'ETUP' | 'FCOL' | 'MTUP' | 'ACCT' | 'CASH' | 'COLL' | 'CSDB' | 'DEPT' | 'INTC' | 'INTP' | 'LIMA' | 'NETT' | 'BFWD' | 'CCIR' | 'CCPC' | 'CCPM' | 'CCSM' | 'CRDS' | 'CRPR' | 'CRSP' | 'CRTL' | 'EQPT' | 'EQUS' | 'EXPT' | 'EXTD' | 'FIXI' | 'FWBC' | 'FWCC' | 'FWSB' | 'FWSC' | 'MARG' | 'MBSB' | 'MBSC' | 'MGCC' | 'MGSC' | 'OCCC' | 'OPBC' | 'OPCC' | 'OPSB' | 'OPSC' | 'OPTN' | 'OTCD' | 'REPO' | 'RPBC' | 'RPCC' | 'RPSB' | 'RPSC' | 'RVPO' | 'SBSC' | 'SCIE' | 'SCIR' | 'SCRP' | 'SHBC' | 'SHCC' | 'SHSL' | 'SLEB' | 'SLOA' | 'SWBC' | 'SWCC' | 'SWPT' | 'SWSB' | 'SWSC' | 'TBAS' | 'TBBC' | 'TBCC' | 'TRCP' | 'AGRT' | 'AREN' | 'BEXP' | 'BOCE' | 'COMC' | 'CPYR' | 'GDDS' | 'GDSV' | 'GSCB' | 'LICF' | 'MP2B' | 'POPE' | 'ROYA' | 'SCVE' | 'SERV' | 'SUBS' | 'SUPP' | 'TRAD' | 'CHAR' | 'COMT' | 'MP2P' | 'ECPG' | 'ECPR' | 'ECPU' | 'EPAY' | 'CLPR' | 'COMP' | 'DBTC' | 'GOVI' | 'HLRP' | 'HLST' | 'INPC' | 'INPR' | 'INSC' | 'INSU' | 'INTE' | 'LBRI' | 'LIFI' | 'LOAN' | 'LOAR' | 'PENO' | 'PPTI' | 'RELG' | 'RINP' | 'TRFD' | 'FORW' | 'FXNT' | 'ADMG' | 'ADVA' | 'BCDM' | 'BCFG' | 'BLDM' | 'BNET' | 'CBFF' | 'CBFR' | 'CCRD' | 'CDBL' | 'CFEE' | 'CGDD' | 'CORT' | 'COST' | 'CPKC' | 'DCRD' | 'DSMT' | 'DVPM' | 'EDUC' | 'FACT' | 'FAND' | 'FCPM' | 'FEES' | 'GIFT' | 'GOVT' | 'ICCP' | 'IDCP' | 'IHRP' | 'INSM' | 'IVPT' | 'MCDM' | 'MCFG' | 'MSVC' | 'NOWS' | 'OCDM' | 'OCFG' | 'OFEE' | 'OTHR' | 'PADD' | 'PTSP' | 'RCKE' | 'RCPT' | 'REBT' | 'REFU' | 'RENT' | 'REOD' | 'RIMB' | 'RPNT' | 'RRBN' | 'RRCT' | 'RRTP' | 'RVPM' | 'SLPI' | 'SPLT' | 'STDY' | 'TBAN' | 'TBIL' | 'TCSC' | 'TELI' | 'TMPG' | 'TPRI' | 'TPRP' | 'TRNC' | 'TRVC' | 'WEBI' | 'IPAY' | 'IPCA' | 'IPDO' | 'IPEA' | 'IPEC' | 'IPEW' | 'IPPS' | 'IPRT' | 'IPU2' | 'IPUW' | 'ANNI' | 'CAFI' | 'CFDI' | 'CMDT' | 'DERI' | 'DIVD' | 'FREX' | 'HEDG' | 'INVS' | 'PRME' | 'SAVG' | 'SECU' | 'SEPI' | 'TREA' | 'UNIT' | 'FNET' | 'FUTR' | 'ANTS' | 'CVCF' | 'DMEQ' | 'DNTS' | 'HLTC' | 'HLTI' | 'HSPC' | 'ICRF' | 'LTCF' | 'MAFC' | 'MARF' | 'MDCS' | 'VIEW' | 'CDEP' | 'SWFP' | 'SWPP' | 'SWRS' | 'SWUF' | 'ADCS' | 'AEMP' | 'ALLW' | 'ALMY' | 'BBSC' | 'BECH' | 'BENE' | 'BONU' | 'CCHD' | 'COMM' | 'CSLP' | 'GFRP' | 'GVEA' | 'GVEB' | 'GVEC' | 'GVED' | 'GWLT' | 'HREC' | 'PAYR' | 'PEFC' | 'PENS' | 'PRCP' | 'RHBS' | 'SALA' | 'SPSP' | 'SSBE' | 'LBIN' | 'LCOL' | 'LFEE' | 'LMEQ' | 'LMFI' | 'LMRK' | 'LREB' | 'LREV' | 'LSFL' | 'ESTX' | 'FWLV' | 'GSTX' | 'HSTX' | 'INTX' | 'NITX' | 'PTXP' | 'RDTX' | 'TAXS' | 'VATX' | 'WHLD' | 'TAXR' | 'B112' | 'BR12' | 'TLRF' | 'TLRR' | 'AIRB' | 'BUSB' | 'FERB' | 'RLWY' | 'TRPT' | 'CBTV' | 'ELEC' | 'ENRG' | 'GASB' | 'NWCH' | 'NWCM' | 'OTLC' | 'PHON' | 'UBIL' | 'WTER' | 'BOND' | 'CABD' | 'CAEQ' | 'CBCR' | 'DBCR' | 'DICL' | 'EQTS' | 'FLCR' | 'EFTC' | 'EFTD' | 'MOMA' | 'RAPI' | 'GAMB' | 'LOTT' | 'AMEX' | 'SASW' | 'AUCO' | 'PCOM' | 'PDEP' | 'PLDS' | 'PLRF' | 'GAFA' | 'GAHO' | 'CPEN' | 'DEPD' | 'RETL' | 'DEBT' | 'CAP' | 'GDS' | 'SRV' | 'CAC' | 'FTF' | (string & {}) | null;
207
+ purpose_code: 'BKDF' | 'BKFE' | 'BKFM' | 'BKIP' | 'BKPP' | 'CBLK' | 'CDCB' | 'CDCD' | 'CDCS' | 'CDDP' | 'CDOC' | 'CDQC' | 'ETUP' | 'FCOL' | 'MTUP' | 'ACCT' | 'CASH' | 'COLL' | 'CSDB' | 'DEPT' | 'INTC' | 'INTP' | 'LIMA' | 'NETT' | 'BFWD' | 'CCIR' | 'CCPC' | 'CCPM' | 'CCSM' | 'CRDS' | 'CRPR' | 'CRSP' | 'CRTL' | 'EQPT' | 'EQUS' | 'EXPT' | 'EXTD' | 'FIXI' | 'FWBC' | 'FWCC' | 'FWSB' | 'FWSC' | 'MARG' | 'MBSB' | 'MBSC' | 'MGCC' | 'MGSC' | 'OCCC' | 'OPBC' | 'OPCC' | 'OPSB' | 'OPSC' | 'OPTN' | 'OTCD' | 'REPO' | 'RPBC' | 'RPCC' | 'RPSB' | 'RPSC' | 'RVPO' | 'SBSC' | 'SCIE' | 'SCIR' | 'SCRP' | 'SHBC' | 'SHCC' | 'SHSL' | 'SLEB' | 'SLOA' | 'SWBC' | 'SWCC' | 'SWPT' | 'SWSB' | 'SWSC' | 'TBAS' | 'TBBC' | 'TBCC' | 'TRCP' | 'AGRT' | 'AREN' | 'BEXP' | 'BOCE' | 'COMC' | 'CPYR' | 'GDDS' | 'GDSV' | 'GSCB' | 'LICF' | 'MP2B' | 'POPE' | 'ROYA' | 'SCVE' | 'SERV' | 'SUBS' | 'SUPP' | 'TRAD' | 'CHAR' | 'COMT' | 'MP2P' | 'ECPG' | 'ECPR' | 'ECPU' | 'EPAY' | 'CLPR' | 'COMP' | 'DBTC' | 'GOVI' | 'HLRP' | 'HLST' | 'INPC' | 'INPR' | 'INSC' | 'INSU' | 'INTE' | 'LBRI' | 'LIFI' | 'LOAN' | 'LOAR' | 'PENO' | 'PPTI' | 'RELG' | 'RINP' | 'TRFD' | 'FORW' | 'FXNT' | 'ADMG' | 'ADVA' | 'BCDM' | 'BCFG' | 'BLDM' | 'BNET' | 'CBFF' | 'CBFR' | 'CCRD' | 'CDBL' | 'CFEE' | 'CGDD' | 'CORT' | 'COST' | 'CPKC' | 'DCRD' | 'DSMT' | 'DVPM' | 'EDUC' | 'FACT' | 'FAND' | 'FCPM' | 'FEES' | 'GIFT' | 'GOVT' | 'ICCP' | 'IDCP' | 'IHRP' | 'INSM' | 'IVPT' | 'MCDM' | 'MCFG' | 'MSVC' | 'NOWS' | 'OCDM' | 'OCFG' | 'OFEE' | 'OTHR' | 'PADD' | 'PTSP' | 'RCKE' | 'RCPT' | 'REBT' | 'REFU' | 'RENT' | 'REOD' | 'RIMB' | 'RPNT' | 'RRBN' | 'RRCT' | 'RRTP' | 'RVPM' | 'SLPI' | 'SPLT' | 'STDY' | 'TBAN' | 'TBIL' | 'TCSC' | 'TELI' | 'TMPG' | 'TPRI' | 'TPRP' | 'TRNC' | 'TRVC' | 'WEBI' | 'IPAY' | 'IPCA' | 'IPDO' | 'IPEA' | 'IPEC' | 'IPEW' | 'IPPS' | 'IPRT' | 'IPU2' | 'IPUW' | 'ANNI' | 'CAFI' | 'CFDI' | 'CMDT' | 'DERI' | 'DIVD' | 'FREX' | 'HEDG' | 'INVS' | 'PRME' | 'SAVG' | 'SECU' | 'SEPI' | 'TREA' | 'UNIT' | 'FNET' | 'FUTR' | 'ANTS' | 'CVCF' | 'DMEQ' | 'DNTS' | 'HLTC' | 'HLTI' | 'HSPC' | 'ICRF' | 'LTCF' | 'MAFC' | 'MARF' | 'MDCS' | 'VIEW' | 'CDEP' | 'SWFP' | 'SWPP' | 'SWRS' | 'SWUF' | 'ADCS' | 'AEMP' | 'ALLW' | 'ALMY' | 'BBSC' | 'BECH' | 'BENE' | 'BONU' | 'CCHD' | 'COMM' | 'CSLP' | 'GFRP' | 'GVEA' | 'GVEB' | 'GVEC' | 'GVED' | 'GWLT' | 'HREC' | 'PAYR' | 'PEFC' | 'PENS' | 'PRCP' | 'RHBS' | 'SALA' | 'SPSP' | 'SSBE' | 'LBIN' | 'LCOL' | 'LFEE' | 'LMEQ' | 'LMFI' | 'LMRK' | 'LREB' | 'LREV' | 'LSFL' | 'ESTX' | 'FWLV' | 'GSTX' | 'HSTX' | 'INTX' | 'NITX' | 'PTXP' | 'RDTX' | 'TAXS' | 'VATX' | 'WHLD' | 'TAXR' | 'B112' | 'BR12' | 'TLRF' | 'TLRR' | 'AIRB' | 'BUSB' | 'FERB' | 'RLWY' | 'TRPT' | 'CBTV' | 'ELEC' | 'ENRG' | 'GASB' | 'NWCH' | 'NWCM' | 'OTLC' | 'PHON' | 'UBIL' | 'WTER' | 'BOND' | 'CABD' | 'CAEQ' | 'CBCR' | 'DBCR' | 'DICL' | 'EQTS' | 'FLCR' | 'EFTC' | 'EFTD' | 'MOMA' | 'RAPI' | 'GAMB' | 'LOTT' | 'AMEX' | 'SASW' | 'AUCO' | 'PCOM' | 'PDEP' | 'PLDS' | 'PLRF' | 'GAFA' | 'GAHO' | 'CPEN' | 'DEPD' | 'RETL' | 'DEBT' | null;
212
208
  /**
213
209
  * Payment scheme or blockchain used for the payout, or null when unknown.
214
210
  */
@@ -339,11 +335,9 @@ export declare namespace PayoutSentWebhookEvent {
339
335
  [key: string]: string;
340
336
  };
341
337
  /**
342
- * Purpose of the payout. Use an ISO 20022 external purpose code unless the
343
- * beneficiary bank country requires a national code. Only supported on fedwire and
344
- * swift payouts.
338
+ * ISO 20022 external purpose code. Only supported on fedwire and swift payouts.
345
339
  */
346
- purpose_code: 'BKDF' | 'BKFE' | 'BKFM' | 'BKIP' | 'BKPP' | 'CBLK' | 'CDCB' | 'CDCD' | 'CDCS' | 'CDDP' | 'CDOC' | 'CDQC' | 'ETUP' | 'FCOL' | 'MTUP' | 'ACCT' | 'CASH' | 'COLL' | 'CSDB' | 'DEPT' | 'INTC' | 'INTP' | 'LIMA' | 'NETT' | 'BFWD' | 'CCIR' | 'CCPC' | 'CCPM' | 'CCSM' | 'CRDS' | 'CRPR' | 'CRSP' | 'CRTL' | 'EQPT' | 'EQUS' | 'EXPT' | 'EXTD' | 'FIXI' | 'FWBC' | 'FWCC' | 'FWSB' | 'FWSC' | 'MARG' | 'MBSB' | 'MBSC' | 'MGCC' | 'MGSC' | 'OCCC' | 'OPBC' | 'OPCC' | 'OPSB' | 'OPSC' | 'OPTN' | 'OTCD' | 'REPO' | 'RPBC' | 'RPCC' | 'RPSB' | 'RPSC' | 'RVPO' | 'SBSC' | 'SCIE' | 'SCIR' | 'SCRP' | 'SHBC' | 'SHCC' | 'SHSL' | 'SLEB' | 'SLOA' | 'SWBC' | 'SWCC' | 'SWPT' | 'SWSB' | 'SWSC' | 'TBAS' | 'TBBC' | 'TBCC' | 'TRCP' | 'AGRT' | 'AREN' | 'BEXP' | 'BOCE' | 'COMC' | 'CPYR' | 'GDDS' | 'GDSV' | 'GSCB' | 'LICF' | 'MP2B' | 'POPE' | 'ROYA' | 'SCVE' | 'SERV' | 'SUBS' | 'SUPP' | 'TRAD' | 'CHAR' | 'COMT' | 'MP2P' | 'ECPG' | 'ECPR' | 'ECPU' | 'EPAY' | 'CLPR' | 'COMP' | 'DBTC' | 'GOVI' | 'HLRP' | 'HLST' | 'INPC' | 'INPR' | 'INSC' | 'INSU' | 'INTE' | 'LBRI' | 'LIFI' | 'LOAN' | 'LOAR' | 'PENO' | 'PPTI' | 'RELG' | 'RINP' | 'TRFD' | 'FORW' | 'FXNT' | 'ADMG' | 'ADVA' | 'BCDM' | 'BCFG' | 'BLDM' | 'BNET' | 'CBFF' | 'CBFR' | 'CCRD' | 'CDBL' | 'CFEE' | 'CGDD' | 'CORT' | 'COST' | 'CPKC' | 'DCRD' | 'DSMT' | 'DVPM' | 'EDUC' | 'FACT' | 'FAND' | 'FCPM' | 'FEES' | 'GIFT' | 'GOVT' | 'ICCP' | 'IDCP' | 'IHRP' | 'INSM' | 'IVPT' | 'MCDM' | 'MCFG' | 'MSVC' | 'NOWS' | 'OCDM' | 'OCFG' | 'OFEE' | 'OTHR' | 'PADD' | 'PTSP' | 'RCKE' | 'RCPT' | 'REBT' | 'REFU' | 'RENT' | 'REOD' | 'RIMB' | 'RPNT' | 'RRBN' | 'RRCT' | 'RRTP' | 'RVPM' | 'SLPI' | 'SPLT' | 'STDY' | 'TBAN' | 'TBIL' | 'TCSC' | 'TELI' | 'TMPG' | 'TPRI' | 'TPRP' | 'TRNC' | 'TRVC' | 'WEBI' | 'IPAY' | 'IPCA' | 'IPDO' | 'IPEA' | 'IPEC' | 'IPEW' | 'IPPS' | 'IPRT' | 'IPU2' | 'IPUW' | 'ANNI' | 'CAFI' | 'CFDI' | 'CMDT' | 'DERI' | 'DIVD' | 'FREX' | 'HEDG' | 'INVS' | 'PRME' | 'SAVG' | 'SECU' | 'SEPI' | 'TREA' | 'UNIT' | 'FNET' | 'FUTR' | 'ANTS' | 'CVCF' | 'DMEQ' | 'DNTS' | 'HLTC' | 'HLTI' | 'HSPC' | 'ICRF' | 'LTCF' | 'MAFC' | 'MARF' | 'MDCS' | 'VIEW' | 'CDEP' | 'SWFP' | 'SWPP' | 'SWRS' | 'SWUF' | 'ADCS' | 'AEMP' | 'ALLW' | 'ALMY' | 'BBSC' | 'BECH' | 'BENE' | 'BONU' | 'CCHD' | 'COMM' | 'CSLP' | 'GFRP' | 'GVEA' | 'GVEB' | 'GVEC' | 'GVED' | 'GWLT' | 'HREC' | 'PAYR' | 'PEFC' | 'PENS' | 'PRCP' | 'RHBS' | 'SALA' | 'SPSP' | 'SSBE' | 'LBIN' | 'LCOL' | 'LFEE' | 'LMEQ' | 'LMFI' | 'LMRK' | 'LREB' | 'LREV' | 'LSFL' | 'ESTX' | 'FWLV' | 'GSTX' | 'HSTX' | 'INTX' | 'NITX' | 'PTXP' | 'RDTX' | 'TAXS' | 'VATX' | 'WHLD' | 'TAXR' | 'B112' | 'BR12' | 'TLRF' | 'TLRR' | 'AIRB' | 'BUSB' | 'FERB' | 'RLWY' | 'TRPT' | 'CBTV' | 'ELEC' | 'ENRG' | 'GASB' | 'NWCH' | 'NWCM' | 'OTLC' | 'PHON' | 'UBIL' | 'WTER' | 'BOND' | 'CABD' | 'CAEQ' | 'CBCR' | 'DBCR' | 'DICL' | 'EQTS' | 'FLCR' | 'EFTC' | 'EFTD' | 'MOMA' | 'RAPI' | 'GAMB' | 'LOTT' | 'AMEX' | 'SASW' | 'AUCO' | 'PCOM' | 'PDEP' | 'PLDS' | 'PLRF' | 'GAFA' | 'GAHO' | 'CPEN' | 'DEPD' | 'RETL' | 'DEBT' | 'CAP' | 'GDS' | 'SRV' | 'CAC' | 'FTF' | (string & {}) | null;
340
+ purpose_code: 'BKDF' | 'BKFE' | 'BKFM' | 'BKIP' | 'BKPP' | 'CBLK' | 'CDCB' | 'CDCD' | 'CDCS' | 'CDDP' | 'CDOC' | 'CDQC' | 'ETUP' | 'FCOL' | 'MTUP' | 'ACCT' | 'CASH' | 'COLL' | 'CSDB' | 'DEPT' | 'INTC' | 'INTP' | 'LIMA' | 'NETT' | 'BFWD' | 'CCIR' | 'CCPC' | 'CCPM' | 'CCSM' | 'CRDS' | 'CRPR' | 'CRSP' | 'CRTL' | 'EQPT' | 'EQUS' | 'EXPT' | 'EXTD' | 'FIXI' | 'FWBC' | 'FWCC' | 'FWSB' | 'FWSC' | 'MARG' | 'MBSB' | 'MBSC' | 'MGCC' | 'MGSC' | 'OCCC' | 'OPBC' | 'OPCC' | 'OPSB' | 'OPSC' | 'OPTN' | 'OTCD' | 'REPO' | 'RPBC' | 'RPCC' | 'RPSB' | 'RPSC' | 'RVPO' | 'SBSC' | 'SCIE' | 'SCIR' | 'SCRP' | 'SHBC' | 'SHCC' | 'SHSL' | 'SLEB' | 'SLOA' | 'SWBC' | 'SWCC' | 'SWPT' | 'SWSB' | 'SWSC' | 'TBAS' | 'TBBC' | 'TBCC' | 'TRCP' | 'AGRT' | 'AREN' | 'BEXP' | 'BOCE' | 'COMC' | 'CPYR' | 'GDDS' | 'GDSV' | 'GSCB' | 'LICF' | 'MP2B' | 'POPE' | 'ROYA' | 'SCVE' | 'SERV' | 'SUBS' | 'SUPP' | 'TRAD' | 'CHAR' | 'COMT' | 'MP2P' | 'ECPG' | 'ECPR' | 'ECPU' | 'EPAY' | 'CLPR' | 'COMP' | 'DBTC' | 'GOVI' | 'HLRP' | 'HLST' | 'INPC' | 'INPR' | 'INSC' | 'INSU' | 'INTE' | 'LBRI' | 'LIFI' | 'LOAN' | 'LOAR' | 'PENO' | 'PPTI' | 'RELG' | 'RINP' | 'TRFD' | 'FORW' | 'FXNT' | 'ADMG' | 'ADVA' | 'BCDM' | 'BCFG' | 'BLDM' | 'BNET' | 'CBFF' | 'CBFR' | 'CCRD' | 'CDBL' | 'CFEE' | 'CGDD' | 'CORT' | 'COST' | 'CPKC' | 'DCRD' | 'DSMT' | 'DVPM' | 'EDUC' | 'FACT' | 'FAND' | 'FCPM' | 'FEES' | 'GIFT' | 'GOVT' | 'ICCP' | 'IDCP' | 'IHRP' | 'INSM' | 'IVPT' | 'MCDM' | 'MCFG' | 'MSVC' | 'NOWS' | 'OCDM' | 'OCFG' | 'OFEE' | 'OTHR' | 'PADD' | 'PTSP' | 'RCKE' | 'RCPT' | 'REBT' | 'REFU' | 'RENT' | 'REOD' | 'RIMB' | 'RPNT' | 'RRBN' | 'RRCT' | 'RRTP' | 'RVPM' | 'SLPI' | 'SPLT' | 'STDY' | 'TBAN' | 'TBIL' | 'TCSC' | 'TELI' | 'TMPG' | 'TPRI' | 'TPRP' | 'TRNC' | 'TRVC' | 'WEBI' | 'IPAY' | 'IPCA' | 'IPDO' | 'IPEA' | 'IPEC' | 'IPEW' | 'IPPS' | 'IPRT' | 'IPU2' | 'IPUW' | 'ANNI' | 'CAFI' | 'CFDI' | 'CMDT' | 'DERI' | 'DIVD' | 'FREX' | 'HEDG' | 'INVS' | 'PRME' | 'SAVG' | 'SECU' | 'SEPI' | 'TREA' | 'UNIT' | 'FNET' | 'FUTR' | 'ANTS' | 'CVCF' | 'DMEQ' | 'DNTS' | 'HLTC' | 'HLTI' | 'HSPC' | 'ICRF' | 'LTCF' | 'MAFC' | 'MARF' | 'MDCS' | 'VIEW' | 'CDEP' | 'SWFP' | 'SWPP' | 'SWRS' | 'SWUF' | 'ADCS' | 'AEMP' | 'ALLW' | 'ALMY' | 'BBSC' | 'BECH' | 'BENE' | 'BONU' | 'CCHD' | 'COMM' | 'CSLP' | 'GFRP' | 'GVEA' | 'GVEB' | 'GVEC' | 'GVED' | 'GWLT' | 'HREC' | 'PAYR' | 'PEFC' | 'PENS' | 'PRCP' | 'RHBS' | 'SALA' | 'SPSP' | 'SSBE' | 'LBIN' | 'LCOL' | 'LFEE' | 'LMEQ' | 'LMFI' | 'LMRK' | 'LREB' | 'LREV' | 'LSFL' | 'ESTX' | 'FWLV' | 'GSTX' | 'HSTX' | 'INTX' | 'NITX' | 'PTXP' | 'RDTX' | 'TAXS' | 'VATX' | 'WHLD' | 'TAXR' | 'B112' | 'BR12' | 'TLRF' | 'TLRR' | 'AIRB' | 'BUSB' | 'FERB' | 'RLWY' | 'TRPT' | 'CBTV' | 'ELEC' | 'ENRG' | 'GASB' | 'NWCH' | 'NWCM' | 'OTLC' | 'PHON' | 'UBIL' | 'WTER' | 'BOND' | 'CABD' | 'CAEQ' | 'CBCR' | 'DBCR' | 'DICL' | 'EQTS' | 'FLCR' | 'EFTC' | 'EFTD' | 'MOMA' | 'RAPI' | 'GAMB' | 'LOTT' | 'AMEX' | 'SASW' | 'AUCO' | 'PCOM' | 'PDEP' | 'PLDS' | 'PLRF' | 'GAFA' | 'GAHO' | 'CPEN' | 'DEPD' | 'RETL' | 'DEBT' | null;
347
341
  /**
348
342
  * Payment scheme or blockchain used for the payout, or null when unknown.
349
343
  */
@@ -474,11 +468,9 @@ export declare namespace PayoutFailedWebhookEvent {
474
468
  [key: string]: string;
475
469
  };
476
470
  /**
477
- * Purpose of the payout. Use an ISO 20022 external purpose code unless the
478
- * beneficiary bank country requires a national code. Only supported on fedwire and
479
- * swift payouts.
471
+ * ISO 20022 external purpose code. Only supported on fedwire and swift payouts.
480
472
  */
481
- purpose_code: 'BKDF' | 'BKFE' | 'BKFM' | 'BKIP' | 'BKPP' | 'CBLK' | 'CDCB' | 'CDCD' | 'CDCS' | 'CDDP' | 'CDOC' | 'CDQC' | 'ETUP' | 'FCOL' | 'MTUP' | 'ACCT' | 'CASH' | 'COLL' | 'CSDB' | 'DEPT' | 'INTC' | 'INTP' | 'LIMA' | 'NETT' | 'BFWD' | 'CCIR' | 'CCPC' | 'CCPM' | 'CCSM' | 'CRDS' | 'CRPR' | 'CRSP' | 'CRTL' | 'EQPT' | 'EQUS' | 'EXPT' | 'EXTD' | 'FIXI' | 'FWBC' | 'FWCC' | 'FWSB' | 'FWSC' | 'MARG' | 'MBSB' | 'MBSC' | 'MGCC' | 'MGSC' | 'OCCC' | 'OPBC' | 'OPCC' | 'OPSB' | 'OPSC' | 'OPTN' | 'OTCD' | 'REPO' | 'RPBC' | 'RPCC' | 'RPSB' | 'RPSC' | 'RVPO' | 'SBSC' | 'SCIE' | 'SCIR' | 'SCRP' | 'SHBC' | 'SHCC' | 'SHSL' | 'SLEB' | 'SLOA' | 'SWBC' | 'SWCC' | 'SWPT' | 'SWSB' | 'SWSC' | 'TBAS' | 'TBBC' | 'TBCC' | 'TRCP' | 'AGRT' | 'AREN' | 'BEXP' | 'BOCE' | 'COMC' | 'CPYR' | 'GDDS' | 'GDSV' | 'GSCB' | 'LICF' | 'MP2B' | 'POPE' | 'ROYA' | 'SCVE' | 'SERV' | 'SUBS' | 'SUPP' | 'TRAD' | 'CHAR' | 'COMT' | 'MP2P' | 'ECPG' | 'ECPR' | 'ECPU' | 'EPAY' | 'CLPR' | 'COMP' | 'DBTC' | 'GOVI' | 'HLRP' | 'HLST' | 'INPC' | 'INPR' | 'INSC' | 'INSU' | 'INTE' | 'LBRI' | 'LIFI' | 'LOAN' | 'LOAR' | 'PENO' | 'PPTI' | 'RELG' | 'RINP' | 'TRFD' | 'FORW' | 'FXNT' | 'ADMG' | 'ADVA' | 'BCDM' | 'BCFG' | 'BLDM' | 'BNET' | 'CBFF' | 'CBFR' | 'CCRD' | 'CDBL' | 'CFEE' | 'CGDD' | 'CORT' | 'COST' | 'CPKC' | 'DCRD' | 'DSMT' | 'DVPM' | 'EDUC' | 'FACT' | 'FAND' | 'FCPM' | 'FEES' | 'GIFT' | 'GOVT' | 'ICCP' | 'IDCP' | 'IHRP' | 'INSM' | 'IVPT' | 'MCDM' | 'MCFG' | 'MSVC' | 'NOWS' | 'OCDM' | 'OCFG' | 'OFEE' | 'OTHR' | 'PADD' | 'PTSP' | 'RCKE' | 'RCPT' | 'REBT' | 'REFU' | 'RENT' | 'REOD' | 'RIMB' | 'RPNT' | 'RRBN' | 'RRCT' | 'RRTP' | 'RVPM' | 'SLPI' | 'SPLT' | 'STDY' | 'TBAN' | 'TBIL' | 'TCSC' | 'TELI' | 'TMPG' | 'TPRI' | 'TPRP' | 'TRNC' | 'TRVC' | 'WEBI' | 'IPAY' | 'IPCA' | 'IPDO' | 'IPEA' | 'IPEC' | 'IPEW' | 'IPPS' | 'IPRT' | 'IPU2' | 'IPUW' | 'ANNI' | 'CAFI' | 'CFDI' | 'CMDT' | 'DERI' | 'DIVD' | 'FREX' | 'HEDG' | 'INVS' | 'PRME' | 'SAVG' | 'SECU' | 'SEPI' | 'TREA' | 'UNIT' | 'FNET' | 'FUTR' | 'ANTS' | 'CVCF' | 'DMEQ' | 'DNTS' | 'HLTC' | 'HLTI' | 'HSPC' | 'ICRF' | 'LTCF' | 'MAFC' | 'MARF' | 'MDCS' | 'VIEW' | 'CDEP' | 'SWFP' | 'SWPP' | 'SWRS' | 'SWUF' | 'ADCS' | 'AEMP' | 'ALLW' | 'ALMY' | 'BBSC' | 'BECH' | 'BENE' | 'BONU' | 'CCHD' | 'COMM' | 'CSLP' | 'GFRP' | 'GVEA' | 'GVEB' | 'GVEC' | 'GVED' | 'GWLT' | 'HREC' | 'PAYR' | 'PEFC' | 'PENS' | 'PRCP' | 'RHBS' | 'SALA' | 'SPSP' | 'SSBE' | 'LBIN' | 'LCOL' | 'LFEE' | 'LMEQ' | 'LMFI' | 'LMRK' | 'LREB' | 'LREV' | 'LSFL' | 'ESTX' | 'FWLV' | 'GSTX' | 'HSTX' | 'INTX' | 'NITX' | 'PTXP' | 'RDTX' | 'TAXS' | 'VATX' | 'WHLD' | 'TAXR' | 'B112' | 'BR12' | 'TLRF' | 'TLRR' | 'AIRB' | 'BUSB' | 'FERB' | 'RLWY' | 'TRPT' | 'CBTV' | 'ELEC' | 'ENRG' | 'GASB' | 'NWCH' | 'NWCM' | 'OTLC' | 'PHON' | 'UBIL' | 'WTER' | 'BOND' | 'CABD' | 'CAEQ' | 'CBCR' | 'DBCR' | 'DICL' | 'EQTS' | 'FLCR' | 'EFTC' | 'EFTD' | 'MOMA' | 'RAPI' | 'GAMB' | 'LOTT' | 'AMEX' | 'SASW' | 'AUCO' | 'PCOM' | 'PDEP' | 'PLDS' | 'PLRF' | 'GAFA' | 'GAHO' | 'CPEN' | 'DEPD' | 'RETL' | 'DEBT' | 'CAP' | 'GDS' | 'SRV' | 'CAC' | 'FTF' | (string & {}) | null;
473
+ purpose_code: 'BKDF' | 'BKFE' | 'BKFM' | 'BKIP' | 'BKPP' | 'CBLK' | 'CDCB' | 'CDCD' | 'CDCS' | 'CDDP' | 'CDOC' | 'CDQC' | 'ETUP' | 'FCOL' | 'MTUP' | 'ACCT' | 'CASH' | 'COLL' | 'CSDB' | 'DEPT' | 'INTC' | 'INTP' | 'LIMA' | 'NETT' | 'BFWD' | 'CCIR' | 'CCPC' | 'CCPM' | 'CCSM' | 'CRDS' | 'CRPR' | 'CRSP' | 'CRTL' | 'EQPT' | 'EQUS' | 'EXPT' | 'EXTD' | 'FIXI' | 'FWBC' | 'FWCC' | 'FWSB' | 'FWSC' | 'MARG' | 'MBSB' | 'MBSC' | 'MGCC' | 'MGSC' | 'OCCC' | 'OPBC' | 'OPCC' | 'OPSB' | 'OPSC' | 'OPTN' | 'OTCD' | 'REPO' | 'RPBC' | 'RPCC' | 'RPSB' | 'RPSC' | 'RVPO' | 'SBSC' | 'SCIE' | 'SCIR' | 'SCRP' | 'SHBC' | 'SHCC' | 'SHSL' | 'SLEB' | 'SLOA' | 'SWBC' | 'SWCC' | 'SWPT' | 'SWSB' | 'SWSC' | 'TBAS' | 'TBBC' | 'TBCC' | 'TRCP' | 'AGRT' | 'AREN' | 'BEXP' | 'BOCE' | 'COMC' | 'CPYR' | 'GDDS' | 'GDSV' | 'GSCB' | 'LICF' | 'MP2B' | 'POPE' | 'ROYA' | 'SCVE' | 'SERV' | 'SUBS' | 'SUPP' | 'TRAD' | 'CHAR' | 'COMT' | 'MP2P' | 'ECPG' | 'ECPR' | 'ECPU' | 'EPAY' | 'CLPR' | 'COMP' | 'DBTC' | 'GOVI' | 'HLRP' | 'HLST' | 'INPC' | 'INPR' | 'INSC' | 'INSU' | 'INTE' | 'LBRI' | 'LIFI' | 'LOAN' | 'LOAR' | 'PENO' | 'PPTI' | 'RELG' | 'RINP' | 'TRFD' | 'FORW' | 'FXNT' | 'ADMG' | 'ADVA' | 'BCDM' | 'BCFG' | 'BLDM' | 'BNET' | 'CBFF' | 'CBFR' | 'CCRD' | 'CDBL' | 'CFEE' | 'CGDD' | 'CORT' | 'COST' | 'CPKC' | 'DCRD' | 'DSMT' | 'DVPM' | 'EDUC' | 'FACT' | 'FAND' | 'FCPM' | 'FEES' | 'GIFT' | 'GOVT' | 'ICCP' | 'IDCP' | 'IHRP' | 'INSM' | 'IVPT' | 'MCDM' | 'MCFG' | 'MSVC' | 'NOWS' | 'OCDM' | 'OCFG' | 'OFEE' | 'OTHR' | 'PADD' | 'PTSP' | 'RCKE' | 'RCPT' | 'REBT' | 'REFU' | 'RENT' | 'REOD' | 'RIMB' | 'RPNT' | 'RRBN' | 'RRCT' | 'RRTP' | 'RVPM' | 'SLPI' | 'SPLT' | 'STDY' | 'TBAN' | 'TBIL' | 'TCSC' | 'TELI' | 'TMPG' | 'TPRI' | 'TPRP' | 'TRNC' | 'TRVC' | 'WEBI' | 'IPAY' | 'IPCA' | 'IPDO' | 'IPEA' | 'IPEC' | 'IPEW' | 'IPPS' | 'IPRT' | 'IPU2' | 'IPUW' | 'ANNI' | 'CAFI' | 'CFDI' | 'CMDT' | 'DERI' | 'DIVD' | 'FREX' | 'HEDG' | 'INVS' | 'PRME' | 'SAVG' | 'SECU' | 'SEPI' | 'TREA' | 'UNIT' | 'FNET' | 'FUTR' | 'ANTS' | 'CVCF' | 'DMEQ' | 'DNTS' | 'HLTC' | 'HLTI' | 'HSPC' | 'ICRF' | 'LTCF' | 'MAFC' | 'MARF' | 'MDCS' | 'VIEW' | 'CDEP' | 'SWFP' | 'SWPP' | 'SWRS' | 'SWUF' | 'ADCS' | 'AEMP' | 'ALLW' | 'ALMY' | 'BBSC' | 'BECH' | 'BENE' | 'BONU' | 'CCHD' | 'COMM' | 'CSLP' | 'GFRP' | 'GVEA' | 'GVEB' | 'GVEC' | 'GVED' | 'GWLT' | 'HREC' | 'PAYR' | 'PEFC' | 'PENS' | 'PRCP' | 'RHBS' | 'SALA' | 'SPSP' | 'SSBE' | 'LBIN' | 'LCOL' | 'LFEE' | 'LMEQ' | 'LMFI' | 'LMRK' | 'LREB' | 'LREV' | 'LSFL' | 'ESTX' | 'FWLV' | 'GSTX' | 'HSTX' | 'INTX' | 'NITX' | 'PTXP' | 'RDTX' | 'TAXS' | 'VATX' | 'WHLD' | 'TAXR' | 'B112' | 'BR12' | 'TLRF' | 'TLRR' | 'AIRB' | 'BUSB' | 'FERB' | 'RLWY' | 'TRPT' | 'CBTV' | 'ELEC' | 'ENRG' | 'GASB' | 'NWCH' | 'NWCM' | 'OTLC' | 'PHON' | 'UBIL' | 'WTER' | 'BOND' | 'CABD' | 'CAEQ' | 'CBCR' | 'DBCR' | 'DICL' | 'EQTS' | 'FLCR' | 'EFTC' | 'EFTD' | 'MOMA' | 'RAPI' | 'GAMB' | 'LOTT' | 'AMEX' | 'SASW' | 'AUCO' | 'PCOM' | 'PDEP' | 'PLDS' | 'PLRF' | 'GAFA' | 'GAHO' | 'CPEN' | 'DEPD' | 'RETL' | 'DEBT' | null;
482
474
  /**
483
475
  * Payment scheme or blockchain used for the payout, or null when unknown.
484
476
  */
@@ -609,11 +601,9 @@ export declare namespace PayoutReturnedWebhookEvent {
609
601
  [key: string]: string;
610
602
  };
611
603
  /**
612
- * Purpose of the payout. Use an ISO 20022 external purpose code unless the
613
- * beneficiary bank country requires a national code. Only supported on fedwire and
614
- * swift payouts.
604
+ * ISO 20022 external purpose code. Only supported on fedwire and swift payouts.
615
605
  */
616
- purpose_code: 'BKDF' | 'BKFE' | 'BKFM' | 'BKIP' | 'BKPP' | 'CBLK' | 'CDCB' | 'CDCD' | 'CDCS' | 'CDDP' | 'CDOC' | 'CDQC' | 'ETUP' | 'FCOL' | 'MTUP' | 'ACCT' | 'CASH' | 'COLL' | 'CSDB' | 'DEPT' | 'INTC' | 'INTP' | 'LIMA' | 'NETT' | 'BFWD' | 'CCIR' | 'CCPC' | 'CCPM' | 'CCSM' | 'CRDS' | 'CRPR' | 'CRSP' | 'CRTL' | 'EQPT' | 'EQUS' | 'EXPT' | 'EXTD' | 'FIXI' | 'FWBC' | 'FWCC' | 'FWSB' | 'FWSC' | 'MARG' | 'MBSB' | 'MBSC' | 'MGCC' | 'MGSC' | 'OCCC' | 'OPBC' | 'OPCC' | 'OPSB' | 'OPSC' | 'OPTN' | 'OTCD' | 'REPO' | 'RPBC' | 'RPCC' | 'RPSB' | 'RPSC' | 'RVPO' | 'SBSC' | 'SCIE' | 'SCIR' | 'SCRP' | 'SHBC' | 'SHCC' | 'SHSL' | 'SLEB' | 'SLOA' | 'SWBC' | 'SWCC' | 'SWPT' | 'SWSB' | 'SWSC' | 'TBAS' | 'TBBC' | 'TBCC' | 'TRCP' | 'AGRT' | 'AREN' | 'BEXP' | 'BOCE' | 'COMC' | 'CPYR' | 'GDDS' | 'GDSV' | 'GSCB' | 'LICF' | 'MP2B' | 'POPE' | 'ROYA' | 'SCVE' | 'SERV' | 'SUBS' | 'SUPP' | 'TRAD' | 'CHAR' | 'COMT' | 'MP2P' | 'ECPG' | 'ECPR' | 'ECPU' | 'EPAY' | 'CLPR' | 'COMP' | 'DBTC' | 'GOVI' | 'HLRP' | 'HLST' | 'INPC' | 'INPR' | 'INSC' | 'INSU' | 'INTE' | 'LBRI' | 'LIFI' | 'LOAN' | 'LOAR' | 'PENO' | 'PPTI' | 'RELG' | 'RINP' | 'TRFD' | 'FORW' | 'FXNT' | 'ADMG' | 'ADVA' | 'BCDM' | 'BCFG' | 'BLDM' | 'BNET' | 'CBFF' | 'CBFR' | 'CCRD' | 'CDBL' | 'CFEE' | 'CGDD' | 'CORT' | 'COST' | 'CPKC' | 'DCRD' | 'DSMT' | 'DVPM' | 'EDUC' | 'FACT' | 'FAND' | 'FCPM' | 'FEES' | 'GIFT' | 'GOVT' | 'ICCP' | 'IDCP' | 'IHRP' | 'INSM' | 'IVPT' | 'MCDM' | 'MCFG' | 'MSVC' | 'NOWS' | 'OCDM' | 'OCFG' | 'OFEE' | 'OTHR' | 'PADD' | 'PTSP' | 'RCKE' | 'RCPT' | 'REBT' | 'REFU' | 'RENT' | 'REOD' | 'RIMB' | 'RPNT' | 'RRBN' | 'RRCT' | 'RRTP' | 'RVPM' | 'SLPI' | 'SPLT' | 'STDY' | 'TBAN' | 'TBIL' | 'TCSC' | 'TELI' | 'TMPG' | 'TPRI' | 'TPRP' | 'TRNC' | 'TRVC' | 'WEBI' | 'IPAY' | 'IPCA' | 'IPDO' | 'IPEA' | 'IPEC' | 'IPEW' | 'IPPS' | 'IPRT' | 'IPU2' | 'IPUW' | 'ANNI' | 'CAFI' | 'CFDI' | 'CMDT' | 'DERI' | 'DIVD' | 'FREX' | 'HEDG' | 'INVS' | 'PRME' | 'SAVG' | 'SECU' | 'SEPI' | 'TREA' | 'UNIT' | 'FNET' | 'FUTR' | 'ANTS' | 'CVCF' | 'DMEQ' | 'DNTS' | 'HLTC' | 'HLTI' | 'HSPC' | 'ICRF' | 'LTCF' | 'MAFC' | 'MARF' | 'MDCS' | 'VIEW' | 'CDEP' | 'SWFP' | 'SWPP' | 'SWRS' | 'SWUF' | 'ADCS' | 'AEMP' | 'ALLW' | 'ALMY' | 'BBSC' | 'BECH' | 'BENE' | 'BONU' | 'CCHD' | 'COMM' | 'CSLP' | 'GFRP' | 'GVEA' | 'GVEB' | 'GVEC' | 'GVED' | 'GWLT' | 'HREC' | 'PAYR' | 'PEFC' | 'PENS' | 'PRCP' | 'RHBS' | 'SALA' | 'SPSP' | 'SSBE' | 'LBIN' | 'LCOL' | 'LFEE' | 'LMEQ' | 'LMFI' | 'LMRK' | 'LREB' | 'LREV' | 'LSFL' | 'ESTX' | 'FWLV' | 'GSTX' | 'HSTX' | 'INTX' | 'NITX' | 'PTXP' | 'RDTX' | 'TAXS' | 'VATX' | 'WHLD' | 'TAXR' | 'B112' | 'BR12' | 'TLRF' | 'TLRR' | 'AIRB' | 'BUSB' | 'FERB' | 'RLWY' | 'TRPT' | 'CBTV' | 'ELEC' | 'ENRG' | 'GASB' | 'NWCH' | 'NWCM' | 'OTLC' | 'PHON' | 'UBIL' | 'WTER' | 'BOND' | 'CABD' | 'CAEQ' | 'CBCR' | 'DBCR' | 'DICL' | 'EQTS' | 'FLCR' | 'EFTC' | 'EFTD' | 'MOMA' | 'RAPI' | 'GAMB' | 'LOTT' | 'AMEX' | 'SASW' | 'AUCO' | 'PCOM' | 'PDEP' | 'PLDS' | 'PLRF' | 'GAFA' | 'GAHO' | 'CPEN' | 'DEPD' | 'RETL' | 'DEBT' | 'CAP' | 'GDS' | 'SRV' | 'CAC' | 'FTF' | (string & {}) | null;
606
+ purpose_code: 'BKDF' | 'BKFE' | 'BKFM' | 'BKIP' | 'BKPP' | 'CBLK' | 'CDCB' | 'CDCD' | 'CDCS' | 'CDDP' | 'CDOC' | 'CDQC' | 'ETUP' | 'FCOL' | 'MTUP' | 'ACCT' | 'CASH' | 'COLL' | 'CSDB' | 'DEPT' | 'INTC' | 'INTP' | 'LIMA' | 'NETT' | 'BFWD' | 'CCIR' | 'CCPC' | 'CCPM' | 'CCSM' | 'CRDS' | 'CRPR' | 'CRSP' | 'CRTL' | 'EQPT' | 'EQUS' | 'EXPT' | 'EXTD' | 'FIXI' | 'FWBC' | 'FWCC' | 'FWSB' | 'FWSC' | 'MARG' | 'MBSB' | 'MBSC' | 'MGCC' | 'MGSC' | 'OCCC' | 'OPBC' | 'OPCC' | 'OPSB' | 'OPSC' | 'OPTN' | 'OTCD' | 'REPO' | 'RPBC' | 'RPCC' | 'RPSB' | 'RPSC' | 'RVPO' | 'SBSC' | 'SCIE' | 'SCIR' | 'SCRP' | 'SHBC' | 'SHCC' | 'SHSL' | 'SLEB' | 'SLOA' | 'SWBC' | 'SWCC' | 'SWPT' | 'SWSB' | 'SWSC' | 'TBAS' | 'TBBC' | 'TBCC' | 'TRCP' | 'AGRT' | 'AREN' | 'BEXP' | 'BOCE' | 'COMC' | 'CPYR' | 'GDDS' | 'GDSV' | 'GSCB' | 'LICF' | 'MP2B' | 'POPE' | 'ROYA' | 'SCVE' | 'SERV' | 'SUBS' | 'SUPP' | 'TRAD' | 'CHAR' | 'COMT' | 'MP2P' | 'ECPG' | 'ECPR' | 'ECPU' | 'EPAY' | 'CLPR' | 'COMP' | 'DBTC' | 'GOVI' | 'HLRP' | 'HLST' | 'INPC' | 'INPR' | 'INSC' | 'INSU' | 'INTE' | 'LBRI' | 'LIFI' | 'LOAN' | 'LOAR' | 'PENO' | 'PPTI' | 'RELG' | 'RINP' | 'TRFD' | 'FORW' | 'FXNT' | 'ADMG' | 'ADVA' | 'BCDM' | 'BCFG' | 'BLDM' | 'BNET' | 'CBFF' | 'CBFR' | 'CCRD' | 'CDBL' | 'CFEE' | 'CGDD' | 'CORT' | 'COST' | 'CPKC' | 'DCRD' | 'DSMT' | 'DVPM' | 'EDUC' | 'FACT' | 'FAND' | 'FCPM' | 'FEES' | 'GIFT' | 'GOVT' | 'ICCP' | 'IDCP' | 'IHRP' | 'INSM' | 'IVPT' | 'MCDM' | 'MCFG' | 'MSVC' | 'NOWS' | 'OCDM' | 'OCFG' | 'OFEE' | 'OTHR' | 'PADD' | 'PTSP' | 'RCKE' | 'RCPT' | 'REBT' | 'REFU' | 'RENT' | 'REOD' | 'RIMB' | 'RPNT' | 'RRBN' | 'RRCT' | 'RRTP' | 'RVPM' | 'SLPI' | 'SPLT' | 'STDY' | 'TBAN' | 'TBIL' | 'TCSC' | 'TELI' | 'TMPG' | 'TPRI' | 'TPRP' | 'TRNC' | 'TRVC' | 'WEBI' | 'IPAY' | 'IPCA' | 'IPDO' | 'IPEA' | 'IPEC' | 'IPEW' | 'IPPS' | 'IPRT' | 'IPU2' | 'IPUW' | 'ANNI' | 'CAFI' | 'CFDI' | 'CMDT' | 'DERI' | 'DIVD' | 'FREX' | 'HEDG' | 'INVS' | 'PRME' | 'SAVG' | 'SECU' | 'SEPI' | 'TREA' | 'UNIT' | 'FNET' | 'FUTR' | 'ANTS' | 'CVCF' | 'DMEQ' | 'DNTS' | 'HLTC' | 'HLTI' | 'HSPC' | 'ICRF' | 'LTCF' | 'MAFC' | 'MARF' | 'MDCS' | 'VIEW' | 'CDEP' | 'SWFP' | 'SWPP' | 'SWRS' | 'SWUF' | 'ADCS' | 'AEMP' | 'ALLW' | 'ALMY' | 'BBSC' | 'BECH' | 'BENE' | 'BONU' | 'CCHD' | 'COMM' | 'CSLP' | 'GFRP' | 'GVEA' | 'GVEB' | 'GVEC' | 'GVED' | 'GWLT' | 'HREC' | 'PAYR' | 'PEFC' | 'PENS' | 'PRCP' | 'RHBS' | 'SALA' | 'SPSP' | 'SSBE' | 'LBIN' | 'LCOL' | 'LFEE' | 'LMEQ' | 'LMFI' | 'LMRK' | 'LREB' | 'LREV' | 'LSFL' | 'ESTX' | 'FWLV' | 'GSTX' | 'HSTX' | 'INTX' | 'NITX' | 'PTXP' | 'RDTX' | 'TAXS' | 'VATX' | 'WHLD' | 'TAXR' | 'B112' | 'BR12' | 'TLRF' | 'TLRR' | 'AIRB' | 'BUSB' | 'FERB' | 'RLWY' | 'TRPT' | 'CBTV' | 'ELEC' | 'ENRG' | 'GASB' | 'NWCH' | 'NWCM' | 'OTLC' | 'PHON' | 'UBIL' | 'WTER' | 'BOND' | 'CABD' | 'CAEQ' | 'CBCR' | 'DBCR' | 'DICL' | 'EQTS' | 'FLCR' | 'EFTC' | 'EFTD' | 'MOMA' | 'RAPI' | 'GAMB' | 'LOTT' | 'AMEX' | 'SASW' | 'AUCO' | 'PCOM' | 'PDEP' | 'PLDS' | 'PLRF' | 'GAFA' | 'GAHO' | 'CPEN' | 'DEPD' | 'RETL' | 'DEBT' | null;
617
607
  /**
618
608
  * Payment scheme or blockchain used for the payout, or null when unknown.
619
609
  */
@@ -4415,12 +4405,19 @@ export declare namespace PayoutTrackingEventCreatedWebhookEvent {
4415
4405
  */
4416
4406
  fee: Payload.Fee | null;
4417
4407
  /**
4418
- * Institution that acted on or reported this step. Null when unknown.
4408
+ * Institution that sent the payout in this step. Null when unknown or not reported
4409
+ * by the source.
4410
+ */
4411
+ from_institution: Payload.FromInstitution | null;
4412
+ /**
4413
+ * Institution holding the payout after this step: the bank that received it, or
4414
+ * the bank that reported this status. Null when unknown.
4419
4415
  */
4420
4416
  institution: Payload.Institution | null;
4421
4417
  /**
4422
- * Whether Augustus considers delivery finished. A later event, such as returned,
4423
- * can still follow.
4418
+ * Whether Augustus considers delivery finished. A credit reported by a bank that
4419
+ * passes the payout on is a forwarded step and is not terminal. A later event,
4420
+ * such as returned, can still follow.
4424
4421
  */
4425
4422
  is_terminal: boolean;
4426
4423
  /**
@@ -4501,17 +4498,56 @@ export declare namespace PayoutTrackingEventCreatedWebhookEvent {
4501
4498
  currency: string;
4502
4499
  }
4503
4500
  /**
4504
- * Institution that acted on or reported this step. Null when unknown.
4501
+ * Institution that sent the payout in this step. Null when unknown or not reported
4502
+ * by the source.
4503
+ */
4504
+ interface FromInstitution {
4505
+ /**
4506
+ * Identifier of the institution, typed by scheme. Null when only its name is
4507
+ * known.
4508
+ */
4509
+ identifier: FromInstitution.Identifier | null;
4510
+ /**
4511
+ * Name of the institution. Null when unknown.
4512
+ */
4513
+ name: string | null;
4514
+ }
4515
+ namespace FromInstitution {
4516
+ /**
4517
+ * Identifier of the institution, typed by scheme. Null when only its name is
4518
+ * known.
4519
+ */
4520
+ interface Identifier {
4521
+ /**
4522
+ * Identifier scheme. Only bic today.
4523
+ */
4524
+ type: 'bic';
4525
+ /**
4526
+ * ISO 9362 Bank Identifier Code, always 11 characters. An 8-character BIC is
4527
+ * padded with the XXX head office branch code.
4528
+ */
4529
+ value: string;
4530
+ }
4531
+ }
4532
+ /**
4533
+ * Institution holding the payout after this step: the bank that received it, or
4534
+ * the bank that reported this status. Null when unknown.
4505
4535
  */
4506
4536
  interface Institution {
4507
4537
  /**
4508
- * Identifier of the institution, typed by scheme.
4538
+ * Identifier of the institution, typed by scheme. Null when only its name is
4539
+ * known.
4540
+ */
4541
+ identifier: Institution.Identifier | null;
4542
+ /**
4543
+ * Name of the institution. Null when unknown.
4509
4544
  */
4510
- identifier: Institution.Identifier;
4545
+ name: string | null;
4511
4546
  }
4512
4547
  namespace Institution {
4513
4548
  /**
4514
- * Identifier of the institution, typed by scheme.
4549
+ * Identifier of the institution, typed by scheme. Null when only its name is
4550
+ * known.
4515
4551
  */
4516
4552
  interface Identifier {
4517
4553
  /**
@@ -4519,7 +4555,8 @@ export declare namespace PayoutTrackingEventCreatedWebhookEvent {
4519
4555
  */
4520
4556
  type: 'bic';
4521
4557
  /**
4522
- * ISO 9362 Bank Identifier Code (8 or 11 characters).
4558
+ * ISO 9362 Bank Identifier Code, always 11 characters. An 8-character BIC is
4559
+ * padded with the XXX head office branch code.
4523
4560
  */
4524
4561
  value: string;
4525
4562
  }
@@ -4542,7 +4579,8 @@ export declare namespace PayoutTrackingEventCreatedWebhookEvent {
4542
4579
  */
4543
4580
  interface StatusReason {
4544
4581
  /**
4545
- * Normalized reason code assigned by Augustus. New codes may be added.
4582
+ * Normalized reason code assigned by Augustus. Current codes: `CREDIT_PENDING`
4583
+ * (the beneficiary bank reported the credit as pending). New codes may be added.
4546
4584
  */
4547
4585
  code: string;
4548
4586
  /**