> For the complete documentation index, see [llms.txt](https://startbutton.gitbook.io/startbutton-product-api/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://startbutton.gitbook.io/startbutton-product-api/webhooks/transfer-events.md).

# Transfer Events

### Supported events for transfer:

* transfer.pending
* transfer.successful
* transfer.failed
* transfer.reversed

{% tabs %}
{% tab title="Successful" %}

```json
{ 
  "event": "transfer.successful", 
  "data": { 
    "transaction": { 
      "_id": "65042e420d3292066xxxxxxx", 
      "transType": "transfer", 
      "status": "successful", 
      "feeAmount": 15, 
      "merchantId": "64c7bd870821e831xxxxxxxx", 
      "transactionReference": "6342d3xxxxxx", 
      "isRecurrent": false, 
      "gatewayReference": "6342d3xxxxxx", 
      "createdAt": "2023-09-15T10:13:22.438Z", 
      "updatedAt": "2023-09-15T10:13:25.212Z", 
      "amount": 5000, 
      "currency": "NGN", 
      "recipient": { 
        "recipientName": "JOHN DOE JAMES", 
        "currency": "NGN", 
        "institutionType": "nuban", 
        "institutionName": "Zenith Bank", 
        "institutionNumber": "2007xxxxxx", 
        "_id": "64f4fb7e605c5280xxxxxxx" 
      } 
    }, 
    "authorizationCode": null 
  }
}
```

{% endtab %}

{% tab title="Successful (KES)" %}

```json
{ 
  "event": "transfer.successful", 
  "data": { 
    "transaction": { 
      "_id": "65e8xxxxxxxxxxxxxx", 
      "transType": "transfer", 
      "status": "successful", 
      "feeAmount": 0, 
      "merchantId": "64c7bd8xxxxxxxxxxxxx", 
      "transactionReference": "df11xxxxxx", 
      "isRecurrent": false, 
      "createdAt": "2024-03-06T16:23:00.016Z", 
      "updatedAt": "2024-03-06T16:23:02.957Z", 
      "gatewayReference": "df11xxxxxxxx", 
      "fromBalanceAfterLedger": 0, 
      "fromBalanceAfterAvailable": 0, 
      "toBalanceAfterLedger": 0, 
      "toBalanceAfterAvailable": 0, 
      "amount": 100, 
      "currency": "KES", 
      "recipient": { 
        "recipientName": "11 - 07xxxxxxx", 
        "currency": "KES", 
        "institutionType": "mobile_money", 
        "institutionName": "11", 
        "institutionNumber": "07xxxxxxxx", 
        "_id": "65e8xxxxxxxxxxxx" 
      } 
    }, 
    "authorizationCode": "1eexxxxxxxxx" 
  } 
}
```

{% endtab %}

{% tab title="Pending" %}

```json
{ 
  "event": "transfer.pending", 
  "data": { 
    "transaction": { 
      "_id": "65042e420d3292066xxxxxxx", 
      "transType": "transfer", 
      "status": "pending", 
      "feeAmount": 15, 
      "merchantId": "64c7bd870821e831xxxxxxxx", 
      "transactionReference": "6342d3xxxxxx", 
      "isRecurrent": false, 
      "gatewayReference": "6342d3xxxxxx", 
      "createdAt": "2023-09-15T10:13:22.438Z", 
      "updatedAt": "2023-09-15T10:13:25.212Z", 
      "amount": 5000, 
      "currency": "NGN", 
      "recipient": { 
        "recipientName": "JOHN DOE JAMES", 
        "currency": "NGN", 
        "institutionType": "nuban", 
        "institutionName": "Zenith Bank", 
        "institutionNumber": "2007xxxxxx", 
        "_id": "64f4fb7e605c5280xxxxxxx" 
      } 
    }, 
    "authorizationCode": null 
  }
}
```

{% endtab %}

{% tab title="Failed" %}

```json
{ 
  "event": "transfer.failed", 
  "data": { 
    "transaction": { 
      "_id": "65042e420d3292066xxxxxxx", 
      "transType": "transfer", 
      "status": "failed", 
      "feeAmount": 0, 
      "merchantId": "64c7bd870821e831xxxxxxxx", 
      "transactionReference": "6342d3xxxxxx", 
      "isRecurrent": false, 
      "gatewayReference": "6342d3xxxxxx", 
      "createdAt": "2023-09-15T10:13:22.438Z", 
      "updatedAt": "2023-09-15T10:13:25.212Z", 
      "amount": 5000, 
      "currency": "NGN", 
      "recipient": { 
        "recipientName": "JOHN DOE JAMES", 
        "currency": "NGN", 
        "institutionType": "nuban", 
        "institutionName": "Zenith Bank", 
        "institutionNumber": "2007xxxxxx", 
        "_id": "64f4fb7e605c5280xxxxxxx" 
      } 
    }, 
    "authorizationCode": null 
  }
}
```

{% endtab %}

{% tab title="Reversed" %}

```json
{ 
  "event": "transfer.reversed", 
  "data": { 
    "transaction": { 
      "_id": "65042e420d3292066xxxxxxx", 
      "transType": "transfer", 
      "status": "reversed", 
      "feeAmount": 0, 
      "merchantId": "64c7bd870821e831xxxxxxxx", 
      "transactionReference": "6342d3xxxxxx", 
      "isRecurrent": false, 
      "gatewayReference": "6342d3xxxxxx", 
      "createdAt": "2023-09-15T10:13:22.438Z", 
      "updatedAt": "2023-09-15T10:13:25.212Z", 
      "amount": 5000, 
      "currency": "NGN", 
      "recipient": { 
        "recipientName": "JOHN DOE JAMES", 
        "currency": "NGN", 
        "institutionType": "nuban", 
        "institutionName": "Zenith Bank", 
        "institutionNumber": "2007xxxxxx", 
        "_id": "64f4fb7e605c5280xxxxxxx" 
      } 
    }, 
    "authorizationCode": null 
  }
}
```

{% endtab %}
{% endtabs %}