> For the complete documentation index, see [llms.txt](https://docs.udara360.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.udara360.io/udara360-docs-1/transfer/transfer-api/get-settlement-account-details.md).

# Get Settlement Account Details

The "Get Settlement Account Details" endpoint allows customers to retrieve the settlement account details for a given account number and gateway.

<mark style="color:green;">`GET`</mark> `/api/Transfer/v1/GetSettlementAccountDetails`

To retrieve settlement account details, you need to provide the query parameters `accountNumber` and `gateway`.

**Headers**

| Name                                            | Value                |
| ----------------------------------------------- | -------------------- |
| Content-Type<mark style="color:red;">\*</mark>  | `application/json`   |
| Authorization<mark style="color:red;">\*</mark> | `Bearer`             |
| Request-Reference                               | `{unique_reference}` |

**Query Params**

| Name            | Description                                            |
| --------------- | ------------------------------------------------------ |
| `accountNumber` | The account number to retrieve settlement details for. |
| `gateway`       | The settlement gateway/processor to query against.     |

Here is an example request and response with a sample payload sent to the endpoint in Curl format.

<details>

<summary>Sample Request</summary>

```json
curl --location -g '{{baseurl}}/api/Transfer/v1/GetSettlementAccountDetails?accountNumber=0000000000&gateway=3' \
--header 'Authorization: bearer {token}' \
--header 'request-reference: {unique_reference}' \
--header 'Content-Type: application/json'
```

</details>

<details>

<summary>Response: <code>200</code></summary>

```json
{
  "status": true,
  "message": "string",
  "data": {
    "responseCode": "string",
    "responseMessage": "string",
    "bankCode": "string",
    "accountNumber": "string",
    "accountName": "string",
    "transactionReference": "string",
    "bvn": "string",
    "accountStatus": "string",
    "emailAddress": "string",
    "phoneNumber": "string",
    "cbaCustomerID": "string",
    "availableBalance": 0
  }
}
```

</details>