The Payment Session object

The Payment Session object contains information about the payment session.

Attributes

‚Äč

id string

Unique identifier of the payment session.

createdTime datetime

The time when the order was created.

amount number

Amount intended to be collected from this payment session.

currency string

3-letter ISO currency code.

description string

An arbitrary string attached to the object. Useful for displaying to users.

shipping object

Contains the shipping information.

shipping[].address object

Contains the addess information.

shipping[].address.line1 string

The first line of the 's customerpayment address.

shipping[].address.line2 string

The second line of the customer's payment address.

shipping[].address.city

string

City or town.

shipping[].address.postalCode string

ZIP or postal code.

shipping[].address.state string

State/County/Province/Region.

shipping[].address.country string

Two-letter country code.

shipping[].name string

The customer's name.

shipping[].phone string

The customer's phone number.

shipping[].email string

The customer's email.

chargeIds string

Identifier of the charge used in this payment session, if any.

sourceId string

Identifier of the source used in this payment session, if any.

customerId string

Identifier of the customer this payment session is for, if any.

liveMode boolean

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

updatedTime string

The time when the order was created.

The Payment Session object
The Payment Session object
{
"id": "ps_1971b9b5-7d6b-49d5-b2a6-88ca7e53f750",
"createdTime": "2018-04-25T20:36:00Z",
"amount": "10.21",
"currency": "USD",
"description": "string",
"shipping": {
"address": {
"line1": "10380 Bren Rd W",
"line2": "string",
"city": "Minnetonka",
"postalCode": "55129",
"state": "MN",
"country": "US"
},
"name": "John Smith",
"phone": "952-111-1111",
"email": "jsmith@digitalriver.com"
},
"chargeIds": [
"ch_9f3b8fba-1dd6-4dde-a3d7-e4c58d5333b6"
],
"sourceId": "src_d5528fca-229f-4fc3-848a-812198b18dcd",
"customerId": "cus_c71fd06f-b332-413b-8a7e-5cfd351f4e80",
"liveMode": false,
"updatedTime": "2018-04-25T20:36:00Z"
}