Skip to main content
POST
/
api
/
v1
/
csp
/
payments
Create Payment
curl --request POST \
  --url https://sandbox.api.paylias.xyz/gateway/api/v1/csp/payments \
  --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 '
{
  "payment_id": "cjes76vsemvj3obsnc52",
  "amount": {
    "currency": "USD",
    "total": "10000"
  },
  "beneficiary_party": {
    "payment_address": "[email protected]",
    "first_name": "John",
    "last_name": "Doe",
    "email": "[email protected]",
    "phone": "+1234567890",
    "type": "Payee_Individual",
    "billing": {
      "country": "US"
    }
  },
  "debtor_party": {
    "payment_address": "[email protected]",
    "first_name": "Jane",
    "last_name": "Smith",
    "email": "[email protected]",
    "phone": "+1987654321",
    "type": "Payer_Individual",
    "billing": {
      "country": "US"
    }
  },
  "reference": "INV001",
  "payment_type": "Type_Pull"
}
'
{
  "ok": true,
  "data": {
    "amount": {
      "currency": "USD",
      "total": "10000"
    },
    "beneficiary_party": {
      "payment_address": "[email protected]",
      "first_name": "John",
      "last_name": "Doe",
      "email": "[email protected]",
      "phone": "+1234567890",
      "type": "Payee_Individual",
      "billing": {
        "country": "US"
      }
    },
    "debtor_party": {
      "payment_address": "[email protected]",
      "first_name": "Jane",
      "last_name": "Smith",
      "email": "[email protected]",
      "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",
    "payment_type": "Type_Pull"
  }
}

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

Body

application/json

Request to create a new payment

Request to create a new payment

​
payment_id
string
required
Example:

"cjes76vsemvj3obsnc52"

​
amount
object
required

Amount information

​
beneficiary_party
object
required

Party receiving the payment

​
debtor_party
object
required

Party sending the payment

​
payment_type
enum<string>
required

The type of payment to initiate

Available options:
Type_Pull,
Type_Push
​
reference
string

Reference for the payment

Example:

"INV001"

Response

Response containing Payment information

Standard response structure for successful operations

​
ok
boolean

Indicates if the operation was successful

Example:

true

​
data
object

Payment information