Creating a Liquidity Account
3 minute read
Creating a Liquidity Account is a lightweight operation performed via the Payments API. A single legal entity can own multiple Liquidity Accounts, which allows you to separate funds by use case.
When you create a Liquidity Account you:
- Specify the legal owner in
account_holder - Choose the currency for the account. All Payments to and from this account must use this currency.
- Optionally enable bank-transfer top-ups by setting
enable_deposits: true, which generatesdeposit_informationfor incoming bank transfers. - Provide a name that helps you identify the account in your integration and back office tools.
No funds are moved when the account is created; the initial balance is 0 until you fund it via Payments or deposits.
Example
Request
curl -X POST https://sandbox.pingpayments.com/payments/api/v1/liquidity_accounts \
--header "tenant_id: <YOUR-TENANT-ID>" \
--header "x-api-secret: <YOUR-API-SECRET>" \
--header "Content-Type: application/json" \
--data '{
"name": "My Account",
"account_holder": {
"name": "<ORGANIZATION-NAME>",
"identity": {
"country": "SE",
"type": "organization",
"identifier": "<ORGANIZATION-NUMBER>"
}
},
"currency": "SEK"
}'
Response
{
"id": "6ccbf39e-6075-4565-87c4-c43a0d1a9265",
"deposit_information": null
}Note: It is crucial to store the returned ID. You’ll need it to create Payments from and to the Liquidity Account.
Parameters
Request Parameters
| Name | Description |
|---|---|
account_holder | The individual/organization who is the owner of the account. |
enable_deposits | Creates a unique static reference which can be used to top up the account with a bank transfer. |
currency | ISO 4217 currency code for all underlying Payments (e.g. EUR, SEK). |
name | The account name, this should reflect the use case of the account |
Response Parameter
| Name | Description |
|---|---|
id | The ID of the Liquidity Account. |
deposit_information | If the Liquidity Account was created the with the option enable_deposits this field contains the information required to top up the account. |
Updated 2 days ago