Global Accounts
Subscribe to webhook events for Global Account status changes.
The following webhook events are available for your Accounts integration.
Global Account statuses
This section describes Global Account status webhooks, which are only applicable for API version 2025-04-25 and later.
| Event | Description |
|---|---|
| global_account.active | Global Account is active and can be used. |
| global_account.closed | Global Account has been closed. |
| global_account.failed | Global Account creation has failed. |
Global Account deposits
This section describes the Global account deposit webhook, which are only applicable for API version 2025-02-14 and before.
| Event | Description |
|---|---|
| ga.new | Deposit received via Global Account, pending settlement to Wallet balance. |
Payload examples
Global Account statuses
This section describes Global Account status webhooks, which are only applicable for API version 2025-04-25 and later.
global_account.active
1{2 "accountId":"acct_TOslkS7-MnyXlQuV8Lb4og",3 "data":Object{...},4 "id":"86b69f91-06f0-3fe8-8faf-4de58954ca8e",5 "name":"global_account.active"6}
data is the item of Get global account by ID API:
1{2 "account_name": "John Smith",3 "account_number": "03345102",4 "account_type": "Checking",5 "alternate_account_identifiers": {6 "email": "[email protected]"7 },8 "country_code": "GB",9 "iban": "GB06MODR00000003345102",10 "id": "7f687fe6-dcf4-4462-92fa-80335301d9d2",11 "institution": {12 "address": "58 Wood Ln",13 "city": "London",14 "name": "Modulr FS Limited",15 "zip_code": "W12 7RZ"16 },17 "nick_name": "GBP GA",18 "request_id": "8d411ad4-aed6-1261-92fa-51225212e2e1",19 "required_features": [20 {21 "currency": "GBP",22 "transfer_method": "LOCAL"23 }24 ],25 "status": "ACTIVE",26 "supported_features": [27 {28 "currency": "GBP",29 "local_clearing_system": "BACS",30 "routing_codes": [31 {32 "type": "sort_code",33 "value": "000000"34 }35 ],36 "transfer_method": "LOCAL",37 "type": "DEPOSIT"38 }39 ],40 "swift_code": "MODRGB21"41}42
global_account.closed
1{2 "accountId":"acct_TOslkS7-MnyXlQuV8Lb4og",3 "data":Object{...},4 "id":"86b69f91-06f0-3fe8-8faf-4de58954ca8e",5 "name":"global_account.closed"6}
data is the item of Get global account by ID API:
1{2 "account_name": "John Smith",3 "account_number": "03345102",4 "account_type": "Checking",5 "alternate_account_identifiers": {6 "email": "[email protected]"7 },8 "country_code": "GB",9 "iban": "GB06MODR00000003345102",10 "id": "7f687fe6-dcf4-4462-92fa-80335301d9d2",11 "institution": {12 "address": "58 Wood Ln",13 "city": "London",14 "name": "Modulr FS Limited",15 "zip_code": "W12 7RZ"16 },17 "nick_name": "GBP GA",18 "request_id": "8d411ad4-aed6-1261-92fa-51225212e2e1",19 "required_features": [20 {21 "currency": "GBP",22 "transfer_method": "LOCAL"23 }24 ],25 "status": "CLOSED",26 "close_reason": "Closed upon customer request.",27 "supported_features": [28 {29 "currency": "GBP",30 "local_clearing_system": "BACS",31 "routing_codes": [32 {33 "type": "sort_code",34 "value": "000000"35 }36 ],37 "transfer_method": "LOCAL",38 "type": "DEPOSIT"39 }40 ],41 "swift_code": "MODRGB21"42}
global_account.failed
1{2 "accountId":"acct_TOslkS7-MnyXlQuV8Lb4og",3 "data":Object{...},4 "id":"86b69f91-06f0-3fe8-8faf-4de58954ca8e",5 "name":"global_account.failed"6}
data is the item of Get global account by ID API:
1{2 "account_name": "John Smith",3 "account_number": "03345102",4 "account_type": "Checking",5 "alternate_account_identifiers": {6 "email": "[email protected]"7 },8 "country_code": "GB",9 "iban": "GB06MODR00000003345102",10 "id": "7f687fe6-dcf4-4462-92fa-80335301d9d2",11 "institution": {12 "address": "58 Wood Ln",13 "city": "London",14 "name": "Modulr FS Limited",15 "zip_code": "W12 7RZ"16 },17 "nick_name": "GBP GA",18 "request_id": "8d411ad4-aed6-1261-92fa-51225212e2e1",19 "required_features": [20 {21 "currency": "GBP",22 "transfer_method": "LOCAL"23 }24 ],25 "status": "FAILED",26 "failure_reason": "Your Global Account creation request has been rejected by the Institution. Please contact our support team for further assistance.",27 "supported_features": [28 {29 "currency": "GBP",30 "local_clearing_system": "BACS",31 "routing_codes": [32 {33 "type": "sort_code",34 "value": "000000"35 }36 ],37 "transfer_method": "LOCAL",38 "type": "DEPOSIT"39 }40 ],41 "swift_code": "MODRGB21"42}
Global Account deposits
This section describes the Global account deposit webhook, which are only applicable for API version 2025-02-14 and before.
1{2 "accountId":"acct_TOslkS7-MnyXlQuV8Lb4og",3 "data":Object{...},4 "id":"86b69f91-06f0-3fe8-8faf-4de58954ca8e",5 "name":"ga.new"6}
data is the item of Get global account transactions API:
1{2 "has_more": false,3 "items": [4 {5 "amount": 10000,6 "create_time": "2017-03-22T16:08:02+1100",7 "currency": "AUD",8 "description": "string",9 "fee_amount": 10,10 "fee_currency": "AUD",11 "id": "90b98dc6-63a0-403f-816b-ac5305b42a11",12 "payer_country": "US",13 "payer_name": "AMZNnt70paD1",14 "status": "NEW",15 "type": "CREDIT"16 }17 ]18}