Deposits
You can receive funds into your Airwallex Wallet via bank transfers to Global Accounts or direct debits from Linked Accounts.
The Global Accounts deposit simulation API allows you to simulate a deposit from an external bank account in the sandbox environment.
The Direct Debit deposit simulation APIs allow you to transition Direct Debit deposit statuses in the sandbox environment.
POST /api/v1/simulation/deposit/createPOST /api/v1/simulation/deposits/{deposit_id}/rejectPOST /api/v1/simulation/deposits/{deposit_id}/reversePOST /api/v1/simulation/deposits/{deposit_id}/settle
Create a global account deposit
POST /api/v1/simulation/deposit/create
You can use this endpoint to simulate deposits into your global account. This is only available in the sandbox environment.
Amount to deposit into global account.
Global account unique identifier.
Name of the bank that the deposit is made from.
Payer country code of the transaction (2-letter ISO 3166-2 country code).
ACADAEAFAGAIALAMANAOAQARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBUBVBWBYBZCACCCDCFCGCHCICKCLCMCNCOCPCRCSCUCVCWCXCYCZDEDGDJDKDMDODZEAECEEEGEHERESETEUEZFIFJFKFMFOFRFXGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTHUICIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNTNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRURWSASBSCSDSESFSGSHSISJSKSLSMSNSOSRSSSTSUSVSXSYSZTATCTDTFTGTHTJTKTLTMTNTOTPTRTTTVTWTZUAUGUKUMUNDEFINEDUSUYUZVAVCVEVGVIVNVUWFWSXIXKXUYEYTYUZAZMZRZWName of the payer making the deposit.
Description of the deposit.
Custom statement reference for this deposit. If a statement reference is provided, please note that it needs to be unique.
Target next_status of this deposit. Default value is SETTLED.
PENDINGREJECTEDSETTLEDAmount of the transaction in transaction currency
The time of the transaction created
Currency of the transaction (3-letter ISO-4217 code)
Type of the transaction, can be one of: DEBIT, CREDIT
Fee amount of the transaction in transaction currency
Fee currency of the transaction (3-letter ISO-4217 code)
AEDAFNALLAMDANGAOAARSAUDAWGAZNBAMBBDBDTBGNBHDBIFBMDBNDBOBBOVBRLBSDBTNBWPBYNBYRBZDCADCDFCHECHFCHWCLFCLPCNYCOPCOUCRCCUCCUPCVECZKDJFDKKDOPDZDEGPERNETBEURFJDFKPGBPGELGHSGIPGMDGNFGTQGYDHKDHNLHRKHTGHUFIDRILSINRIQDIRRISKJMDJODJPYKESKGSKHRKMFKPWKRWKWDKYDKZTLAKLBPLKRLRDLSLLTLLYDMADMDLMGAMKDMMKMNTMOPMROMRUMURMVRMWKMXNMXVMYRMZNNADNGNNIONOKNPRNZDOMRPABPENPGKPHPPKRPLNPYGQARRONRSDRUBRURRWFSARSBDSCRSDGSEKSGDSHPSLLSOSSRDSSPSTDSTNSVCSYPSZLTHBTJSTMTTNDTOPTRYTTDTWDTZSUAHUGXUNDEFINEDUSDUSNUSSUYIUYUUZSVEFVESVNDVUVWSTXAFXAGXAUXBAXBBXBCXBDXCDXDRXOFXPDXPFXPTXSUXTSXUAXXXYERZARZMWZWLUnique id of the transaction
Payer country code of the transaction (2-letter ISO 3166-2 country code)
ACADAEAFAGAIALAMANAOAQARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBUBVBWBYBZCACCCDCFCGCHCICKCLCMCNCOCPCRCSCUCVCWCXCYCZDEDGDJDKDMDODZEAECEEEGEHERESETEUEZFIFJFKFMFOFRFXGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTHUICIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNTNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRURWSASBSCSDSESFSGSHSISJSKSLSMSNSOSRSSSTSUSVSXSYSZTATCTDTFTGTHTJTKTLTMTNTOTPTRTTTVTWTZUAUGUKUMUNDEFINEDUSUYUZVAVCVEVGVIVNVUWFWSXIXKXUYEYTYUZAZMZRZWPayer name of the transaction
Description of the transaction
The statement reference of this deposit.
Status of the transaction
PENDINGREJECTEDSETTLED| Error status | Description |
|---|---|
| 400 | invalid_argument |
| 401 | credentials_invalid |
| 500 | service_unavailable |
$curl --request POST \> --url 'https://api.sandbox.airwallex.com/api/v1/simulation/deposit/create' \> --header 'Authorization: Bearer {{ACCESS_TOKEN}}' \> --header 'Content-Type: application/json' \> --data '{> "amount": 1000,> "global_account_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2",> "payer_bankname": "<string>",> "payer_country": "AC",> "payer_name": "1000",> "reference": "<string>",> "statement_ref": "5487287788",> "status": "SETTLED">}'
1{2 "amount": 10000,3 "create_time": "2017-03-22T16:08:02+1100",4 "currency": "AUD",5 "deposit_type": "CREDIT",6 "fee_amount": 10,7 "fee_currency": {8 "currency_code": "AED",9 "precision": 0,10 "value": "<string>"11 },12 "id": "90b98dc6-63a0-403f-816b-ac5305b42a11",13 "payer_country": "US",14 "payer_name": "AMZNnt70paD1",15 "reference": "<string>",16 "statement_ref": "5487287788",17 "status": "PENDING"18}
Reject a direct debit deposit
POST /api/v1/simulation/deposits/{deposit_id}/reject
Rejects a pending deposit by transitioning the direct debit deposit status from PENDING to REJECTED.
Unique identifier of the direct debit deposit.
OK
| Error status | Description |
|---|---|
| 400 | invalid_argument |
| 401 | credentials_invalid |
| 404 | not_found |
| 500 | service_unavailable |
$curl --request POST \> --url 'https://api.sandbox.airwallex.com/api/v1/simulation/deposits/deposit_id/reject' \> --header 'Authorization: Bearer {{ACCESS_TOKEN}}' \> --header 'Content-Type: application/json'
Reverse a direct debit deposit
POST /api/v1/simulation/deposits/{deposit_id}/reverse
Creates a new direct debit deposit in the SETTLED state with an amount that offsets the original amount, i.e. negative value, and also deactivates the Linked Account. The original direct debit deposit will remain in the SETTLED state.
Unique identifier of the direct debit deposit.
OK
| Error status | Description |
|---|---|
| 400 | invalid_argument |
| 401 | credentials_invalid |
| 404 | not_found |
| 500 | service_unavailable |
$curl --request POST \> --url 'https://api.sandbox.airwallex.com/api/v1/simulation/deposits/deposit_id/reverse' \> --header 'Authorization: Bearer {{ACCESS_TOKEN}}' \> --header 'Content-Type: application/json'
Settle a direct debit deposit
POST /api/v1/simulation/deposits/{deposit_id}/settle
Settles a pending deposit by transitioning the direct debit deposit status from PENDING to SETTLED.
Unique identifier of the direct debit deposit.
OK
| Error status | Description |
|---|---|
| 400 | invalid_argument |
| 401 | credentials_invalid |
| 404 | not_found |
| 500 | service_unavailable |
$curl --request POST \> --url 'https://api.sandbox.airwallex.com/api/v1/simulation/deposits/deposit_id/settle' \> --header 'Authorization: Bearer {{ACCESS_TOKEN}}' \> --header 'Content-Type: application/json'