GET
/
api
/
v1
/
csp
/
payments
Search Payments
curl --request GET \
  --url https://sandbox.paylias.xyz/gateway/api/v1/csp/payments \
  --header 'X-PAYLIAS-API-KEY: <api-key>' \
  --header 'x-org-id: <x-org-id>' \
  --header 'x-partner-id: <x-partner-id>'
{
  "ok": true,
  "data": {
    "count": 1,
    "payments": [
      {
        "amount": {
          "currency": "USD",
          "total": "10000"
        },
        "beneficiary_party": {
          "payment_address": "john@example.com",
          "first_name": "John",
          "last_name": "Doe",
          "email": "john@example.com",
          "phone": "+1234567890",
          "type": "Payee_Individual",
          "billing": {
            "country": "US"
          }
        },
        "debtor_party": {
          "payment_address": "jane@example.com",
          "first_name": "Jane",
          "last_name": "Smith",
          "email": "jane@example.com",
          "phone": "+1987654321",
          "type": "Payer_Individual",
          "billing": {
            "country": "US"
          }
        },
        "device": {},
        "location": {},
        "expires_at": "2023-08-13T08:55:04Z",
        "initiated_at": "2023-08-12T08:55:04Z",
        "organization_id": "org_d09gv1s20or2svojjmt0",
        "partner_id": "part_123456789",
        "payment_id": "pay_123456789",
        "reference": "INV001"
      }
    ]
  }
}

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

Query Parameters

payment_id
string
Example:

"cjes76vsemvj3obsnc60"

reference
string
Example:

"INV0001"

beneficiary_payment_address
string
Example:

"john@stripe-platinum"

debtor_payment_address
string
Example:

"john@stripe-platinum"

limit
string
Example:

"10"

page
string
Example:

"1"

direction
string
Example:

"DESC"

Response

200
application/json

Response containing list of payments

Standard response structure for successful operations