Skip to main content
POST
/
admin
/
payment-collections
/
{id}
/
mark-as-paid
JS SDK
import Medusa from "@medusajs/js-sdk"

export const sdk = new Medusa({
  baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
  debug: import.meta.env.DEV,
  auth: {
    type: "session",
  },
})

sdk.admin.paymentCollection.markAsPaid("paycol_123", {
  order_id: "order_123"
})
.then(({ payment_collection }) => {
  console.log(payment_collection)
})
{
  "payment_collection": {
    "id": "<string>",
    "currency_code": "<string>",
    "amount": 123,
    "status": "canceled",
    "payment_providers": [
      {
        "id": "<string>",
        "is_enabled": true
      }
    ],
    "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": {
              "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": {}
            },
            "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": {
          "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": {}
          }
        }
      }
    ]
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

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.

Body

application/json

The payment details.

​
order_id
string
required

The ID of the order associated with the payment collection.

Response

OK

The payment collection's details.

​
payment_collection
object
required

The payment collection's details.