Workforce Payments APIs
  • Introduction
  • Real-Life Scenarios
  • API Reference
    • API Essentials
    • Payment Status
    • Environments
    • Authentication API
    • Wallets Management
      • Open A Wallet
      • Get Wallets List
      • Get Wallet Details
      • Get Wallet Statements
    • Groups Management
      • Create A Payment Group
      • Update A Payment Group
      • Get Payment Group Details
      • Get Payment Groups List
      • Lock Payment Group
      • UnLock Payment Group
      • Delete Payment Group
    • Beneficiaries Management
      • Get Schema Information
      • Create A Beneficiary
      • Update Beneficiary Details
      • Get Beneficiary Details
      • Get Beneficiaries List
      • Bulk Import Beneficiary
      • Bulk Import Beneficiary Status
      • Bulk Validate Beneficiary
    • Payment Management
      • Create Payment Instruction
      • Update Payment Instructions
      • Get Payment Details
      • Get Payments List
      • Approve Payment Instructions
      • UnApprove Payment Instructions
      • Execute Payment Instructions
      • Bulk Import Payment Instructions
      • Bulk Import Payment Instructions Status
    • Webhooks Notifications
Powered by GitBook

© All rights reserved to papaya global 2024

On this page
  1. API Reference
  2. Wallets Management

Get Wallet Details

The API is utilized to retrieve wallet details and fetches comprehensive information by specifying the wallet ID.

GET /payments/wallets/?id=<wallet_id>

Body Parameters Request

Name
location
Type
Description
Required

id

url path

string

Wallet ID for retrieval.

Yes

Body Parameters Response

id

string

the id of the wallet

type

string

the type of entity (wallet)

balance

number

The available amount in the wallet

funding

Map(String,Object)

Account funding details

owner

string

Legal entity id owning this wallet

state

string

DISABLED, REQUIRES_INPUT, ACTIVE

current state of wallet

user_tags

object

Request Example

GET /payments/wallets/?id=f6b2776d-53f4-404e-a690-c3766a91d43a

Response

{
   "id": "f6b2776d-53f4-404e-a690-c3766a91d43a",
   "currency": "USD",
   "name": "Demo USD Wallet",
   "type": "wallet",
   "owner": "entity://business/customer/demo:standalone:1709197789/legal/0d65c5cd-4896-45b9-b268-c431b82605af",
   "funding": {
      "name": "RONKIֹ LTD CMA - EUR",
      "country": "GB",
      "account_number": "UKNWBK60161529100024",
      "bic": "CHASGB2L",
      "iban": "UKNWBK60161529100024"
   },
   "balance": 120000,
   "user_tags": {
      "department": "sales"
   },
   "state": "ACTIVE"
}
{
   "error": "Method Not Allowed",
   "description": "Failed calling service",
   "error_code": 405,
   "sub_code": 1002,
   "error_info": {
      "timestamp": "2024-03-04T07:55:43.543Z",
      "status": 405,
      "error": "Method Not Allowed",
      "path": "/v1/"
   }
}
PreviousGet Wallets ListNextGet Wallet Statements

Last updated 10 months ago