Funding
Funding endpoints put money into your company's own wallets. There are three ways to fund: bank transfer, where you move money by ACH or wire to an Xtrm bank account that the API returns; bank debit, where Xtrm debits a bank account you linked for bank debit; and credit card, where you charge your company's own card. The credit card call is only for funding your own wallets, not for taking payments from consumers.
Bank transfers can take 2 to 7 business days to be credited, bank debits 3 to 5 business days to complete, and credit card funds 1 to 3 business days to appear in the wallet, unless the amount is within a card funding limit that Xtrm sets for your company: then Xtrm credits the wallet as soon as the card is charged. Each call returns a TransactionID that you can use to track the funding transaction.
Bank debit was formerly called ACH debit, so its operations keep the ACHDebit name (for example, FundWalletUsingACHDebit). The sandbox works the same as production, and it has no sandbox-only test bank, routing or IBAN numbers. For a card in the sandbox, use a standard test number: Visa 4111111111111111 or Mastercard 5555555555554444, with a future expiry date and a three-digit CVV. No real money moves in the sandbox, and you should never use real financial data there.
#Fund a wallet by bank transfer
/API/v4/Wallet/FundWalletUsingBankTransferFunds one of your company wallets by bank transfer. The call creates a pending fund request in the wallet and returns, in BankInformation, the Xtrm bank account that receives the funds. This bank account varies by currency. Start an ACH or wire from your bank to that account. The transfer needs no reference. Once Xtrm receives the money, it credits the wallet. Until then, the funds can't pay a batch.
Set InvoiceRequired to "true", a lowercase string, to have Xtrm generate an invoice for the transaction and send it by email. With it, the amount must be at least 500 USD, or the equivalent in CurrencyCode. Use ProgramID to link the funding to one of your programs.
Important
Move the funds by ACH or wire to the bank account returned in BankInformation. The transfer needs no reference. Once Xtrm receives the money, it credits the wallet. Allow 2 to 7 business days, depending on your location, for the funds to be credited.
Body parameters
FundWalletUsingBankTransferobjectRequiredRoot wrapper for the request.
Child parameters1
RequestobjectRequiredThe funding request.
Child parameters10
IssuerAccountNumberstringRequiredYour company's Xtrm account number, starting with
SPN: the account that owns the API credentials you call with. If you use pseudo credentials, send theSPNof the company you act on behalf of.BeneficiaryAccountNumberstringRequiredThe
SPNof the company whose wallet you fund. To fund your own wallet, send your ownSPN.WalletIDmust be one of this company's wallets inCurrencyCode. Any other company must be connected to yours, or the call returns401.AmountstringRequiredThe amount to fund into the wallet, passed as a string (for example,
"500").CurrencyCodestringRequiredThree-letter ISO 4217 currency code of the funding transaction, for example
USD.WalletIDstringRequiredThe
WalletIDof the wallet to fund, as a string, for example"122181". It takes only the wallet's numeric ID: a request with a wallet name is rejected withWallet ID is mandatory, and no money moves.AdditionalinformtaionstringOptionalAn optional memo or routing instructions for the bank transfer, for example
"Q3 Partner Funding Replenishment". The field name is spelled exactly this way.InvoiceRequiredstringOptionalSend
"true", lowercase and in quotes, to have Xtrm generate an invoice for the transaction and send it by email. Send"false"or leave the field out for no invoice. With"true", the amount must be at least 500 USD, or the equivalent inCurrencyCode. Send the exact string"true": Xtrm reads a JSONtrueas"True", which passes the checks, including the minimum, but doesn't request the invoice. A value other than true or false, in any letter case, such as"yes", returns400withInvoiceRequired must be true/false.ProgramIDstringOptionalThe identifier of a rewards, payment or budget program to link this funding transaction to, for example
"1024".RequiredDepositDatestringOptionalThe date you request for the funds to arrive and clear, as a US date in
MM/DD/YYYYformat:"06/05/2026"is 5 June 2026.RequiredPaymentDatestringOptionalThe requested date for the payment to be initiated, as a US date in
MM/DD/YYYYformat:"06/05/2026"is 5 June 2026.
Response fields
FundWalletUsingBankTransferResponseobjectRoot wrapper for the response.
Child parameters1
FundWalletUsingBankTransferResultobjectThe funding result.
Child parameters11
TransactionIDstringUnique identifier of this funding transaction. Use it to track the transaction.
AmountnumberThe amount of the fund request, before fees.
FeenumberThe processing fee applied to the bank transfer.
TotalAmountnumberThe total amount expected to be received, including any applicable fees.
WalletIDintegerThe
WalletIDof the destination wallet, as a number, for example122181.CurrencystringThree-letter ISO 4217 currency code of the funded amount.
MethodstringThe payment method used for the transaction, for example
Bank Transfer.BankInformationstringThe bank routing and account details of the Xtrm account that receives the funds, returned as a single string. In the example, lines are separated by HTML line-break tags.
DescriptionstringA description of the transaction, 1 to 100 characters, for example
Fund Request - Bank Transfer (Pending).StatusstringThe current state of the funding request. It stays
Pendinguntil the transaction is fully completed and cleared.OperationStatusobjectThe outcome of the call.
Child parameters2
Errorsstring[]Validation or execution error details when the call fails.
nullwhen the call succeeds, so decide withSuccess.Successbooleantrueif the operation succeeded, otherwisefalse.
Related: List company wallets · List your company's programs · List company wallet transactions · Get the details of a company wallet transaction · Fund a wallet by bank debit · Fund a wallet with a credit card
#Fund a wallet by bank debit
/API/v4/Wallet/FundWalletUsingACHDebitFunds one of your company wallets by debiting a bank account linked for bank debit (ACH or a similar system). Pass the linked bank's BeneficiaryId, from LinkACHDebitBankBeneficiary or GetACHDebitLinkedBankAccounts, in LinkedBankID.
The response returns the amount, the processing fee, the total amount debited from the bank (amount plus fee), a TransactionID to track the transaction, and a Status describing the state of the request, which starts as pending. Xtrm credits the wallet when it approves the funding; until then, the funds can't pay a batch. Xtrm emails your company once the funding completes.
Bank debit was formerly called ACH debit, which is why the operation and related calls keep the ACHDebit name.
Important
Bank debit can take 3 to 5 business days to complete. Xtrm emails your company once the funding completes.
Note
You can only debit a bank account linked for bank debit with LinkACHDebitBankBeneficiary and approved for bank debit. Check the approval status with GetACHDebitLinkedBankAccounts.
Note
Release 4.91.6 added bank debit funding in USD, CAD, AUD, GBP and EUR.
Body parameters
FundWalletUsingACHDebitRequestobjectRequiredRoot wrapper for the request.
Child parameters1
RequestobjectRequiredThe funding request.
Child parameters5
IssuerAccountNumberstringRequiredYour company's Xtrm account number, starting with
SPN: the account that owns the API credentials you call with. If you use pseudo credentials, send theSPNof the company you act on behalf of.AmountstringRequiredThe amount to fund into the wallet, passed as a string (for example,
"50").CurrencyCodestringRequiredThree-letter ISO 4217 currency code of the funding transaction, for example
USD.WalletIDstringRequiredThe
WalletIDof the wallet to fund, as a string, for example"122181". It takes only the wallet's numeric ID: a request with a wallet name is rejected with HTTP400andWalletID is Mandatory and must be an integer, and no money moves.LinkedBankIDstringRequiredThe
BeneficiaryIdof the linked bank account to debit, asLinkACHDebitBankBeneficiaryandGetACHDebitLinkedBankAccountsreturn it. The bank must be linked for bank debit to your own company, the account inIssuerAccountNumber, and approved: any other bank is refused with<LinkedBankID> - Invalid Linked Bank ID, and a bank that isn't approved yet with a pending-status message, such as<LinkedBankID> - Linked Bank ID is in pending status.
Response fields
FundWalletUsingACHDebitResponseobjectRoot wrapper for the response.
Child parameters1
FundWalletUsingACHDebitResultobjectThe funding result.
Child parameters7
AmountstringThe base amount funded into the wallet, as a decimal string (for example,
"50.00").CurrencystringThree-letter ISO 4217 currency code of the funded amount.
FeestringThe processing fee applied to the bank debit, as a decimal string (for example,
"2.25").OperationStatusobjectThe outcome of the call.
Child parameters2
Errorsstring[]Validation or execution error details when the call fails.
nullwhen the call succeeds, so decide withSuccess.Successbooleantrueif the operation succeeded, otherwisefalse.
StatusstringText describing the current state of the bank debit fund request, for example
Pending,Completed, orFailed.TotalAmountstringThe total amount debited from the bank (amount plus fees), as a decimal string (for example,
"52.25").TransactionIDstringUnique identifier of this funding transaction. Use it to track the transaction.
Related: Link a bank account for bank debit funding · Send micro-deposits to a linked bank · Verify micro-deposit amounts · List bank accounts linked for bank debit · List company wallets · Get the details of a company wallet transaction
#Fund a wallet with a credit card
/API/v4/Wallet/FundCompanyWalletUsingCreditCardFunds one of your company wallets by charging the company's own credit card. Pass the payment details (amount, currency and destination wallet), the cardholder's name, the card's billing address, and the card's CardToken (or, without a token, the card's details, which also links that card to your company). Card funding is in USD only. A CardToken must belong to a card your company linked as an identity card.
Xtrm charges the card the Amount you send and credits that full Amount to the wallet. The response returns Amount, the card funding Fee for that amount on your company's pricing, TotalAmount (Amount plus Fee), and a TransactionID to track the transaction. The card is charged Amount, not TotalAmount.
Important
This call is not intended to take payments from consumers. Use it only to fund your own company wallets with your company's own card.
Note
When the amount is within a card funding limit that Xtrm sets for your company, Xtrm credits the wallet as soon as the card is charged. Otherwise the funds can take 1 to 3 business days to appear in the wallet.
Tip
To use a linked card, get its CardToken from GetLinkedCards. Only cards linked as identity cards can fund a wallet; transfer cards are for receiving Rapid Transfer payments.
Important
Never use real card data in the sandbox. Use a standard test number instead: Visa 4111111111111111 or Mastercard 5555555555554444, with a future expiry date and a three-digit CVV. Sandbox test transactions don't move real money.
Body parameters
FundCompanyWalletUsingCreditCardRequestobjectRequiredRoot wrapper for the request.
Child parameters1
RequestobjectRequiredThe funding request.
Child parameters4
PaymentDetailsobjectRequiredThe amount to fund and the destination wallet.
Child parameters4
IssuerAccountNumberstringRequiredYour company's Xtrm account number, starting with
SPN: the account that owns the API credentials you call with. If you use pseudo credentials, send theSPNof the company you act on behalf of.AmountstringRequiredThe amount to fund into the wallet, passed as a string. The example on this page sends the number
50.CurrencyCodestringRequiredThree-letter ISO 4217 currency code of the funding transaction, for example
USD.WalletIDstringRequiredThe
WalletIDof the wallet to fund, as a string, for example"122181". It takes only the wallet's numeric ID: a request with a wallet name is rejected with HTTP400andWalletID is Mandatory and must be an integer, and no money moves.
PayerInformationobjectRequiredThe cardholder's name.
Child parameters2
FirstNamestringRequiredThe cardholder's legal first name, 2 to 40 characters.
LastNamestringRequiredThe cardholder's legal last name, 2 to 40 characters.
PayerBillingAddressobjectRequiredThe billing address of the credit card.
Child parameters5
AddressLine1stringRequiredThe primary billing street address associated with the card.
CitystringRequiredThe billing city, 1 to 25 characters.
StatestringRequiredThe billing state, province, or region.
CountryISO2stringRequiredTwo-letter ISO 3166-1 alpha-2 country code of the billing address, for example
US.PostalCodestringRequiredThe ZIP or postal code of the billing address.
CreditCardDetailsobjectRequiredThe credit card to charge: its
CardToken, or its details when you don't send a token.Child parameters6
CardTokenstringOptionalThe token of a card your company linked as an
identitycard, asLinkCardandGetLinkedCardsreturn it: a 15-character string of digits and capital letters A to F, for exampleF2AA507CD01E4EC. When you send it, Xtrm charges that card and ignores the otherCreditCardDetailsfields. When you leave it out, Xtrm doesn't fall back to a default or previously linked card. It charges the card you describe inCreditCardNumber,CreditCardType,ExpireMonth,ExpireYearandCVV, which are required then, and links that card to your company. Because of that, funding with card details is refused withYou can link maximum 3 Cardsonce three cards are linked to your account. A card that's already linked as anidentitycard must be sent by its token: sending its details returnsCard already linked.We recommend linking the card once and sending its token.ExpireMonthstringOptionalRequired when you don't send
CardToken. The card expiration month as a numeric string from1to12(for example,"5").ExpireYearstringOptionalRequired when you don't send
CardToken. The card expiration year as a four-digit string (for example,"2031").CreditCardNumberstringOptionalRequired when you don't send
CardToken. The primary account number (PAN) of the card, 13 to 19 characters.CreditCardTypestringOptionalRequired when you don't send
CardToken. The card brand:Master Card,Visa CardorAmex Card, in any case. The example sendsMaster Card.CVVstringOptionalRequired when you don't send
CardToken. The 3- or 4-digit card verification value, as a string.
Response fields
FundCompanyWalletUsingCreditCardResponseobjectRoot wrapper for the response.
Child parameters1
FundCompanyWalletUsingCreditCardResultobjectThe funding result.
Child parameters6
AmountstringThe amount charged to the card and credited to the wallet, as a string with two decimals, for example
"50.00". Amounts of 1,000 or more include a thousands separator, for example"1,250.00", so strip separators before you parse them.CurrencystringThree-letter ISO 4217 currency code of the funded amount.
FeestringThe card funding fee for this amount on your company's pricing, in USD, as a string with two decimals, for example
"2.25".OperationStatusobjectThe outcome of the call.
Child parameters2
Errorsstring[]Validation or execution error details when the call fails.
nullwhen the call succeeds, so decide withSuccess.Successbooleantrueif the operation succeeded, otherwisefalse.
TotalAmountstringAmountplusFee, as a string with two decimals, for example"52.25". The card is chargedAmount, not this total.TransactionIDstringUnique identifier of this funding transaction. Use it to track the transaction.
Related: List a recipient's linked cards · Link a card to a recipient · List company wallets · Get the details of a company wallet transaction · Fund a wallet by bank transfer