1. Withdraw
Artha All Module Api's
  • Introduction
  • Authentication
  • KYC/KYB Requirements
  • API Setup Guide
  • Products
    • List Products
      GET
    • Get Product
      GET
    • Get Customer Product Status
      GET
  • Customers
    • Create Customer
      POST
    • List Customers
      GET
    • Get Customer
      GET
    • Submit Applicant (KYC/KYB)
      POST
    • Create Onboarding Session
      POST
  • Wallets
    • Beneficiary
      • Create Crypto Beneficiary
      • Update Crypto Beneficiary
      • List Crypto Withdraw Beneficiaries
    • Create Wallet
      POST
    • Get Wallet Address
      GET
    • Get Customer Balances
      GET
    • List Wallets
      GET
    • List Withdrawals
      GET
    • List Withdrawal Networks
      GET
    • Preview Withdrawal Summary
      POST
    • Create Crypto Withdrawal
      POST
  • Cards
    • Issuance
      • Issue Card
      • List Cards
      • List Customer Cards
      • Get Card Details
      • Get Sensitive Card Details
    • Funding
      • Top Up Card
      • Get Card Balance
      • Get Top-Up Status
      • List Top-Up History
    • Operations
      • Resend Activation Code
      • Activate Card
      • Set Card PIN
      • Change Card PIN
      • Update Card Limits
      • Freeze Card
      • Unfreeze Card
      • Replace Card
      • Cancel Card
      • Get Card Limits
      • Show Card PIN Details
      • Get PIN View Iframe URL
      • Get PIN Change Iframe URL
      • Get PIN Set Iframe URL
      • Get Card View Iframe URL
      • Show Card PIN
  • Payees
    • Create a payee for a customer.
    • List a customer's payees.
    • Update a payee.
    • Retrieve a payee by id.
    • Look up an existing payee.
    • List the currencies a payee can be created in.
    • List the accepted payment purpose codes for a payee.
    • List the countries a payee can be created in.
    • List currency/country pairings for payees.
    • List the accepted beneficiary relationship codes.
  • Payments
    • Onboarding
      • List the customer's payout-currency configuration sections.
      • Enable a payout-currency section for the customer.
      • Get the customer's terms-of-service acceptance status.
      • Enable or disable a payout-currency section.
    • Quote
      • List the currencies a beneficiary can be paid in under a product.
      • List the payout rails available for a product and beneficiary.
      • Create an FX quote giving the rate and fee for a cross-currency payout.
    • Order
      • Submit a payout order to send money to a beneficiary.
      • Retrieve the on-chain address to fund an order.
      • Retrieve the status and settlement detail of a payout order.
    • Lookups
      • List the accepted payment purpose codes for a payout.
      • List the accepted source-of-funds codes for a payout.
      • List the document types accepted on a payout order.
  • Banks
    • Accounts
      • Create Bank Account
      • Get Account Details
      • Get Account Issuance Status
    • Withdraw
      • Create Withdrawal Quote
        POST
      • List Withdrawal Purposes
        GET
      • Get Payment Schemes
        GET
      • Execute Withdrawal
        POST
  • Exchange
    • Quote
      • Get Exchange Rate
      • Create Price Quote
    • Order
      • Place Exchange Order
  • Transactions
    • List Transactions
    • Get Transaction Details
  • Utilities
    • List Currencies
    • List Countries
    • Get Fee Schedule
    • List Product Occupations
    • List Product Industry Codes
    • Upload File
  • Webhook's
    • Wallets Webhooks
    • Banks Webhooks
    • Payments Webhooks
    • Exchange Webhooks
    • Card Webhooks
  1. Withdraw

Get Payment Schemes

GET
/api/v1/accountwithdrawal/paymentschemes/{currency}/{productId}
Returns the payment schemes available for withdrawing a given currency under a specific product — e.g. Faster Payments or CHAPS for GBP, SEPA or SEPA Instant for EUR, ACH or Fedwire for USD. Call this before requesting a withdrawal quote so the partner can present valid scheme choices; the selected scheme code is then passed as payment.scheme in the quote and withdraw requests.
Prerequisites
A valid productId for the product the account was issued under.
Optionally a customerId to scope schemes to what that customer is eligible for.
📤 Response Fields
FieldTypeDescription
data.supportedSchemesarrayPayment schemes available for this currency and product
data.supportedSchemes[].namestringHuman-readable scheme name shown to the end user
data.supportedSchemes[].codestringScheme code to send as payment.scheme in quote/withdraw requests (max 50 chars)
requestIdstringUnique ID of this request — quote it in support queries
timestampstring (date-time)Server timestamp of the response (UTC)

Request

Path Params

Query Params

Header Params

Responses

🟢200
application/json
Payment schemes retrieved successfully.
Bodyapplication/json

🟠401
🟠404
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/api/v1/accountwithdrawal/paymentschemes/GBP/b1f3c7a2-6c4e-4d91-9f2a-123456789abc?customerId=ed2baa83-a988-4b4a-93ee-fad379500bbd' \
--header 'X-API-Key;' \
--header 'X-Signature;' \
--header 'X-Timestamp;' \
--header 'X-Nonce;' \
--header 'X-Body-Hash;'
Response Response Example
200 - Success
{
    "success": true,
    "data": {
        "supportedSchemes": [
            {
                "name": "Faster Payments",
                "code": "FasterPayments"
            },
            {
                "name": "CHAPS",
                "code": "Chaps"
            },
            {
                "name": "Swift",
                "code": "Swift"
            }
        ]
    },
    "requestId": "9ebad6e481474fceb28de4f6e22edcab",
    "timestamp": "2026-08-12T09:31:40.540407Z"
}
Modified at 2026-08-12 12:06:39
Previous
List Withdrawal Purposes
Next
Execute Withdrawal
Built with