Medusa

Create Payment Collection

POST

/admin/payment-collections

Payment Collections

Create a payment collection.

Request Example

JavaScript

Shell

Java

Swift

curl --location -g --request POST '{{BASE_URL}}/admin/payment-collections' \
--header 'Content-Type: application/json' \
--data-raw '{
    "order_id": "string",
    "amount": 0
}'

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": {},
        "payment_providers": [
            {
                "id": "string",
                "is_enabled": true
            }
        ],
        "payment_sessions": [
            {
                "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,
                    "captures": [
                        {
                            "id": "string",
                            "amount": 0,
                            "created_at": "2019-08-24T14:15:22Z",
                            "created_by": "string",
                            "payment": {}
                        }
                    ],
                    "refunds": [
                        {
                            "refund_reason": {
                                "id": "string",
                                "label": "string",
                                "description": "string",
                                "metadata": {},
                                "created_at": "2019-08-24T14:15:22Z",
                                "updated_at": "2019-08-24T14:15:22Z"
                            },
                            "id": "string",
                            "amount": 0,
                            "refund_reason_id": "string",
                            "note": "string",
                            "created_at": "2019-08-24T14:15:22Z",
                            "created_by": "string",
                            "payment": {}
                        }
                    ],
                    "payment_collection": {},
                    "payment_session": {},
                    "data": {}
                },
                "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"
                    }
                }
            }
        ],
        "payments": [
            {
                "payment_session": {
                    "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,
                        "captures": [
                            {
                                "id": "string",
                                "amount": 0,
                                "created_at": "2019-08-24T14:15:22Z",
                                "created_by": "string",
                                "payment": {}
                            }
                        ],
                        "refunds": [
                            {
                                "refund_reason": {
                                    "id": "string",
                                    "label": "string",
                                    "description": "string",
                                    "metadata": {},
                                    "created_at": "2019-08-24T14:15:22Z",
                                    "updated_at": "2019-08-24T14:15:22Z"
                                },
                                "id": "string",
                                "amount": 0,
                                "refund_reason_id": "string",
                                "note": "string",
                                "created_at": "2019-08-24T14:15:22Z",
                                "created_by": "string",
                                "payment": {}
                            }
                        ],
                        "payment_collection": {},
                        "payment_session": {},
                        "data": {}
                    },
                    "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"
                        }
                    }
                },
                "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,
                "captures": [
                    {
                        "id": "string",
                        "amount": 0,
                        "created_at": "2019-08-24T14:15:22Z",
                        "created_by": "string",
                        "payment": {}
                    }
                ],
                "refunds": [
                    {
                        "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,
                            "captures": [
                                {
                                    "id": "string",
                                    "amount": 0,
                                    "created_at": "2019-08-24T14:15:22Z",
                                    "created_by": "string",
                                    "payment": {}
                                }
                            ],
                            "refunds": [
                                {
                                    "refund_reason": {
                                        "id": "string",
                                        "label": "string",
                                        "description": "string",
                                        "metadata": {},
                                        "created_at": "2019-08-24T14:15:22Z",
                                        "updated_at": "2019-08-24T14:15:22Z"
                                    },
                                    "id": "string",
                                    "amount": 0,
                                    "refund_reason_id": "string",
                                    "note": "string",
                                    "created_at": "2019-08-24T14:15:22Z",
                                    "created_by": "string",
                                    "payment": {}
                                }
                            ],
                            "payment_collection": {},
                            "payment_session": {},
                            "data": {}
                        },
                        "refund_reason": {
                            "id": "string",
                            "label": "string",
                            "description": "string",
                            "metadata": {},
                            "created_at": "2019-08-24T14:15:22Z",
                            "updated_at": "2019-08-24T14:15:22Z"
                        },
                        "id": "string",
                        "amount": 0,
                        "refund_reason_id": "string",
                        "note": "string",
                        "created_at": "2019-08-24T14:15:22Z",
                        "created_by": "string"
                    }
                ],
                "payment_collection": {},
                "data": {}
            }
        ],
        "status": "canceled"
    }
}

Request

Authorization

Query Params

fields

string

fields

optional

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.

Body Params application/json

The payment collection's details.

order_id

string

order_id

required

The ID of the associated order.

amount

number

amount

required

The amount to be paid.

Examples

Responses

🟢200OK

application/json

Body

The payment collection's details.

payment_collection

object (AdminPaymentCollection)

required

The payment collection's details.

string

required

The payment collection's ID.

currency_code

string

currency_code

required

The payment collection's currency code.

amount

number

amount

required

The total amount to be paid.

authorized_amount

number

authorized_amount

optional

The total authorized amount of the collection's payments.

captured_amount

number

captured_amount

optional

The total captured amount of the collection's payments.

refunded_amount

number

refunded_amount

optional

The total refunded amount of the collection's payments.

completed_at

string <date-time>

completed_at

optional

The date the payment collection was completed.

created_at

string <date-time>

created_at

optional

The date the payment collection was created.

updated_at

string <date-time>

updated_at

optional

The date the payment collection was updated.

metadata

object

optional

The payment collection's metadata, can hold custom key-value pairs.

payment_providers

array[object (AdminPaymentProvider) {2}]

required

The payment provider used to process the collection's payments and sessions.

payment_sessions

array[object (AdminPaymentSession) {10}]

optional

The payment collection's payment sessions.

payments

array[object (AdminPayment) {16}]

optional

The payment collection's payments.

status

enum<string>

required

The payment collection's status.

Allowed values:

cancelednot_paidawaitingauthorizedpartially_authorized

🟠400Bad Request

🟠401Unauthorized

🟠404Record Not Found

🟠409409

🟠422Parameter Error

🔴500Server Error

Modified at 2025-06-17 04:10:32

Delete a Payment Collection

Mark a Payment Collection as Paid