Skip to main content
PUT
/
api
/
v1
/
csp
/
payments
/
{payment_id}
/
admissions
/
{admission_id}
/
tasks
/
{task_id}
Update Payment Admission Task
curl --request PUT \
  --url https://sandbox.api.paylias.xyz/gateway/api/v1/csp/payments/{payment_id}/admissions/{admission_id}/tasks/{task_id} \
  --header 'Content-Type: application/json' \
  --header 'X-PAYLIAS-API-KEY: <api-key>' \
  --header 'idempotency-key: <idempotency-key>' \
  --header 'x-org-id: <x-org-id>' \
  --header 'x-partner-id: <x-partner-id>' \
  --data '{
  "status": "completed",
  "status_reason": "accepted"
}'
{
  "ok": true,
  "data": {
    "admission_id": "pay_adm_cvk3rfk20or8munut3v0",
    "assignee": 1,
    "status": 1,
    "status_reason": 1,
    "created_on": 1743273406,
    "modified_on": 1743273406,
    "name": "customer_authentication",
    "organization_id": "org_ct239n420or249k5bo90",
    "partner_id": "part_ct23b6420or249k5boag",
    "payment_id": "cjes76vsemvj3obsnc53",
    "token": "pat_cvk3rfk20or8munut400",
    "workflow": "customer_authentication"
  }
}

Authorizations

​
X-PAYLIAS-API-KEY
string
header
required

Headers

​
x-org-id
string
default:""
required

The Organization ID header used for authorization

​
x-partner-id
string
default:""
required

The Partner ID header used for authorization

​
idempotency-key
string
default:""
required

The Idempotency Key - usually a UUID

Path Parameters

​
payment_id
string
required

The unique identifier for the payment

Example:

"pay_123456789"

​
admission_id
string
required

The unique identifier for the admission

Example:

"adm_ct23b6420or249k5boag"

​
task_id
string
required

The unique identifier for the task

Example:

"task_ct23c1420or249k5bocg"

Body

application/json

Request to update the status of a payment admission task

​
status
enum<string>
required

The new status of the task

Available options:
pending,
completed,
failed,
on_hold
Example:

"completed"

​
status_reason
enum<string>
required

Reason for the status update

Available options:
accepted,
invalid_beneficiary_details,
alias_not_provisioned,
unknown_alias,
account_closed,
duplicate_payment,
blocked_account,
currency_mismatch,
business_reasons,
deceased_account_holder,
insufficient_funds,
unknown_error,
fraud_detected,
regulatory_issues,
account_unavailable
Example:

"accepted"

Response

Response containing a payment admission task

Standard response structure for successful operations

​
ok
boolean

Indicates if the operation was successful

Example:

true

​
data
object

Contains the response data A task associated with a payment admission workflow

⌘I