Returns an address that can be used to send deposits to this account. If payor details are provided in the request, the address is also associated to the payor and payment reference ID.
The transactions listing provides reconciliation details per deposit, including payor information if provided. When auto exchange is enabled, the settlements listing provides a fully breakdown of deposit to exchange and settlement.
The product configuration of the account will determine if the address being returned is fixed or temporary (rotating). This can be modified via the Management Interface. You can read more about the address leasing model under Leasing Concepts.
If no payor details are provided whn requesting an address, the behaviour defaults to that of a deposit account.
| Authorization | string OAuth bearer token (see authentication flows) |
| x-l2f-request-id | string Optional Unique ID per request, useful for fault resolution/diagnosis and audit. |
| x-l2f-idempotency-id | string Unique ID used to safely retry an operation. See idempotency section for more details. |
| amount required | string Expected amount of payment (which can be split over multiple transactions) |
| payor_id | string The payor to associate with this payment, generated using create payor. Only available with the payments product |
| payment_reference | string Payment reference to associate with this payment. Only available with the payments product |
Success
Bad Request
Unauthorized
Not Found
Internal Error
{- "amount": "string",
- "payor_id": "string",
- "payment_reference": "string"
}{- "data": {
- "id": "string",
- "wallet_address": "string",
- "asset_type_id": "string",
- "lease_enforced": true,
- "lease_end_date": "2019-08-24T14:15:22Z",
- "lease_transaction_limit": 0,
- "lease_value_limit": 0
}
}