Initialize Payment Session of a Payment Collection

POST

/store/payment-collections/{id}/payment-sessions

Initialize and add a payment session to a payment collection. This is used during checkout, where you create a payment collection for the cart, then initialize a payment session for the payment provider that the customer chooses.

Request Example

Shell

JavaScript

Java

Swift

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}"
}'

Response Example

200 - Example 1

{
    "payment_collection": {
        "id": "string",
        "currency_code": "string",
        "amount": 0,
        "authorized_amount": 0,
        "captured_amount": 0,
        "refunded_amount": 0,
        "completed_at": "2019-08-24T14:15:22Z",
        "created_at": "2019-08-24T14:15:22Z",
        "updated_at": "2019-08-24T14:15:22Z",
        "metadata": {},
        "status": "canceled",
        "payment_providers": [
            {
                "id": "string"
            }
        ],
        "payment_sessions": [
            {
                "id": "string",
                "amount": 0,
                "currency_code": "usd",
                "provider_id": "string",
                "authorized_at": "2019-08-24T14:15:22Z",
                "payment_collection": {},
                "data": {},
                "status": "authorized",
                "context": {
                    "customer": {
                        "id": "cus_123"
                    }
                },
                "payment": {
                    "id": "string",
                    "amount": 0,
                    "authorized_amount": 0,
                    "currency_code": "string",
                    "provider_id": "string",
                    "created_at": "2019-08-24T14:15:22Z",
                    "updated_at": "2019-08-24T14:15:22Z",
                    "captured_at": "2019-08-24T14:15:22Z",
                    "canceled_at": "2019-08-24T14:15:22Z",
                    "captured_amount": 0,
                    "refunded_amount": 0,
                    "payment_collection": {},
                    "payment_session": {},
                    "data": {},
                    "captures": [
                        {
                            "id": "string",
                            "amount": 0,
                            "created_at": "2019-08-24T14:15:22Z",
                            "created_by": "string",
                            "payment": {}
                        }
                    ],
                    "refunds": [
                        {
                            "id": "string",
                            "amount": 0,
                            "refund_reason_id": "string",
                            "note": "string",
                            "created_at": "2019-08-24T14:15:22Z",
                            "created_by": "string",
                            "payment": {},
                            "refund_reason": {
                                "id": "string",
                                "label": "string",
                                "description": "string",
                                "metadata": {},
                                "created_at": "2019-08-24T14:15:22Z",
                                "updated_at": "2019-08-24T14:15:22Z"
                            }
                        }
                    ]
                }
            }
        ],
        "payments": [
            {
                "id": "string",
                "amount": 0,
                "authorized_amount": 0,
                "currency_code": "string",
                "provider_id": "string",
                "created_at": "2019-08-24T14:15:22Z",
                "updated_at": "2019-08-24T14:15:22Z",
                "captured_at": "2019-08-24T14:15:22Z",
                "canceled_at": "2019-08-24T14:15:22Z",
                "captured_amount": 0,
                "refunded_amount": 0,
                "payment_collection": {},
                "payment_session": {},
                "data": {},
                "captures": [
                    {
                        "id": "string",
                        "amount": 0,
                        "created_at": "2019-08-24T14:15:22Z",
                        "created_by": "string",
                        "payment": {}
                    }
                ],
                "refunds": [
                    {
                        "id": "string",
                        "amount": 0,
                        "refund_reason_id": "string",
                        "note": "string",
                        "created_at": "2019-08-24T14:15:22Z",
                        "created_by": "string",
                        "payment": {},
                        "refund_reason": {
                            "id": "string",
                            "label": "string",
                            "description": "string",
                            "metadata": {},
                            "created_at": "2019-08-24T14:15:22Z",
                            "updated_at": "2019-08-24T14:15:22Z"
                        }
                    }
                ]
            }
        ]
    }
}

Request

Path Params

Query Params

Header Params

Body Params application/json

Examples

Responses

🟢200OK

application/json

Body

🟠400Bad Request

🟠401Unauthorized

🟠404Record Not Found

🟠409409

🟠422Parameter Error

🔴500Server Error

Modified at 2025-06-17 04:21:30

Accept Order Transfer

Create Payment Collection