Skip to navigation

Pay Invoice From Wallet

View as Markdown

Pays an invoice using wallet balance.

Required body fields: invoice invoice number, currency code. Optional depending on payment flow: cloneId, partPaymentFromWalletBalance object.

Response fields: message, invoiceNo, amount, walletBalance.

Possible errors:

  • 404: Invoice not found - invoice number does not belong to the customer.
  • 404: User not found - authenticated customer was not found downstream.
  • 404: Currency not found - supplied currency code is unknown.
  • 400: Currency does not match expected credentials - invoice currency differs from request.
  • 400: Wallet not found - customer wallet is missing.
  • 400: Customer Invoice does not match expected credentials - invoice belongs to another customer.
  • 400: Invoice already paid - invoice status is already paid.
  • 400: Wrong Amount - invoice payable amount is invalid.
  • 400: Insufficient funds - wallet balance cannot cover the invoice.
  • 400: Missing One or More Required Parameters - required body/query fields were not supplied.
  • 401: Unauthorized - token is missing, expired, invalid, or the account/token pair was not found.
  • 403: Access denied - gateway traffic guard/rate policy blocked the request.
  • 429: Too many requests - gateway rate limit exceeded.
  • 500: Unexpected Error - unhandled gateway or downstream service failure.

Request

This endpoint expects an object.
cloneIdstringRequired
invoiceintegerRequired
currencystringRequired
partPaymentFromWalletBalanceobjectRequired

Response

OK
key_0integer
key_1string
key_2double
key_3string
key_4boolean

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error