@augustusbank/typescript-sdk 0.31.0 → 0.33.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.
- package/CHANGELOG.md +14 -0
- package/client.d.mts +7 -4
- package/client.d.mts.map +1 -1
- package/client.d.ts +7 -4
- package/client.d.ts.map +1 -1
- package/client.js +3 -0
- package/client.js.map +1 -1
- package/client.mjs +3 -0
- package/client.mjs.map +1 -1
- package/package.json +1 -1
- package/resources/accounts.d.mts +24 -6
- package/resources/accounts.d.mts.map +1 -1
- package/resources/accounts.d.ts +24 -6
- package/resources/accounts.d.ts.map +1 -1
- package/resources/api-keys.d.mts +1 -1
- package/resources/api-keys.d.mts.map +1 -1
- package/resources/api-keys.d.ts +1 -1
- package/resources/api-keys.d.ts.map +1 -1
- package/resources/counterparties.d.mts +227 -12
- package/resources/counterparties.d.mts.map +1 -1
- package/resources/counterparties.d.ts +227 -12
- package/resources/counterparties.d.ts.map +1 -1
- package/resources/counterparties.js +16 -0
- package/resources/counterparties.js.map +1 -1
- package/resources/counterparties.mjs +16 -0
- package/resources/counterparties.mjs.map +1 -1
- package/resources/events.d.mts +3 -3
- package/resources/events.d.mts.map +1 -1
- package/resources/events.d.ts +3 -3
- package/resources/events.d.ts.map +1 -1
- package/resources/index.d.mts +3 -2
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +3 -2
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js +3 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +1 -0
- package/resources/index.mjs.map +1 -1
- package/resources/payout-tracking-events.d.mts +358 -0
- package/resources/payout-tracking-events.d.mts.map +1 -0
- package/resources/payout-tracking-events.d.ts +358 -0
- package/resources/payout-tracking-events.d.ts.map +1 -0
- package/resources/payout-tracking-events.js +23 -0
- package/resources/payout-tracking-events.js.map +1 -0
- package/resources/payout-tracking-events.mjs +19 -0
- package/resources/payout-tracking-events.mjs.map +1 -0
- package/resources/payouts.d.mts +24 -0
- package/resources/payouts.d.mts.map +1 -1
- package/resources/payouts.d.ts +24 -0
- package/resources/payouts.d.ts.map +1 -1
- package/resources/scopes.d.mts +1 -1
- package/resources/scopes.d.mts.map +1 -1
- package/resources/scopes.d.ts +1 -1
- package/resources/scopes.d.ts.map +1 -1
- package/resources/transactions.d.mts +4 -4
- package/resources/transactions.d.ts +4 -4
- package/resources/webhook-subscriptions.d.mts +8 -8
- package/resources/webhook-subscriptions.d.mts.map +1 -1
- package/resources/webhook-subscriptions.d.ts +8 -8
- package/resources/webhook-subscriptions.d.ts.map +1 -1
- package/resources/webhooks.d.mts +226 -14
- package/resources/webhooks.d.mts.map +1 -1
- package/resources/webhooks.d.ts +226 -14
- package/resources/webhooks.d.ts.map +1 -1
- package/src/client.ts +21 -0
- package/src/resources/accounts.ts +24 -6
- package/src/resources/api-keys.ts +1 -0
- package/src/resources/counterparties.ts +536 -12
- package/src/resources/events.ts +3 -0
- package/src/resources/index.ts +9 -0
- package/src/resources/payout-tracking-events.ts +479 -0
- package/src/resources/payouts.ts +1368 -0
- package/src/resources/scopes.ts +2 -1
- package/src/resources/transactions.ts +4 -4
- package/src/resources/webhook-subscriptions.ts +8 -0
- package/src/resources/webhooks.ts +1951 -12
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
package/resources/webhooks.d.ts
CHANGED
|
@@ -68,6 +68,12 @@ export declare namespace PayoutInitiatedWebhookEvent {
|
|
|
68
68
|
metadata: {
|
|
69
69
|
[key: string]: string;
|
|
70
70
|
};
|
|
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.
|
|
75
|
+
*/
|
|
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;
|
|
71
77
|
/**
|
|
72
78
|
* Payment scheme or blockchain used for the payout, or null when unknown.
|
|
73
79
|
*/
|
|
@@ -197,6 +203,12 @@ export declare namespace PayoutSubmittedWebhookEvent {
|
|
|
197
203
|
metadata: {
|
|
198
204
|
[key: string]: string;
|
|
199
205
|
};
|
|
206
|
+
/**
|
|
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.
|
|
210
|
+
*/
|
|
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;
|
|
200
212
|
/**
|
|
201
213
|
* Payment scheme or blockchain used for the payout, or null when unknown.
|
|
202
214
|
*/
|
|
@@ -326,6 +338,12 @@ export declare namespace PayoutSentWebhookEvent {
|
|
|
326
338
|
metadata: {
|
|
327
339
|
[key: string]: string;
|
|
328
340
|
};
|
|
341
|
+
/**
|
|
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.
|
|
345
|
+
*/
|
|
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;
|
|
329
347
|
/**
|
|
330
348
|
* Payment scheme or blockchain used for the payout, or null when unknown.
|
|
331
349
|
*/
|
|
@@ -455,6 +473,12 @@ export declare namespace PayoutFailedWebhookEvent {
|
|
|
455
473
|
metadata: {
|
|
456
474
|
[key: string]: string;
|
|
457
475
|
};
|
|
476
|
+
/**
|
|
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.
|
|
480
|
+
*/
|
|
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;
|
|
458
482
|
/**
|
|
459
483
|
* Payment scheme or blockchain used for the payout, or null when unknown.
|
|
460
484
|
*/
|
|
@@ -584,6 +608,12 @@ export declare namespace PayoutReturnedWebhookEvent {
|
|
|
584
608
|
metadata: {
|
|
585
609
|
[key: string]: string;
|
|
586
610
|
};
|
|
611
|
+
/**
|
|
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.
|
|
615
|
+
*/
|
|
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;
|
|
587
617
|
/**
|
|
588
618
|
* Payment scheme or blockchain used for the payout, or null when unknown.
|
|
589
619
|
*/
|
|
@@ -3040,9 +3070,9 @@ export declare namespace CounterpartyPendingWebhookEvent {
|
|
|
3040
3070
|
*/
|
|
3041
3071
|
email: string | null;
|
|
3042
3072
|
/**
|
|
3043
|
-
*
|
|
3073
|
+
* Classification of the counterparty.
|
|
3044
3074
|
*/
|
|
3045
|
-
entity_type: 'business' | 'individual';
|
|
3075
|
+
entity_type: 'business' | 'individual' | 'non_profit' | 'sole_proprietor';
|
|
3046
3076
|
/**
|
|
3047
3077
|
* Financial address of the counterparty.
|
|
3048
3078
|
*/
|
|
@@ -3264,9 +3294,9 @@ export declare namespace CounterpartyActiveWebhookEvent {
|
|
|
3264
3294
|
*/
|
|
3265
3295
|
email: string | null;
|
|
3266
3296
|
/**
|
|
3267
|
-
*
|
|
3297
|
+
* Classification of the counterparty.
|
|
3268
3298
|
*/
|
|
3269
|
-
entity_type: 'business' | 'individual';
|
|
3299
|
+
entity_type: 'business' | 'individual' | 'non_profit' | 'sole_proprietor';
|
|
3270
3300
|
/**
|
|
3271
3301
|
* Financial address of the counterparty.
|
|
3272
3302
|
*/
|
|
@@ -3488,9 +3518,9 @@ export declare namespace CounterpartyRejectedWebhookEvent {
|
|
|
3488
3518
|
*/
|
|
3489
3519
|
email: string | null;
|
|
3490
3520
|
/**
|
|
3491
|
-
*
|
|
3521
|
+
* Classification of the counterparty.
|
|
3492
3522
|
*/
|
|
3493
|
-
entity_type: 'business' | 'individual';
|
|
3523
|
+
entity_type: 'business' | 'individual' | 'non_profit' | 'sole_proprietor';
|
|
3494
3524
|
/**
|
|
3495
3525
|
* Financial address of the counterparty.
|
|
3496
3526
|
*/
|
|
@@ -3712,9 +3742,9 @@ export declare namespace CounterpartyBlockedWebhookEvent {
|
|
|
3712
3742
|
*/
|
|
3713
3743
|
email: string | null;
|
|
3714
3744
|
/**
|
|
3715
|
-
*
|
|
3745
|
+
* Classification of the counterparty.
|
|
3716
3746
|
*/
|
|
3717
|
-
entity_type: 'business' | 'individual';
|
|
3747
|
+
entity_type: 'business' | 'individual' | 'non_profit' | 'sole_proprietor';
|
|
3718
3748
|
/**
|
|
3719
3749
|
* Financial address of the counterparty.
|
|
3720
3750
|
*/
|
|
@@ -3936,9 +3966,9 @@ export declare namespace CounterpartyUnblockedWebhookEvent {
|
|
|
3936
3966
|
*/
|
|
3937
3967
|
email: string | null;
|
|
3938
3968
|
/**
|
|
3939
|
-
*
|
|
3969
|
+
* Classification of the counterparty.
|
|
3940
3970
|
*/
|
|
3941
|
-
entity_type: 'business' | 'individual';
|
|
3971
|
+
entity_type: 'business' | 'individual' | 'non_profit' | 'sole_proprietor';
|
|
3942
3972
|
/**
|
|
3943
3973
|
* Financial address of the counterparty.
|
|
3944
3974
|
*/
|
|
@@ -4160,9 +4190,9 @@ export declare namespace CounterpartyUpdatedWebhookEvent {
|
|
|
4160
4190
|
*/
|
|
4161
4191
|
email: string | null;
|
|
4162
4192
|
/**
|
|
4163
|
-
*
|
|
4193
|
+
* Classification of the counterparty.
|
|
4164
4194
|
*/
|
|
4165
|
-
entity_type: 'business' | 'individual';
|
|
4195
|
+
entity_type: 'business' | 'individual' | 'non_profit' | 'sole_proprietor';
|
|
4166
4196
|
/**
|
|
4167
4197
|
* Financial address of the counterparty.
|
|
4168
4198
|
*/
|
|
@@ -4340,6 +4370,188 @@ export declare namespace CounterpartyUpdatedWebhookEvent {
|
|
|
4340
4370
|
}
|
|
4341
4371
|
}
|
|
4342
4372
|
}
|
|
4373
|
+
export interface PayoutTrackingEventCreatedWebhookEvent {
|
|
4374
|
+
/**
|
|
4375
|
+
* Unique identifier for the event. Stable across retries.
|
|
4376
|
+
*/
|
|
4377
|
+
id: string;
|
|
4378
|
+
/**
|
|
4379
|
+
* API version the payload was rendered at. Stable across retries and redeliveries.
|
|
4380
|
+
*/
|
|
4381
|
+
api_version: string;
|
|
4382
|
+
/**
|
|
4383
|
+
* ISO 8601 UTC timestamp when the event was created.
|
|
4384
|
+
*/
|
|
4385
|
+
date: string;
|
|
4386
|
+
/**
|
|
4387
|
+
* Full resource snapshot at the time of the event.
|
|
4388
|
+
*/
|
|
4389
|
+
payload: PayoutTrackingEventCreatedWebhookEvent.Payload;
|
|
4390
|
+
/**
|
|
4391
|
+
* Event type in resource.action format.
|
|
4392
|
+
*/
|
|
4393
|
+
type: 'payout_tracking_event.created';
|
|
4394
|
+
}
|
|
4395
|
+
export declare namespace PayoutTrackingEventCreatedWebhookEvent {
|
|
4396
|
+
/**
|
|
4397
|
+
* Full resource snapshot at the time of the event.
|
|
4398
|
+
*/
|
|
4399
|
+
interface Payload {
|
|
4400
|
+
/**
|
|
4401
|
+
* Unique identifier of the tracking event.
|
|
4402
|
+
*/
|
|
4403
|
+
id: string;
|
|
4404
|
+
/**
|
|
4405
|
+
* Amount credited to the beneficiary. Set only on a credited event, otherwise
|
|
4406
|
+
* null.
|
|
4407
|
+
*/
|
|
4408
|
+
beneficiary_amount: Payload.BeneficiaryAmount | null;
|
|
4409
|
+
/**
|
|
4410
|
+
* ISO 8601 UTC timestamp when Augustus recorded the event.
|
|
4411
|
+
*/
|
|
4412
|
+
created_at: string;
|
|
4413
|
+
/**
|
|
4414
|
+
* Fee deducted at this step. Null when none was reported.
|
|
4415
|
+
*/
|
|
4416
|
+
fee: Payload.Fee | null;
|
|
4417
|
+
/**
|
|
4418
|
+
* Institution that acted on or reported this step. Null when unknown.
|
|
4419
|
+
*/
|
|
4420
|
+
institution: Payload.Institution | null;
|
|
4421
|
+
/**
|
|
4422
|
+
* Whether Augustus considers delivery finished. A later event, such as returned,
|
|
4423
|
+
* can still follow.
|
|
4424
|
+
*/
|
|
4425
|
+
is_terminal: boolean;
|
|
4426
|
+
/**
|
|
4427
|
+
* Normalized point in the payout journey. New values may be added.
|
|
4428
|
+
*/
|
|
4429
|
+
milestone: 'initiated' | 'submitted' | 'sent' | 'failed' | 'returned' | 'accepted' | 'settled' | 'forwarded' | 'credited' | 'rejected' | 'returning' | 'visibility_lost' | 'other';
|
|
4430
|
+
/**
|
|
4431
|
+
* Raw network status. Null when the step has none.
|
|
4432
|
+
*/
|
|
4433
|
+
network_status: Payload.NetworkStatus | null;
|
|
4434
|
+
/**
|
|
4435
|
+
* ISO 8601 UTC timestamp when the step happened. Null when the source has no
|
|
4436
|
+
* timestamp. Can be out of order with sequence.
|
|
4437
|
+
*/
|
|
4438
|
+
occurred_at: string | null;
|
|
4439
|
+
/**
|
|
4440
|
+
* ID of the payout this event belongs to.
|
|
4441
|
+
*/
|
|
4442
|
+
payout_id: string;
|
|
4443
|
+
/**
|
|
4444
|
+
* How far Augustus can follow the payout: end_to_end when the rail confirms the
|
|
4445
|
+
* beneficiary credit, network when it only confirms settlement. New values may be
|
|
4446
|
+
* added.
|
|
4447
|
+
*/
|
|
4448
|
+
scope: 'network' | 'end_to_end';
|
|
4449
|
+
/**
|
|
4450
|
+
* Gap-free counter per payout, in the order Augustus recorded the events. A gap
|
|
4451
|
+
* means you missed a recorded event, such as a dropped webhook. A sequence without
|
|
4452
|
+
* gaps does not mean every network step was observed.
|
|
4453
|
+
*/
|
|
4454
|
+
sequence: number;
|
|
4455
|
+
/**
|
|
4456
|
+
* Where Augustus learned this step: augustus for steps Augustus records itself,
|
|
4457
|
+
* swift_gpi for SWIFT gpi statuses, other for any other source. New values may be
|
|
4458
|
+
* added.
|
|
4459
|
+
*/
|
|
4460
|
+
source: 'augustus' | 'swift_gpi' | 'other';
|
|
4461
|
+
/**
|
|
4462
|
+
* Reason for the current state. Null when none applies.
|
|
4463
|
+
*/
|
|
4464
|
+
status_reason: Payload.StatusReason | null;
|
|
4465
|
+
/**
|
|
4466
|
+
* Resource type discriminator.
|
|
4467
|
+
*/
|
|
4468
|
+
type: 'payout_tracking_event';
|
|
4469
|
+
}
|
|
4470
|
+
namespace Payload {
|
|
4471
|
+
/**
|
|
4472
|
+
* Amount credited to the beneficiary. Set only on a credited event, otherwise
|
|
4473
|
+
* null.
|
|
4474
|
+
*/
|
|
4475
|
+
interface BeneficiaryAmount {
|
|
4476
|
+
/**
|
|
4477
|
+
* Credited amount as a string decimal (e.g. "100.50").
|
|
4478
|
+
*/
|
|
4479
|
+
amount: string;
|
|
4480
|
+
/**
|
|
4481
|
+
* ISO 4217 currency code of the credited amount.
|
|
4482
|
+
*/
|
|
4483
|
+
currency: string;
|
|
4484
|
+
}
|
|
4485
|
+
/**
|
|
4486
|
+
* Fee deducted at this step. Null when none was reported.
|
|
4487
|
+
*/
|
|
4488
|
+
interface Fee {
|
|
4489
|
+
/**
|
|
4490
|
+
* Fee amount as a string decimal (e.g. "10.00").
|
|
4491
|
+
*/
|
|
4492
|
+
amount: string;
|
|
4493
|
+
/**
|
|
4494
|
+
* Who bears the charges under the payment charge agreement: debtor (OUR), creditor
|
|
4495
|
+
* (BEN), shared (SHA), or other for any other agreement. New values may be added.
|
|
4496
|
+
*/
|
|
4497
|
+
borne_by: 'debtor' | 'creditor' | 'shared' | 'other';
|
|
4498
|
+
/**
|
|
4499
|
+
* ISO 4217 currency code of the fee.
|
|
4500
|
+
*/
|
|
4501
|
+
currency: string;
|
|
4502
|
+
}
|
|
4503
|
+
/**
|
|
4504
|
+
* Institution that acted on or reported this step. Null when unknown.
|
|
4505
|
+
*/
|
|
4506
|
+
interface Institution {
|
|
4507
|
+
/**
|
|
4508
|
+
* Identifier of the institution, typed by scheme.
|
|
4509
|
+
*/
|
|
4510
|
+
identifier: Institution.Identifier;
|
|
4511
|
+
}
|
|
4512
|
+
namespace Institution {
|
|
4513
|
+
/**
|
|
4514
|
+
* Identifier of the institution, typed by scheme.
|
|
4515
|
+
*/
|
|
4516
|
+
interface Identifier {
|
|
4517
|
+
/**
|
|
4518
|
+
* Identifier scheme. Only bic today.
|
|
4519
|
+
*/
|
|
4520
|
+
type: 'bic';
|
|
4521
|
+
/**
|
|
4522
|
+
* ISO 9362 Bank Identifier Code (8 or 11 characters).
|
|
4523
|
+
*/
|
|
4524
|
+
value: string;
|
|
4525
|
+
}
|
|
4526
|
+
}
|
|
4527
|
+
/**
|
|
4528
|
+
* Raw network status. Null when the step has none.
|
|
4529
|
+
*/
|
|
4530
|
+
interface NetworkStatus {
|
|
4531
|
+
/**
|
|
4532
|
+
* Status code reported by the network, such as ACSP, ACSC, ACCC or RJCT.
|
|
4533
|
+
*/
|
|
4534
|
+
code: string;
|
|
4535
|
+
/**
|
|
4536
|
+
* Reason code for the status, such as G000. Null when the network reports none.
|
|
4537
|
+
*/
|
|
4538
|
+
reason_code: string | null;
|
|
4539
|
+
}
|
|
4540
|
+
/**
|
|
4541
|
+
* Reason for the current state. Null when none applies.
|
|
4542
|
+
*/
|
|
4543
|
+
interface StatusReason {
|
|
4544
|
+
/**
|
|
4545
|
+
* Normalized reason code assigned by Augustus. New codes may be added.
|
|
4546
|
+
*/
|
|
4547
|
+
code: string;
|
|
4548
|
+
/**
|
|
4549
|
+
* Explanation of the reason code, written by Augustus.
|
|
4550
|
+
*/
|
|
4551
|
+
description: string;
|
|
4552
|
+
}
|
|
4553
|
+
}
|
|
4554
|
+
}
|
|
4343
4555
|
export interface PingTestWebhookEvent {
|
|
4344
4556
|
/**
|
|
4345
4557
|
* Unique identifier for the event. Stable across retries.
|
|
@@ -4390,8 +4602,8 @@ export declare namespace PingTestWebhookEvent {
|
|
|
4390
4602
|
type: 'ping';
|
|
4391
4603
|
}
|
|
4392
4604
|
}
|
|
4393
|
-
export type UnwrapWebhookEvent = PayoutInitiatedWebhookEvent | PayoutSubmittedWebhookEvent | PayoutSentWebhookEvent | PayoutFailedWebhookEvent | PayoutReturnedWebhookEvent | ReturnInitiatedWebhookEvent | ReturnSubmittedWebhookEvent | ReturnSentWebhookEvent | ReturnFailedWebhookEvent | ReturnReturnedWebhookEvent | DepositSettledWebhookEvent | ConversionCreatedWebhookEvent | ConversionCompletedWebhookEvent | ConversionFailedWebhookEvent | AccountHolderActiveWebhookEvent | AccountHolderClosedWebhookEvent | CounterpartyPendingWebhookEvent | CounterpartyActiveWebhookEvent | CounterpartyRejectedWebhookEvent | CounterpartyBlockedWebhookEvent | CounterpartyUnblockedWebhookEvent | CounterpartyUpdatedWebhookEvent | PingTestWebhookEvent;
|
|
4605
|
+
export type UnwrapWebhookEvent = PayoutInitiatedWebhookEvent | PayoutSubmittedWebhookEvent | PayoutSentWebhookEvent | PayoutFailedWebhookEvent | PayoutReturnedWebhookEvent | ReturnInitiatedWebhookEvent | ReturnSubmittedWebhookEvent | ReturnSentWebhookEvent | ReturnFailedWebhookEvent | ReturnReturnedWebhookEvent | DepositSettledWebhookEvent | ConversionCreatedWebhookEvent | ConversionCompletedWebhookEvent | ConversionFailedWebhookEvent | AccountHolderActiveWebhookEvent | AccountHolderClosedWebhookEvent | CounterpartyPendingWebhookEvent | CounterpartyActiveWebhookEvent | CounterpartyRejectedWebhookEvent | CounterpartyBlockedWebhookEvent | CounterpartyUnblockedWebhookEvent | CounterpartyUpdatedWebhookEvent | PayoutTrackingEventCreatedWebhookEvent | PingTestWebhookEvent;
|
|
4394
4606
|
export declare namespace Webhooks {
|
|
4395
|
-
export { type PayoutInitiatedWebhookEvent as PayoutInitiatedWebhookEvent, type PayoutSubmittedWebhookEvent as PayoutSubmittedWebhookEvent, type PayoutSentWebhookEvent as PayoutSentWebhookEvent, type PayoutFailedWebhookEvent as PayoutFailedWebhookEvent, type PayoutReturnedWebhookEvent as PayoutReturnedWebhookEvent, type ReturnInitiatedWebhookEvent as ReturnInitiatedWebhookEvent, type ReturnSubmittedWebhookEvent as ReturnSubmittedWebhookEvent, type ReturnSentWebhookEvent as ReturnSentWebhookEvent, type ReturnFailedWebhookEvent as ReturnFailedWebhookEvent, type ReturnReturnedWebhookEvent as ReturnReturnedWebhookEvent, type DepositSettledWebhookEvent as DepositSettledWebhookEvent, type ConversionCreatedWebhookEvent as ConversionCreatedWebhookEvent, type ConversionCompletedWebhookEvent as ConversionCompletedWebhookEvent, type ConversionFailedWebhookEvent as ConversionFailedWebhookEvent, type AccountHolderActiveWebhookEvent as AccountHolderActiveWebhookEvent, type AccountHolderClosedWebhookEvent as AccountHolderClosedWebhookEvent, type CounterpartyPendingWebhookEvent as CounterpartyPendingWebhookEvent, type CounterpartyActiveWebhookEvent as CounterpartyActiveWebhookEvent, type CounterpartyRejectedWebhookEvent as CounterpartyRejectedWebhookEvent, type CounterpartyBlockedWebhookEvent as CounterpartyBlockedWebhookEvent, type CounterpartyUnblockedWebhookEvent as CounterpartyUnblockedWebhookEvent, type CounterpartyUpdatedWebhookEvent as CounterpartyUpdatedWebhookEvent, type PingTestWebhookEvent as PingTestWebhookEvent, type UnwrapWebhookEvent as UnwrapWebhookEvent, };
|
|
4607
|
+
export { type PayoutInitiatedWebhookEvent as PayoutInitiatedWebhookEvent, type PayoutSubmittedWebhookEvent as PayoutSubmittedWebhookEvent, type PayoutSentWebhookEvent as PayoutSentWebhookEvent, type PayoutFailedWebhookEvent as PayoutFailedWebhookEvent, type PayoutReturnedWebhookEvent as PayoutReturnedWebhookEvent, type ReturnInitiatedWebhookEvent as ReturnInitiatedWebhookEvent, type ReturnSubmittedWebhookEvent as ReturnSubmittedWebhookEvent, type ReturnSentWebhookEvent as ReturnSentWebhookEvent, type ReturnFailedWebhookEvent as ReturnFailedWebhookEvent, type ReturnReturnedWebhookEvent as ReturnReturnedWebhookEvent, type DepositSettledWebhookEvent as DepositSettledWebhookEvent, type ConversionCreatedWebhookEvent as ConversionCreatedWebhookEvent, type ConversionCompletedWebhookEvent as ConversionCompletedWebhookEvent, type ConversionFailedWebhookEvent as ConversionFailedWebhookEvent, type AccountHolderActiveWebhookEvent as AccountHolderActiveWebhookEvent, type AccountHolderClosedWebhookEvent as AccountHolderClosedWebhookEvent, type CounterpartyPendingWebhookEvent as CounterpartyPendingWebhookEvent, type CounterpartyActiveWebhookEvent as CounterpartyActiveWebhookEvent, type CounterpartyRejectedWebhookEvent as CounterpartyRejectedWebhookEvent, type CounterpartyBlockedWebhookEvent as CounterpartyBlockedWebhookEvent, type CounterpartyUnblockedWebhookEvent as CounterpartyUnblockedWebhookEvent, type CounterpartyUpdatedWebhookEvent as CounterpartyUpdatedWebhookEvent, type PayoutTrackingEventCreatedWebhookEvent as PayoutTrackingEventCreatedWebhookEvent, type PingTestWebhookEvent as PingTestWebhookEvent, type UnwrapWebhookEvent as UnwrapWebhookEvent, };
|
|
4396
4608
|
}
|
|
4397
4609
|
//# sourceMappingURL=webhooks.d.ts.map
|