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. Groups Management

UnLock Payment Group

The API unlocks a lock group and allows for additional payments to be processed.

DELETE /payments/groups/{id}/lock

Body parameters Request

id

url path

string

Group ID

Yes

Body Parameters Response

description

description

string

Extended description of group

id

id

string

Unique id of group

locked

boolean

When locked, no new actions can be made

name

name

string

Visual name of group

type

string

entity type (group)

user_tags

object

A set of K/v pairs of tags set for the group

wallet

id

string

The id of the owning wallet this group is associated with

Request Example

DELETE /payments/groups/b48c3f38-9278-41a3-b101-444f20fce982/lock

Response Examples

{
   "id": "b48c3f38-9 278-41a3-b101-444f20fce982",
   "type": "group",
   "locked": false,
   "user_tags": {
      "approved_by": "John Doe",
      "cycle": "2024-02"
   },
   "wallet": "f6b2776d-53f4-404e-a690-c3766a91d43a",
   "name": "February USD cycle",
   "description": "An updated description"
}
{
  "error": "Not Found",
  "description": "No message available",
  "error_code": 404,
  "error_info": {
    "timestamp": "2024-03-04T14:18:15.749Z",
    "status": 404,
    "error": "Not Found",
    "message": "No message available",
    "path": "/groups/"
  }
}
PreviousLock Payment GroupNextDelete Payment Group

Last updated 1 year ago