Deposits

Relevant webhook events(covers both bank transfer and direct debit deposits):

deposit.pending
deposit.rejected
deposit.settled
deposit.reversed

deposit.pending

Payload example:

JSON
1{
2    "accountId": "acct_TOslkS7-MnyXlQuV8Lb4og",   
3    "data":Object{...},
4    "id":"86b69f91-06f0-3fe8-8faf-4de58954ca8e",								
5    "name": "deposit.pending"  
6}

data

JSON
1{
2    "id": "67f687fe-dcf4-4462-92fa-20335301d9d8",
3    "type": "BANK_TRANSFER",
4    "status": "PENDING",
5    "created_at": "2017-03-20T14:00:01+1100",
6    "currency": "AUD",
7    "amount": 12794.27,
8    "global_account_id": "fcfc369c-ce9d-4ab7-b9af-80df61848f8f",
9    "payer": {
10      "name": "Tester Smith",
11      "country_code": "AU",
12      "bank_account": {
13        "type": "AU_BSB",
14        "au_bsb": {
15          "bsb": "063001",
16          "account_number": "89098199202"
17        },
18        "name": "Tester Smith",
19        "institution": {
20          "swift_code": "ANZBNZ22",
21          "name": "ANZ Bank Limited",
22          "country_code": "AU"
23        }
24      }
25    },
26    "reference": "5487287788",
27    "provider_transaction_id": "5487287788"
28}

deposit.rejected

Payload example:

JSON
1{
2    "accountId": "acct_TOslkS7-MnyXlQuV8Lb4og",   
3    "data":Object{...},
4    "id":"86b69f91-06f0-3fe8-8faf-4de58954ca8e",
5    "name": "deposit.rejected"		
6}

data

JSON
1{
2    "id": "67f687fe-dcf4-4462-92fa-20335301d9d8",
3    "type": "DIRECT_DEBIT",
4    "status": "REJECTED",
5    "created_at": "2017-03-20T14:00:01+1100",
6    "currency": "AUD",
7    "amount": 12794.27,
8    "failure_details": {
9      "code": "refer_to_payer",
10      "iso_code": "NARR",
11      "provider_failure_details": {
12        "code": "006",
13        "local_clearing_system": "AU_BECS",
14        "message": "refer to payer"
15      }
16    },
17    "funding_source_id": "fcfc369c-ce9d-4ab7-b9af-80df61848f8f",
18    "reference": "5487287788",
19    "provider_transaction_id": "5487287788"
20}

deposit.settled

Payload example:

JSON
1{
2    "accountId": "acct_TOslkS7-MnyXlQuV8Lb4og",   
3    "data":Object{...},
4    "id":"86b69f91-06f0-3fe8-8faf-4de58954ca8e",
5    "name": "deposit.settled"		
6}

data

JSON
1{
2    "id": "67f687fe-dcf4-4462-92fa-20335301d9d8",
3    "type": "DIRECT_DEBIT",
4    "status": "SETTLED",
5    "created_at": "2017-03-20T14:00:01+1100",
6    "currency": "AUD",
7    "amount": 12794.27,
8    "settled_at": "2017-03-22T14:00:00+0000",
9    "funding_source_id": "fcfc369c-ce9d-4ab7-b9af-80df61848f8f",
10    "reference": "5487287788",
11    "provider_transaction_id": "5487287788",
12    "fee": {
13      "currency": "AUD",
14      "amount": 12.79
15    }
16}

deposit.reversed

Payload example:

JSON
1{
2    "accountId": "acct_TOslkS7-MnyXlQuV8Lb4og",   
3    "data":Object{...},
4    "id":"86b69f91-06f0-3fe8-8faf-4de58954ca8e",
5    "name": "deposit.reversed"		
6}

data

JSON
1{
2    "id": "67f687fe-dcf4-4462-92fa-20335301d9d8",
3    "type": "DIRECT_DEBIT",
4    "status": "REVERSED",
5    "created_at": "2017-03-20T14:00:01+1100",
6    "currency": "AUD",
7    "amount": 12794.27,
8    "failure_details": {
9      "code": "refer_to_payer",
10      "iso_code": "NARR",
11      "provider_failure_details": {
12        "code": "006",
13        "local_clearing_system": "AU_BECS",
14        "message": "refer to payer"
15      }
16    },
17    "funding_source_id": "fcfc369c-ce9d-4ab7-b9af-80df61848f8f",
18    "reference": "5487287788",
19    "provider_transaction_id": "5487287788"
20}

Was this page helpful?