Skip to main content
PUT
Update Payment Admission Task

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

A task associated with a payment admission workflow