Skip to main content
GET
/
connections
/
{connection_id}
Get a connection
curl --request GET \
  --url https://api.lavapayments.com/v1/connections/{connection_id} \
  --header 'Authorization: Bearer <token>'
{
  "connection_id": "con_01K7QJT2YR00E6FF5B9WAXP0GB",
  "connection_secret": "cons_live_FhJCPNbrfViJFCiCQp8bWQEel20z18UyA39ZP22LfJ0AdB9h9kVX_D",
  "reference_id": "customer_123456",
  "wallet": {
    "balance": "125.5000000000",
    "phone": "+14155552671",
    "email": "[email protected]",
    "first_name": "Jane",
    "last_name": "Smith",
    "autopay_enabled": true
  },
  "next_usage_reset": "2023-05-15T08:35:42Z",
  "previous_usage_reset": "2023-05-15T08:35:42Z",
  "created_at": "2023-05-15T08:35:42Z"
}

Authorizations

Authorization
string
header
required

Bearer token authentication used for standard API calls. Format: 'Bearer YOUR_API_KEY'

Path Parameters

connection_id
string
required

Connection ID

Response

Connection details

connection_id
string
required

Unique identifier for the connection between a merchant and a wallet

Example:

"con_01K7QJT2YR00E6FF5B9WAXP0GB"

wallet
object
required
created_at
string<date-time>
required

ISO 8601 timestamp when the connection was created

Example:

"2023-05-15T08:35:42Z"

connection_secret
string

Secret key for the connection that can be used to make requests to the forward endpoint

Example:

"cons_live_FhJCPNbrfViJFCiCQp8bWQEel20z18UyA39ZP22LfJ0AdB9h9kVX_D"

reference_id
string

Your custom identifier for this connection in your system

Example:

"customer_123456"

next_usage_reset
string<date-time>

ISO 8601 timestamp when the next usage reset will occur

Example:

"2023-05-15T08:35:42Z"

previous_usage_reset
string<date-time>

ISO 8601 timestamp when the previous usage reset occurred

Example:

"2023-05-15T08:35:42Z"