Fetch Payment Admission by Payment

curl --request GET \
  --url https://sandbox.api.paylias.xyz/gateway/api/v1/csp/payments/{payment_id}/admissions \
  --header 'X-PAYLIAS-API-KEY: <api-key>' \
  --header 'x-org-id: <x-org-id>' \
  --header 'x-partner-id: <x-partner-id>'

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

GET

api

csp

payments

{payment_id}

admissions

Fetch Payment Admission by Payment

curl --request GET \
  --url https://sandbox.api.paylias.xyz/gateway/api/v1/csp/payments/{payment_id}/admissions \
  --header 'X-PAYLIAS-API-KEY: <api-key>' \
  --header 'x-org-id: <x-org-id>' \
  --header 'x-partner-id: <x-partner-id>'

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

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

Path Parameters

payment_id

string

required

The unique identifier for the payment

Example:

"pay_123456789"

Response

Response containing payment admission information

Standard response structure for successful operations

boolean

Indicates if the operation was successful

Example:

true

data

object

Contains the response data Admission of a payment into the system, including metadata and relationships

Show child attributes

data.admission_time

number

The timestamp when the payment was admitted

Example:

1743272447

data.organization_id

string

The ID of the organization associated with the payment

Example:

"org_ct239n420or249k5bo90"

data.partner_id

string

The ID of the partner associated with the payment

Example:

"part_ct23b6420or249k5boag"

data.payment_id

string

Unique identifier for the admitted payment

Example:

"cjes76vsemvj3obsnc52"

data.status

enum<number>

Status of the payment admission

Available options:

1,

2,

3,

4

Example:

1

data.token

string

Unique identifier for the payment admission

Example:

"pay_adm_cvk3jvs20or8munut3mg"

data.relationships

object

Contains related resources

Show child attributes

data.relationships.payment

object

Payment information

Show child attributes

data.relationships.payment.amount

object

Amount information

Show child attributes

data.relationships.payment.amount.currency

string

Currency code

Example:

"USD"

data.relationships.payment.amount.total

string

Total amount

Example:

"100.00"

data.relationships.payment.beneficiary_party

object

Party information for payments

Show child attributes

data.relationships.payment.beneficiary_party.billing

object

Show child attributes

data.relationships.payment.beneficiary_party.billing.country

string

Country code

Example:

"US"

data.relationships.payment.beneficiary_party.email

string

Email of the party

Example:

"[email protected]"

data.relationships.payment.beneficiary_party.first_name

string

First name of the party

Example:

"John"

data.relationships.payment.beneficiary_party.last_name

string

Last name of the party

Example:

"Doe"

data.relationships.payment.beneficiary_party.payment_address

string

Payment address of the party

Example:

"john@safepay"

data.relationships.payment.beneficiary_party.phone

string

Phone number of the party

Example:

"+1234567890"

data.relationships.payment.beneficiary_party.type

string

Type of the party

Example:

"individual"

data.relationships.payment.debtor_party

object

Party information for payments

Show child attributes

data.relationships.payment.debtor_party.billing

object

Show child attributes

data.relationships.payment.debtor_party.billing.country

string

Country code

Example:

"US"

data.relationships.payment.debtor_party.email

string

Email of the party

Example:

"[email protected]"

data.relationships.payment.debtor_party.first_name

string

First name of the party

Example:

"John"

data.relationships.payment.debtor_party.last_name

string

Last name of the party

Example:

"Doe"

data.relationships.payment.debtor_party.payment_address

string

Payment address of the party

Example:

"john@safepay"

data.relationships.payment.debtor_party.phone

string

Phone number of the party

Example:

"+1234567890"

data.relationships.payment.debtor_party.type

string

Type of the party

Example:

"individual"

data.relationships.payment.device

object

Device information

data.relationships.payment.expires_at

string<date-time>

Expiration time of the payment

Example:

"2023-08-13T08:55:04Z"

data.relationships.payment.initiated_at

string<date-time>

Initiation time of the payment

Example:

"2023-08-12T08:55:04Z"

data.relationships.payment.location

object

Location information

data.relationships.payment.organization_id

string

ID of the organization

Example:

"org_d09gv1s20or2svojjmt0"

data.relationships.payment.partner_id

string

ID of the partner

Example:

"part_123456789"

data.relationships.payment.payment_id

string

Payment identifier

Example:

"pay_123456789"

data.relationships.payment.reference

string

Reference for the payment

Example:

"INV001"

data.relationships.payment.payment_type

enum<string>

The type of payment to initiate

Available options:

Type_Pull,

Type_Push

Example:

"Type_Pull"

Find Payment Submission Find Payment Admission

⌘I

API documentation

Authorizations

Headers

Path Parameters

Response