Journey

Appearance

Payments API Documentation ​

Overview ​

The Payments API provides endpoints for managing payment-related operations.

Bootstrap ​

GET https://api.journeyid.com/payments/bootstrap

Retrieves the initial configuration for payments, including available products and customer information.

Request Body ​

json
{
  "sessionRef": "string (optional)",
  "customerRef": "string (optional)",
  "phoneNumber": "string (E.164 format)"
}

Response ​

json
{
  "products": [
    {
      "id": "string",
      "title": "string",
      "description": "string",
      "price": number,
      "currency": "string"
    }
  ],
  "customers": [
    {
      "id": "string",
      "name": "string",
      "email": "string"
    }
  ]
}

Send ​

POST https://api.journeyid.com/payments/send

Sends a payment request to a customer.

Request Body ​

json
{
  // Common request fields
  "sessionRef": "string",
  "customerRef": "string (optional)",
  "phoneNumber": "string (E.164 format)",

  // App specific fields
  "productId": "string"
}

Response ​

json
{
  "requestId": "string",
  "wsToken": "string"
}