Customer Profiles

Customers are used to store payer information and associate one or more payment methods (card tokens) with a unique profile. A customer can be created, queried, updated, and linked to stored cards for one-click or recurring purchases.

Create a Customer

Create a customer profile to store payer information and enable future card registrations. To generate a recurring token (Commerce Token), a customer must first be registered in Bamboo, use the following endpoint:

Request URL

Environment	Endpoint
Staging	`https://api.stage.bamboopayment.com/v3/api/customer`
Production	`https://api.bamboopayment.com/v3/api/customer`

Request Parameters

Property	Type	Mandatory?	Description
`Email`	`string`	Yes	Customer email address.
`CustomerId`	`integer`	No	Internal customer identifier.
`FirstName`	`string`	No	Customer first name.
`LastName`	`string`	No	Customer last name.
`ExternalCustomerId`	`string`	No	Merchant reference identifier for the customer.
`PhoneNumber`	`string`	No	Customer phone number.
`DocumentType`	`string`	No	Customer document type (e.g., `CI.UY`, `DNI.AR`, `CPF.BR`).
`DocumentNumber`	`string`	No	Customer document number.
`SessionId`	`string`	No	Session identifier issued by Bamboo for customer-related flows.
`Address`	`object`	No	Customer address information.
`Address` → `Country`	`string`	No	Country name (e.g., `Uruguay`).
`Address` → `CountryIsoCode`	`string`	No	Two-letter ISO country code (e.g., `UY`).
`Address` → `State`	`string`	No	Department, state, or region.
`Address` → `City`	`string`	No	City of residence.
`Address` → `AddressDetail`	`string`	No	Full street address including number and complement.
`Address` → `PostalCode`	`string`	No	Postal code.

Request Example

To test this endpoint, use the API Reference for Customers

{
  "Email": "[email protected]",
  "CustomerId": 0,
  "FirstName": "Lucía",
  "LastName": "Pérez",
  "ExternalCustomerId": "CLI-UY-001",
  "PhoneNumber": "098123456",
  "DocumentType": "CI.UY",
  "DocumentNumber": "45678912",
  "SessionId": null,
  "Address": {
    "Country": "Uruguay",
    "CountryIsoCode": "UY",
    "State": "Montevideo",
    "City": "Montevideo",
    "AddressDetail": "Av. Rivera 1234",
    "PostalCode": "11300"
  }
}

Response

The API returns the newly created customer profile, including:

Property	Type	Description
`Email`	`string`	Customer email address.
`CustomerId`	`integer`	Unique identifier generated for the customer.
`FirstName`	`string`	Customer first name.
`LastName`	`string`	Customer last name.
`ExternalCustomerId`	`string`	Merchant reference identifier for the customer.
`PhoneNumber`	`string`	Customer phone number.
`DocumentType`	`string`	Document type used by the customer.
`DocumentNumber`	`string`	Customer document number.
`SessionId`	`string`	Session identifier associated with the customer flow.
`Address`	`object`	Customer address information.
`Address` → `Country`	`string`	Country name.
`Address` → `CountryIsoCode`	`string`	Two-letter ISO country code.
`Address` → `State`	`string`	Department, state, or region.
`Address` → `City`	`string`	City of residence.
`Address` → `AddressDetail`	`string`	Full street address including number and complement.
`Address` → `PostalCode`	`string`	Postal code.

Example Response

{
  "Email": "[email protected]",
  "CustomerId": 249205,
  "FirstName": "Lucía",
  "LastName": "Pérez",
  "ExternalCustomerId": "CLI-UY-001",
  "PhoneNumber": "098123456",
  "DocumentType": "CI.UY",
  "DocumentNumber": "45678912",
  "SessionId": "CT_3a9217b3-98f5-4f6d-9f59-0e12b55fc921",
  "Address": {
    "Country": "Uruguay",
    "CountryIsoCode": "UY",
    "State": "Montevideo",
    "City": "Montevideo",
    "AddressDetail": "Av. Rivera 1234",
    "PostalCode": "11300"
  }
}

One-Click Recurring Purchases

Some card schemes and issuers allow transactions to be processed without sending a Verification Code (CVV) after the card has been registered. In these cases, the stored CommerceToken can be used for one-click or recurring purchases.

If the issuer requires a Verification Code, the CVV must be requested from the payer during the purchase flow, as it cannot be stored on Bamboo's servers.

To collect the Verification Code, refer to the flow described in the CVV Form.

Get a Customer

Retrieve customer information using the CustomerId, the customer’s email address, or the merchant-defined ExternalCustomerId.

Endpoints

Get by CustomerId

Retrieve a customer using the unique CustomerId.

Get by Email

Retrieve a customer using their email address.

Get by ExternalCustomerId

Retrieve a customer using the merchant-defined ExternalCustomerId.

Response Parameters

The response returns the same Customer object returned by the Create Customer operation.
For the full field definitions, review the _Create Customer_ response or test the endpoint directly in the API Reference.

Delete a Customer

Remove a stored card (payment profile) associated with an existing customer. This operation permanently disables the payment method linked to the provided token.

Endpoint

Production

https://api.bamboopayment.com/v3/api/Customer/customer/PaymentProfile/{token}

Staging

https://api.stage.bamboopayment.com/v3/api/Customer/customer/PaymentProfile/{token}

Path Parameters

Property	Type	Mandatory?	Description
`token`	`string`	Yes	CommerceToken of the payment profile to be deleted.

📘
The value used must be a valid CommerceToken with the format: CT_string

Response

To validate the result, retrieve the customer again using Get Customer and confirm that the payment profile is no longer listed.

Discover the API

Create Customer

Create a new customer profile and store payer information.

Get Customer by ID

Retrieve a customer using the unique CustomerId.

Get Customer by Email

Retrieve a customer using their email address.

Get Customer by External ID

Retrieve a customer using the merchant-defined ExternalCustomerId.

Delete a Customer

Remove a stored payment method associated with a customer.

Create a Purchase

Perform a purchase using a customer’s saved card token.