Payment liquidity

Payment liquidity represents:

• The value received from a completed incoming payment
• The value available to send in an outgoing payment

Because Rafiki doesn’t hold funds, anything you receive in an incoming payment must be withdrawn and then credited to the recipient’s account on your ledger. Listen for the incoming payments webhook events to know when you need to interact with Rafiki.

Any excess liquidity that remains after an outgoing payment completes must be withdrawn. You may also find that you must deposit liquidity into Rafiki to fund an outgoing payment. Listen for Rafiki’s outgoing payments webhook events to know when action is required on your part.

Rafiki Admin

The Rafiki Admin does not allow you to manage payment liquidity; however, you can view details about incoming and outgoing payments through the application’s Payments screen.

For more information about how Rafiki handles liquidity, see the Accounting concepts page.

Manage payment 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.

Withdraw incoming payment liquidity

Operation

mutation CreateIncomingPaymentWithdrawal($input: CreateIncomingPaymentWithdrawalInput!) {
createIncomingPaymentWithdrawal(input: $input) {
  success
  }
}

Arguments

{
"input": {
  "incomingPaymentId": "b4f85d5c-652d-472d-873c-4ba2a5e39052",
  "idempotencyKey": "a09b730d-8610-4fda-98fa-ec7acb19c775",
  "timeoutSeconds": 0
  }
}

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

Response

When an incoming payment liquidity withdrawal is successful, CreateIncomingPaymentWithdrawal returns true.

{
  data: {
    success: true
  }
}

Deposit outgoing payment liquidity

Operation

mutation DepositOutgoingPaymentLiquidity($input: DepositOutgoingPaymentLiquidityInput!) {
depositOutgoingPaymentLiquidity(input: $input) {
  success
  }
}

Arguments

{
"input": {
  "outgoingPaymentId": "b4f85d5c-652d-472d-873c-4ba2a5e39052",
  "idempotencyKey": "a09b730d-8610-4fda-98fa-ec7acb19c775"
  }
}

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

Response

When an outgoing payment liquidity deposit is successful, DepositOutgoingPaymentLiquidity returns true.

{
  data: {
    success: true
  }
}

Withdraw outgoing payment liquidity

Operation

mutation CreateOutgoingPaymentWithdrawal($input: CreateOutgoingPaymentWithdrawalInput!) {
createOutgoingPaymentWithdrawal(input: $input) {
  success
  }
}

Arguments

{
"input": {
  "outgoingPaymentId": "b4f85d5c-652d-472d-873c-4ba2a5e39052",
  "idempotencyKey": "a09b730d-8610-4fda-98fa-ec7acb19c775",
  "timeoutSeconds": 0
  }
}

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

Response

When an outgoing payment liquidity withdrawal is successful, CreateOutgoingPaymentWithdrawal returns true.

{
  data: {
    success: true
  }
}