Sign in
Advanced

Create Payment

Changed on

Create a manual payment in the HubSpot system. This endpoint allows you to specify details such as the payment amount, currency, payment method, and date. It is useful for recording payments that occur outside of automated systems, ensuring all payment data is captured within HubSpot.

post/commerce/payments/2027-03-beta/manual-payments

Request

  • Base URL: https://api.hubapi.com
  • URL: https://api.hubapi.com/commerce/payments/2027-03-beta/manual-payments
  • Auth: one of:
    • OAuth 2 (authorization code, authorization URL https://app.hubspot.com/oauth/authorize, token URL https://api.hubapi.com/oauth/v1/token, scopes: crm.objects.commercepayments.write)
    • OAuth 2 (authorization code, authorization URL https://app.hubspot.com/oauth/authorize, token URL https://api.hubapi.com/oauth/v1/token, scopes: crm.schemas.commercepayments.write)

Request body

currencyCodestring required

The currency code for the payment, represented as a string.

customerEmailstring

The email address of the customer making the payment, represented as a string.

paymentAmountnumber required

The amount of the payment, represented as a number.

paymentDatestring required

The date of the payment, represented as a string.

paymentMethodstring required

The method used for the payment, represented as a string.

Response

successful operation

idstring required

The unique identifier for the created manual payment, represented as a string.

Changes

  • 2027-03-beta7a715584ab4bRevision changes
    • ○

      the security scope crm.objects.commercepayments.write was added to the endpoint's security scheme oauth2

    • ○

      the security scope crm.schemas.commercepayments.write was removed from the endpoint's security scheme oauth2

  • 2027-03-beta63496c34ad51Revision changes
    • ○

      the security scope crm.objects.commercepayments.write was added to the endpoint's security scheme oauth2

    • ○

      the security scope crm.schemas.commercepayments.write was removed from the endpoint's security scheme oauth2