Skip to main content
A Payment Admission represents an incoming payment notification to a recipient’s financial platform. It serves as a system generated request informing the recipient partner that one of their customers has initiated a payment. Payment Admissions are read-only resources—you cannot create or modify them via API. Instead, they are generated automatically by Paylias during the payment flow and delivered to your system via webhooks.

​
Admission APIs

​
Receiving Admissions

To receive Payment Admissions, your platform must:
  • Subscribe to the payment_admission:created webhook event.
  • Implement a webhook endpoint that can securely accept and process these events.
This ensures your system is notified immediately whenever an incoming payment is intended for one of your customers.

​
Retrieve a Payment Admission by ID

To fetch a specific Payment Admission by its ID: 
curl --request GET \
     --url https://sandbox.paylias.xyz/gateway/api/v1/csp/payments/{payment_id}/admissions/{admission_id} \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --header 'x-paylias-api-key: <API-KEY>' \
     --header 'x-org-id: <Org-ID>' \
     --header 'x-partner-id: <Partner-ID>'
Replace {payment_id} and {admission_id} with the ID of the payment and admission you’re looking for.

​
Response

{
  "ok": true,
  "data": {
    "token": "pay_adm_cvk3jvs20or8munut3mg",
    "payment_id": "cjes76vsemvj3obsnc52",
    "organization_id": "org_ct239n420or249k5bo90",
    "partner_id": "part_ct23b6420or249k5boag",
    "status": 1,
    "admission_time": 1743272447,
    "relationships": {
      "payment": {
        "payment_id": "cjes76vsemvj3obsnc52",
        "organization_id": "org_ct239n420or249k5bo90",
        "partner_id": "part_ct23b6420or249k5boag",
        "reference": "INV0001",
        "initiated_at": 1743270060,
        "expires_at": 1743273661,
        "amount": {
          "currency": "USD",
          "total": "10000"
        },
        "debtor_party": {
          "payment_address": "john@stripe-platinum",
          "first_name": "John",
          "last_name": "Collison",
          "email": "johnc@stripe.com",
          "phone": "+16462442945",
          "type": "Payee_Individual",
          "billing": {
            "country": "US"
          }
        },
        "beneficiary_party": {
          "payment_address": "ziyad@safepay-platinum",
          "first_name": "Ziyad",
          "last_name": "Parekh",
          "email": "ziyad.parekh@gmail.com",
          "phone": "+923008277879",
          "type": "Payee_Individual",
          "billing": {
            "country": "US"
          }
        },
        "device": {},
        "location": {}
      }
    }
  }
}

​
List Admissions for a Payment

You can also list all Payment Admissions linked to a given payment using the payment_id: 
curl --request GET \
     --url https://sandbox.paylias.xyz/gateway/api/v1/csp/payments/{payment_id}/admissions \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --header 'x-paylias-api-key: <API-KEY>' \
     --header 'x-org-id: <Org-ID>' \
     --header 'x-partner-id: <Partner-ID>'

​
Response

{
  "ok": true,
  "data": {
    "token": "pay_adm_cvk3jvs20or8munut3mg",
    "payment_id": "cjes76vsemvj3obsnc52",
    "organization_id": "org_ct239n420or249k5bo90",
    "partner_id": "part_ct23b6420or249k5boag",
    "status": 1,
    "admission_time": 1743272447,
    "relationships": {
      "payment": {
        "payment_id": "cjes76vsemvj3obsnc52",
        "organization_id": "org_ct239n420or249k5bo90",
        "partner_id": "part_ct23b6420or249k5boag",
        "reference": "INV0001",
        "initiated_at": 1743270060,
        "expires_at": 1743273661,
        "amount": {
          "currency": "USD",
          "total": "10000"
        },
        "debtor_party": {
          "payment_address": "john@stripe-platinum",
          "first_name": "John",
          "last_name": "Collison",
          "email": "johnc@stripe.com",
          "phone": "+16462442945",
          "type": "Payee_Individual",
          "billing": {
            "country": "US"
          }
        },
        "beneficiary_party": {
          "payment_address": "ziyad@safepay-platinum",
          "first_name": "Ziyad",
          "last_name": "Parekh",
          "email": "ziyad.parekh@gmail.com",
          "phone": "+923008277879",
          "type": "Payee_Individual",
          "billing": {
            "country": "US"
          }
        },
        "device": {},
        "location": {}
      }
    }
  }
}
⌘I