Customer Operations
API interactions to manage customers (create registration link, retrieve and delete data).
Create Card Registration Link
Generates a link for a customer to register their card.
Request URL
Production: https://h2h.bamboopayment.com/api/v1/customers/account-link
Stage: https://h2h.stage.bamboopayment.com/api/v1/customers/account-link
Method: POST
POSTHeaders
Remember to include the Merchant Private Key in the request headers.
For more details, refer to our Authentication Guide
Body
| Parameter | Type | Required? | Description |
|---|---|---|---|
customer | object | Yes | Customer information to be registered |
accountLinkType | string | Yes | Must be "qr" to indicate a QR registration link |
validForMinutes | integer | No | Validity time for the link (default: 15 minutes) |
Customer Object
| Parameter | Type | Required? | Description |
|---|---|---|---|
customer → identifier | string | No | Unique identifier for the customer (e.g., email) |
customer → Email | string | No | Customer's email address. Prefills the Email field on step 2 (Additional data) |
customer → firstName | string | No | Customer's first name. Prefills First name |
customer → lastName | string | No | Customer's last name. Prefills Last name |
customer → DocumentType | string | No | Document type code, combining document + country (e.g., "DNI.AR"). Prefills Document type |
customer → DocumentNumber | string | No | Customer's document number. Prefills Document number |
customer → phoneNumber | string | No | Customer's phone number, including country code. Prefills Phone |
customer → Address | object | No | Customer's address. See Address Object below |
customer → ExternalCustomerId | string | No | Merchant's own internal customer identifier, used to reference this customer in future transactions |
Address Object
| Parameter | Type | Required? | Description |
|---|---|---|---|
customer → Address → detail | string | No | Street address |
customer → Address → country | string | No | ISO 3166-1 alpha-2 country code. For example: Argentina AR, Uruguay UY. Prefills Country |
customer → Address → state | string | No | State/province. Prefills State |
customer → Address → city | string | No | City. Prefills City |
customer → Address → postalCode | string | No | Postal/ZIP code. Prefills Postal code |
Example Request
{
"customer": {
"identifier": "[email protected]",
"email": "[email protected]",
"firstName": "Juan",
"lastName": "Pérez",
"documentTypeId": 2,
"documentNumber": "11211234",
"phoneNumber": "27101234",
"BillingAddress": {
"detail": "Rambla 1234",
"country": "UY",
"state": "Montevideo",
"city": "Montevideo",
"postalCode": "11300"
}
},
"accountLinkType": "qr"
}Example Response
{
"customerId": "7c35b44a-844e-40f1-84bd-004404f6bd98",
"redirectUrl": "https://checkout.stage.bamboopayment.com/#?customerId=7c35b44a-844e-40f1-84bd-004404f6bd98",
"validForMinutes": 15,
"isSuccess": true
}Retrieve Customer Data
Fetches the data of a previously registered customer.
Request URL
`GET /customers/{CustomerIdentifier}`Headers
Remember to include the Merchant Private Key in the request headers.
For more details, refer to our Authentication Guide
Example Request
GET https://h2h.stage.bamboopayment.com/api/v1/customers/juan.perez%40gmail.comExample Response
{
"customer": {
"identifier": "[email protected]",
"email": "[email protected]",
"firstName": "Juan",
"lastName": "Pérez",
"documentTypeId": 2,
"documentNumber": "11211234",
"phoneNumber": "27101234",
"billingAddress": {
"detail": "Rambla 1234",
"country": "Uruguay",
"state": "Montevideo",
"city": "Montevideo",
"postalCode": "11300"
}
},
"isSuccess": true
}Delete Customer Data
Deletes all information associated with a customer.
Request URL
`DELETE /customers/{CustomerIdentifier}`Headers
Remember to include the Merchant Private Key in the request headers.
For more details, refer to our Authentication Guide
Example Request
DELETE https://h2h.stage.bamboopayment.com/api/v1/customers/juan.perez%40gmail.comExample Response
{
"isSuccess": true
}Updated 3 months ago