Getnet DocsGetnet Docs

Create Customer

POST/rpy/be-customer/v1/customers

__Request Installment Quotes__<br><br>This endpoint allows you to create a new customer profile within the Getnet platform. It is primarily used for recurrence scenarios, enabling the association of customer data with future payments such as subscriptions, recurring charges, or tokenized transactions.<br><br>**Usage Scenarios:**<br>_- Associating customer profiles with saved cards or tokenized payments.<br>- Enabling customer-specific metadata and preferences for personalization and tracking._<br><br>**Notes:**<br>_- The_ `seller_id` _and_ `customer_id` _fields are required to uniquely identify the platform and the buyer.<br>- Detailed personal information is collected including name, document type and number, birth date, and contact info.<br>-The document_type supports various formats depending on the country (e.g.,_ `CPF`, `CNPJ`, `DNI_AR`, `CI_CL`_, etc.).<br>-Phone numbers should be provided without mask or formatting.<br>-An address block can be added optionally for billing or verification purposes.<br>-Proper validation of document formats and lengths is essential for successful registration._

Body application/json

seller_idstring<uuid>required

ECommerce identification code

customer_idstring

Buyer identifier used by e-commerce. Case be informed it will be passed on in the PIX Payment Notification.

first_namestringrequired

Buyer's first name.

last_namestringrequired

Buyer's last name.

document_type"CPF" | "CNPJ" | "DNI_AR" | "CUIL" | "CUIT" | "RUT" | "CI_CL" | "MX_CURP" | "MX_RFC"required

Buyer's document type.

document_numberstringrequired

Buyer's document number. (without mask)

birth_datestring<YYYY-MM-DD>

Buyer's date of birth.

phone_numberstring

Buyer's phone number. (without mask)

cellphone_numberstring

Buyer's cell phone number. (without mask)

emailstring<email>

Buyer's email.

observationstring

Notes.

addressany

Set of data referring to the buyer's address

Response

OK

first_namestring

Buyer's first name.</br><b><i>Required field for <a href="https://developers.getnet.com.br/api#section/Antifraude/Dados-obrigatorios-para-analise- do-Antifraud">Antifraud</a></i></b>

last_namestring

Buyer's last name.</br><b><i>Required field for <a href="https://developers.getnet.com.br/api#section/Antifraude/Dados-obrigatorios-para- anti-fraud analysis">Anti-fraud</a></i></b>

namestring

Buyer's full name. Required for ticket.

document_type"CPF" | "CNPJ"

Type of the buyer's identification document. Mandatory for boleto.</br><br>Seed document types <a href="https://docs.globalgetnet.com/es/articles/document-types">here.</a><br><br><b><i>Mandatory field for <a href="https://developers.getnet.com.br/api#section/Antifraude/Dados-obrigatorios-para-analise-do -Antifraud">Antifraud</a></i></b>

document_numberstring

Purchaser's document number without punctuation. (without mask)</br><b><i>Required field for <a href="https://developers.getnet.com.br/api#section/Antifraude/Dados-obrigatorios-para-analise-do -Antifraud">Antifraud</a></i></b>

emailstring<email>

Buyer's email.</br><b><i>Required field for <a href="https://developers.getnet.com.br/api#section/Antifraude/Dados-obrigatorios-para-analise -do-Antifraud">Antifraud</a></i></b>

phone_numberstring

Buyer's phone. (without mask)</br><b><i>Required field for <a href="https://developers.getnet.com.br/api#section/Antifraude/Dados-obrigatorios-para-analise-do -Antifraud">Antifraud</a></i></b>

billing_addressany

Set of data referring to the buyer's address

Invalid Requisition

messagestring

Detailed error message.

namestring

Name of the module or system in which the error occurred.

status_codeinteger<int32>

HTTP status code of the error.

detailsobject[]

Error details.

Show details properties
statusstring

Error situation.

error_codestring

Error code.

descriptionstring

Description of the error.

description_detailstring

Detailed description of the error.

brandstring

Brand.

payment_idstring

payment_id.

seller_idstring

seller_id.

amountstring

amount.

currencystring

currency.

order_idstring

order_id.

credit_cancelobject

credit_cancel.

Show credit_cancel properties
canceled_atstring

canceledAt.

messagestring

message.

payment_tagstring

payment_tag.

status_codestring

statusCode.

messagestring

message.

namestring

name.

acquirer_transaction_idstring

acquirer_transaction_id.

authorization_codestring

authorization_code.

transaction_idstring

transaction_id.

reason_codestring

reason_code.

reason_messagestring

reason_message.

merchant_advice_codestring

merchant_advice_code.

paymentsobject[]

Error details.

Show payments properties
statusstring

Error situation.

error_codestring

Error code.

descriptionstring

Description of the error.

description_detailstring

Detailed description of the error.

brandstring

Brand.

payment_idstring

payment_id.

seller_idstring

seller_id.

amountstring

amount.

currencystring

currency.

order_idstring

order_id.

credit_cancelobject

credit_cancel.

Show credit_cancel properties
canceled_atstring

canceledAt.

messagestring

message.

payment_tagstring

payment_tag.

status_codestring

statusCode.

messagestring

message.

namestring

name.

acquirer_transaction_idstring

acquirer_transaction_id.

authorization_codestring

authorization_code.

transaction_idstring

transaction_id.

reason_codestring

reason_code.

reason_messagestring

reason_message.

merchant_advice_codestring

merchant_advice_code.

combined_idstring

combinedId.

order_idstring

orderId.

seller_idstring

sellerId.

Not Found

messagestring

Detailed error message.

namestring

Name of the module or system in which the error occurred.

status_codeinteger<int32>

HTTP status code of the error.

detailsobject[]

Error details.

Show details properties
statusstring

Error situation.

error_codestring

Error code.

descriptionstring

Description of the error.

description_detailstring

Detailed description of the error.

brandstring

Brand.

payment_idstring

payment_id.

seller_idstring

seller_id.

amountstring

amount.

currencystring

currency.

order_idstring

order_id.

credit_cancelobject

credit_cancel.

Show credit_cancel properties
canceled_atstring

canceledAt.

messagestring

message.

payment_tagstring

payment_tag.

status_codestring

statusCode.

messagestring

message.

namestring

name.

acquirer_transaction_idstring

acquirer_transaction_id.

authorization_codestring

authorization_code.

transaction_idstring

transaction_id.

reason_codestring

reason_code.

reason_messagestring

reason_message.

merchant_advice_codestring

merchant_advice_code.

paymentsobject[]

Error details.

Show payments properties
statusstring

Error situation.

error_codestring

Error code.

descriptionstring

Description of the error.

description_detailstring

Detailed description of the error.

brandstring

Brand.

payment_idstring

payment_id.

seller_idstring

seller_id.

amountstring

amount.

currencystring

currency.

order_idstring

order_id.

credit_cancelobject

credit_cancel.

Show credit_cancel properties
canceled_atstring

canceledAt.

messagestring

message.

payment_tagstring

payment_tag.

status_codestring

statusCode.

messagestring

message.

namestring

name.

acquirer_transaction_idstring

acquirer_transaction_id.

authorization_codestring

authorization_code.

transaction_idstring

transaction_id.

reason_codestring

reason_code.

reason_messagestring

reason_message.

merchant_advice_codestring

merchant_advice_code.

combined_idstring

combinedId.

order_idstring

orderId.

seller_idstring

sellerId.

Unprocessable Entity

messagestring

Detailed error message.

namestring

Name of the module or system in which the error occurred.

status_codeinteger<int32>

HTTP status code of the error.

detailsobject[]

Error details.

Show details properties
statusstring

Error situation.

error_codestring

Error code.

descriptionstring

Description of the error.

description_detailstring

Detailed description of the error.

brandstring

Brand.

payment_idstring

payment_id.

seller_idstring

seller_id.

amountstring

amount.

currencystring

currency.

order_idstring

order_id.

credit_cancelobject

credit_cancel.

Show credit_cancel properties
canceled_atstring

canceledAt.

messagestring

message.

payment_tagstring

payment_tag.

status_codestring

statusCode.

messagestring

message.

namestring

name.

acquirer_transaction_idstring

acquirer_transaction_id.

authorization_codestring

authorization_code.

transaction_idstring

transaction_id.

reason_codestring

reason_code.

reason_messagestring

reason_message.

merchant_advice_codestring

merchant_advice_code.

paymentsobject[]

Error details.

Show payments properties
statusstring

Error situation.

error_codestring

Error code.

descriptionstring

Description of the error.

description_detailstring

Detailed description of the error.

brandstring

Brand.

payment_idstring

payment_id.

seller_idstring

seller_id.

amountstring

amount.

currencystring

currency.

order_idstring

order_id.

credit_cancelobject

credit_cancel.

Show credit_cancel properties
canceled_atstring

canceledAt.

messagestring

message.

payment_tagstring

payment_tag.

status_codestring

statusCode.

messagestring

message.

namestring

name.

acquirer_transaction_idstring

acquirer_transaction_id.

authorization_codestring

authorization_code.

transaction_idstring

transaction_id.

reason_codestring

reason_code.

reason_messagestring

reason_message.

merchant_advice_codestring

merchant_advice_code.

combined_idstring

combinedId.

order_idstring

orderId.

seller_idstring

sellerId.

Internal server or service error

messagestring

Detailed error message.

namestring

Name of the module or system in which the error occurred.

status_codeinteger<int32>

HTTP status code of the error.

detailsobject[]

Error details.

Show details properties
statusstring

Error situation.

error_codestring

Error code.

descriptionstring

Description of the error.

description_detailstring

Detailed description of the error.

brandstring

Brand.

payment_idstring

payment_id.

seller_idstring

seller_id.

amountstring

amount.

currencystring

currency.

order_idstring

order_id.

credit_cancelobject

credit_cancel.

Show credit_cancel properties
canceled_atstring

canceledAt.

messagestring

message.

payment_tagstring

payment_tag.

status_codestring

statusCode.

messagestring

message.

namestring

name.

acquirer_transaction_idstring

acquirer_transaction_id.

authorization_codestring

authorization_code.

transaction_idstring

transaction_id.

reason_codestring

reason_code.

reason_messagestring

reason_message.

merchant_advice_codestring

merchant_advice_code.

paymentsobject[]

Error details.

Show payments properties
statusstring

Error situation.

error_codestring

Error code.

descriptionstring

Description of the error.

description_detailstring

Detailed description of the error.

brandstring

Brand.

payment_idstring

payment_id.

seller_idstring

seller_id.

amountstring

amount.

currencystring

currency.

order_idstring

order_id.

credit_cancelobject

credit_cancel.

Show credit_cancel properties
canceled_atstring

canceledAt.

messagestring

message.

payment_tagstring

payment_tag.

status_codestring

statusCode.

messagestring

message.

namestring

name.

acquirer_transaction_idstring

acquirer_transaction_id.

authorization_codestring

authorization_code.

transaction_idstring

transaction_id.

reason_codestring

reason_code.

reason_messagestring

reason_message.

merchant_advice_codestring

merchant_advice_code.

combined_idstring

combinedId.

order_idstring

orderId.

seller_idstring

sellerId.

Bad Gateway

messagestring

Detailed error message.

namestring

Name of the module or system in which the error occurred.

status_codeinteger<int32>

HTTP status code of the error.

detailsobject[]

Error details.

Show details properties
statusstring

Error situation.

error_codestring

Error code.

descriptionstring

Description of the error.

description_detailstring

Detailed description of the error.

brandstring

Brand.

payment_idstring

payment_id.

seller_idstring

seller_id.

amountstring

amount.

currencystring

currency.

order_idstring

order_id.

credit_cancelobject

credit_cancel.

Show credit_cancel properties
canceled_atstring

canceledAt.

messagestring

message.

payment_tagstring

payment_tag.

status_codestring

statusCode.

messagestring

message.

namestring

name.

acquirer_transaction_idstring

acquirer_transaction_id.

authorization_codestring

authorization_code.

transaction_idstring

transaction_id.

reason_codestring

reason_code.

reason_messagestring

reason_message.

merchant_advice_codestring

merchant_advice_code.

paymentsobject[]

Error details.

Show payments properties
statusstring

Error situation.

error_codestring

Error code.

descriptionstring

Description of the error.

description_detailstring

Detailed description of the error.

brandstring

Brand.

payment_idstring

payment_id.

seller_idstring

seller_id.

amountstring

amount.

currencystring

currency.

order_idstring

order_id.

credit_cancelobject

credit_cancel.

Show credit_cancel properties
canceled_atstring

canceledAt.

messagestring

message.

payment_tagstring

payment_tag.

status_codestring

statusCode.

messagestring

message.

namestring

name.

acquirer_transaction_idstring

acquirer_transaction_id.

authorization_codestring

authorization_code.

transaction_idstring

transaction_id.

reason_codestring

reason_code.

reason_messagestring

reason_message.

merchant_advice_codestring

merchant_advice_code.

combined_idstring

combinedId.

order_idstring

orderId.

seller_idstring

sellerId.

Gateway Timeout

messagestring

Detailed error message.

namestring

Name of the module or system in which the error occurred.

status_codeinteger<int32>

HTTP status code of the error.

detailsobject[]

Error details.

Show details properties
statusstring

Error situation.

error_codestring

Error code.

descriptionstring

Description of the error.

description_detailstring

Detailed description of the error.

brandstring

Brand.

payment_idstring

payment_id.

seller_idstring

seller_id.

amountstring

amount.

currencystring

currency.

order_idstring

order_id.

credit_cancelobject

credit_cancel.

Show credit_cancel properties
canceled_atstring

canceledAt.

messagestring

message.

payment_tagstring

payment_tag.

status_codestring

statusCode.

messagestring

message.

namestring

name.

acquirer_transaction_idstring

acquirer_transaction_id.

authorization_codestring

authorization_code.

transaction_idstring

transaction_id.

reason_codestring

reason_code.

reason_messagestring

reason_message.

merchant_advice_codestring

merchant_advice_code.

paymentsobject[]

Error details.

Show payments properties
statusstring

Error situation.

error_codestring

Error code.

descriptionstring

Description of the error.

description_detailstring

Detailed description of the error.

brandstring

Brand.

payment_idstring

payment_id.

seller_idstring

seller_id.

amountstring

amount.

currencystring

currency.

order_idstring

order_id.

credit_cancelobject

credit_cancel.

Show credit_cancel properties
canceled_atstring

canceledAt.

messagestring

message.

payment_tagstring

payment_tag.

status_codestring

statusCode.

messagestring

message.

namestring

name.

acquirer_transaction_idstring

acquirer_transaction_id.

authorization_codestring

authorization_code.

transaction_idstring

transaction_id.

reason_codestring

reason_code.

reason_messagestring

reason_message.

merchant_advice_codestring

merchant_advice_code.

combined_idstring

combinedId.

order_idstring

orderId.

seller_idstring

sellerId.

Request
curl -X POST "https://api.pre.globalgetnet.com/rpy/be-customer/v1/customers" \
  -H "Content-Type: application/json" \
  -d '{
  "seller_id": "9406df6c-3100-49ba-b4df-d81c1ad8a62b",
  "customer_id": "string",
  "first_name": "John",
  "last_name": "da Silva",
  "document_type": "CPF",
  "document_number": "12345678912",
  "birth_date": "1976-02-21",
  "phone_number": "5551999887766",
  "cellphone_number": "5551999887766",
  "email": "[email protected]",
  "observation": "The customer is interested in plan x.",
  "address": {
    "street": "Av. Brazil",
    "number": "1000",
    "complement": "Sala 1",
    "district": "Sao Geraldo",
    "city": "Porto Alegre",
    "state": "RS",
    "country": "Brazil",
    "postal_code": "90230060"
  }
}'
Response
{
  "first_name": "John",
  "last_name": "da Silva",
  "name": "João da Silva",
  "document_type": "CPF",
  "document_number": "12345678912",
  "email": "[email protected]",
  "phone_number": "5551999887766",
  "billing_address": {
    "street": "Av. Brazil",
    "number": "1000",
    "complement": "Sala 1",
    "district": "Sao Geraldo",
    "city": "Porto Alegre",
    "state": "RS",
    "country": "Brazil",
    "postal_code": "90230060"
  }
}