1. Payees
Artha Payments API
  • Introduction
  • Customers
    • Create Customer
      POST
    • List Customers
      GET
    • Get Customer
      GET
    • Update Customer
      PATCH
  • Manage Account
    • Get Payout Currencies
      GET
    • Save Payout Currency
      POST
    • Update Payout Currency State
      PUT
  • Payees
    • Get Fiat Payees List (Grid)
      GET
    • View Fiat Payee Details
      GET
    • Get Recipient Form Fields
      GET
    • Get Payees Lookup Data
      GET
    • Get Phone Codes Lookup
      GET
    • Get Countries With States Lookup
      GET
    • Get Payee Countries
      GET
    • Get Currencies With Countries
      GET
    • Create Fiat Payee
      POST
    • Update Fiat Payee
      PUT
    • Update Payee State (Admin)
      PUT
  • Payout Screen
    • Get Merchant Crypto Payout Config
      GET
    • Get Active Fiat Payout Currencies
      GET
    • Get Fiat Payees
      GET
    • Get Payment Purposes
      GET
    • Get Source Of Funds
      GET
    • Payments Lookup (Core)
      GET
    • Get Transfer Types
      GET
    • Get Crypto Payout Fee
      POST
    • Create Crypto Payout
      POST
    • Payments Order Creation (Provider)
      POST
    • Get Crypto Payout Transactions
      GET
  1. Payees

Update Fiat Payee

PUT
/api/v1/payees/fiat
Last modified:2026-07-16 12:48:45
Updates an existing fiat payee. Include the payee id in the body along with the fields to change.
The PayeeFiat payload is large; the key field groups are:
Identity & Type
FieldTypeDescriptionConstraints
idstring (uuid)Payee identifier (required for update, omit on create)-
favouriteNamestringDisplay name for the payeeNullable
accountTypestringindividual or businessNullable
firstName / lastNamestringIndividual payee nameMax: 100 · Nullable
middleNamestringIndividual middle nameNullable
businessNamestringBusiness payee nameNullable
businessRegistrationNumberstringBusiness registration no.Nullable
businessTypestringBusiness typeNullable
emailstringPayee emailMax: 100 · Nullable
phoneCode / phoneNumberstringPayee phoneNullable
dateOfBirthstringDate of birthNullable
relationCode / relationstringRelationship to senderNullable
Address
FieldTypeDescription
line1 / streetstringStreet address
country / state / city / postalCodestringAddress components
Bank / Payment Details
FieldTypeDescription
currencystringPayout currency code
bankName / bankCountry / bankBranchstringBank identity
accountNumber / ibanstringAccount identifiers
swiftOrBicCode / bic / swiftBICstringSWIFT/BIC
ifscCode / sortCode / routeNumber / abaRoutingCode / bsbNumber / clearingNumber / branchCodestringRegion-specific bank codes
bankAccountType / paymentAccountTypestringAccount type
paymentType / transferType / paymentSchemastringPayment routing config
purpose / paymentPurpose / remittancePurposestringPurpose of payments
Documents & Proof
FieldTypeDescription
documentType / documentNumberstringIdentity document
proofTypestringProof of relationship/ownership
frontImage / backImageobject{ name, url } document images
Other supported fields: customerId, holderName, fullName, walletType, walletSource, whiteListState, whiteListRemarks, stableCoinPayout, isOnTheGo, bankAddress, bankCity, bankPostalCode, providerBankCode, bankCode, ukShortCode, metadata, paymentInfo.

Request

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢200
application/json
Payee updated.
Bodyapplication/json

🟠401
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PUT '/api/v1/payees/fiat' \
--header 'X-Idempotency-Key: b7e6a1f0-2c3d-4e5f-8a9b-0c1d2e3f4a5b' \
--header 'Content-Type: application/json' \
--data-raw '{
    "id": "9b2f1c44-8a31-4f0d-9d6e-1c2b3a4d5e6f",
    "favouriteName": "John'\''s US Account",
    "accountType": "individual",
    "firstName": "John",
    "lastName": "Smith",
    "email": "john.smith@example.com",
    "phoneCode": "+1",
    "phoneNumber": "5551234567",
    "dateOfBirth": "1988-04-12",
    "relationCode": "FRIEND",
    "line1": "221 Market Street",
    "city": "San Francisco",
    "state": "CA",
    "country": "US",
    "postalCode": "94105",
    "currency": "USD",
    "bankName": "Chase Bank",
    "bankCountry": "US",
    "accountNumber": "000123456789",
    "abaRoutingCode": "021000021",
    "bankAccountType": "checking",
    "paymentType": "bank",
    "transferType": "LOCAL",
    "purpose": "Family Support",
    "documentType": "passport",
    "documentNumber": "N1234567",
    "proofType": "bank_statement",
    "frontImage": {
        "name": "passport-front.jpg",
        "url": "https://files.example.com/passport-front.jpg"
    },
    "backImage": {
        "name": "passport-back.jpg",
        "url": "https://files.example.com/passport-back.jpg"
    }
}'
Response Response Example
{
    "id": "9b2f1c44-8a31-4f0d-9d6e-1c2b3a4d5e6f",
    "status": "pending",
    "modifiedDate": "2026-07-16T11:05:00Z"
}
Modified at 2026-07-16 12:48:45
Previous
Create Fiat Payee
Next
Update Payee State (Admin)
Built with