Peer liquidity

Peer liquidity is the line of credit you extend to a peer, denominated in your agreed upon asset. A peer’s liquidity account balance represents the amount of credit the peer still has available to them.

A peer’s liquidity increases when payments are made to the peer and decreases when payments are made from the peer. For example, if a customer of your peer sends your customer a payment of $20 USD, then your peer’s liquidity account decreases by 20.

If a peer’s liquidity is insufficient (e.g., they’ve used up their allotted credit line), transactions initiated from the peer will fail. Once a peer’s liquidity is used up, you should settle with your peer and reset their liquidity. Deposit and withdraw peer liquidity as necessary, based on your risk profile.

For more information about how Rafiki handles liquidity, see the Accounting concepts page and the low peer liquidity section of the webhook events page.

Manage peer liquidity using Rafiki Admin

You can deposit and withdraw peer liquidity through the Rafiki Admin application’s Peers screen.

Manage peer liquidity using the Backend Admin API

Idempotency key

You must provide an idempotencyKey when calling any mutations related to liquidity. This unique key ensures duplicate or retried requests are processed only once. For more information, see the Idempotency section in the GraphQL Admin APIs page.

Deposit peer liquidity

Operation

mutation DepositPeerLiquidity($input: DepositPeerLiquidityInput!) {
  depositPeerLiquidity(input: $input) {
   success
 }
}

Arguments

{
  "input": {
    "id": "a09b730d-8610-4fda-98fa-ec7acb19c775",
    "peerId": "73158598-2e0c-4973-895e-aebd115af260",
    "amount": "1000000",
    "idempotencyKey": "a09b730d-8610-4fda-98fa-ec7acb19c775"
  }
}

For more information about this mutation’s input object, see DepositPeerLiquidityInput.

Response

When a peer liquidity deposit is successful, DepositPeerLiquidity returns true.

{
  "data": {
    "success": true
  }
}

Withdraw peer liquidity

Operation

mutation CreatePeerLiquidityWithdrawal($input: CreatePeerLiquidityWithdrawalInput!) {
  createPeerLiquidityWithdrawal(input: $input) {
    success
 }
}

Arguments

{
  "input": {
    "id": "421fae87-9a59-4217-9ff8-faf55ffab9c6",
    "peerId": "73158598-2e0c-4973-895e-aebd115af260",
    "amount": "100",
    "idempotencyKey": "b97fd85a-126e-42ef-b40d-1a50a70ffa6f",
    "timeoutSeconds": 0
  }
}

For more information about this mutation’s input object, see CreatePeerLiquidityWithdrawalInput.

Response

When a peer liquidity withdrawal is successful, CreatePeerLiquidityWithdrawal returns true.

{
  "data": {
    "success": true
  }
}