Developer guide
API reference
  • API reference
    • Nothing Found
    Prerelease - hosted checkout API reference
    Authentication
    Customers
      Data definitions
        schema
        CustomerResponse
        schema
        ErrorMessage
        schema
        CreateCustomerRequest
        schema
        CustomerPaymentMethodsResponse
        schema
        CustomerByExternalReferenceIdResponse
        schema
        PaymentMethodData
        schema
        SetDefaultPaymentMethodRequest
        schema
        DefaultPaymentMethodResponse
      post
      Create a customer record
      get
      Get a customer's payment methods
      post
      Set a default payment method for a customer
      get
      Get the default payment method for a customer
      delete
      Delete the default payment method for a customer
    Payment intents
    Payment methods
    Setup intents

CustomerByExternalReferenceIdResponse

Response containing customer identifiers for external-reference-id based customer queries.

externalReferenceId
string

The unique identifier for the customer in your integration.

id
string <uuid>

The unique identifier for the customer record.

{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "externalReferenceId": "string"
}