Skip to main content
POST
/
store
/
payment-collections
/
{id}
/
payment-sessions
cURL
curl -X POST '{backend_url}/store/payment-collections/{id}/payment-sessions' \
-H 'Content-Type: application/json' \
-H 'x-publishable-api-key: {your_publishable_api_key}' \
--data-raw '{
  "provider_id": "{value}"
}'
{
  "payment_collection": {
    "id": "<string>",
    "currency_code": "<string>",
    "amount": 123,
    "status": "canceled",
    "payment_providers": [
      {
        "id": "<string>"
      }
    ],
    "authorized_amount": 123,
    "captured_amount": 123,
    "refunded_amount": 123,
    "completed_at": "2023-11-07T05:31:56Z",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "metadata": {},
    "payment_sessions": [
      {
        "id": "<string>",
        "amount": 123,
        "currency_code": "usd",
        "provider_id": "<string>",
        "data": {},
        "status": "authorized",
        "context": {
          "customer": {
            "id": "cus_123"
          }
        },
        "authorized_at": "2023-11-07T05:31:56Z",
        "payment_collection": {},
        "payment": {
          "id": "<string>",
          "amount": 123,
          "currency_code": "<string>",
          "provider_id": "<string>",
          "authorized_amount": 123,
          "data": {},
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "captured_at": "2023-11-07T05:31:56Z",
          "canceled_at": "2023-11-07T05:31:56Z",
          "captured_amount": 123,
          "refunded_amount": 123,
          "captures": [
            {
              "id": "<string>",
              "amount": 123,
              "created_at": "2023-11-07T05:31:56Z",
              "payment": {},
              "created_by": "<string>"
            }
          ],
          "refunds": [
            {
              "id": "<string>",
              "amount": 123,
              "created_at": "2023-11-07T05:31:56Z",
              "payment": {},
              "refund_reason_id": "<string>",
              "note": "<string>",
              "created_by": "<string>",
              "refund_reason": {
                "id": "<string>",
                "label": "<string>",
                "created_at": "2023-11-07T05:31:56Z",
                "updated_at": "2023-11-07T05:31:56Z",
                "code": "<string>",
                "description": "<string>",
                "metadata": {}
              }
            }
          ],
          "payment_collection": {},
          "payment_session": {}
        }
      }
    ],
    "payments": [
      {
        "id": "<string>",
        "amount": 123,
        "currency_code": "<string>",
        "provider_id": "<string>",
        "authorized_amount": 123,
        "data": {},
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "captured_at": "2023-11-07T05:31:56Z",
        "canceled_at": "2023-11-07T05:31:56Z",
        "captured_amount": 123,
        "refunded_amount": 123,
        "captures": [
          {
            "id": "<string>",
            "amount": 123,
            "created_at": "2023-11-07T05:31:56Z",
            "payment": {},
            "created_by": "<string>"
          }
        ],
        "refunds": [
          {
            "id": "<string>",
            "amount": 123,
            "created_at": "2023-11-07T05:31:56Z",
            "payment": {},
            "refund_reason_id": "<string>",
            "note": "<string>",
            "created_by": "<string>",
            "refund_reason": {
              "id": "<string>",
              "label": "<string>",
              "created_at": "2023-11-07T05:31:56Z",
              "updated_at": "2023-11-07T05:31:56Z",
              "code": "<string>",
              "description": "<string>",
              "metadata": {}
            }
          }
        ],
        "payment_collection": {},
        "payment_session": {}
      }
    ]
  }
}

Headers

​
x-publishable-api-key
string
required

Publishable API Key created in the Medusa Admin.

​
x-medusa-locale
string

The locale in BCP 47 format to retrieve localized content.

Example:

"en-US"

Path Parameters

​
id
string
required

The payment collection's ID.

Query Parameters

​
fields
string

Comma-separated fields that should be included in the returned data. if a field is prefixed with + it will be added to the default fields, using - will remove it from the default fields. without prefix it will replace the entire default fields.

​
locale
string

The locale in BCP 47 format to retrieve localized content.

Example:

"en-US"

Body

application/json

The payment session's details.

​
provider_id
string
required

The ID of the payment provider the customer chose.

Example:

"pp_stripe_stripe"

​
data
object

Any data necessary for the payment provider to process the payment.

Response

OK

The payment collection's details.

​
payment_collection
object
required

The payment collection's details.