Store Card in Vault

POST/dpm/cofre-gw-proxy/v1/cards

__Store Card in Vault__ This endpoint securely stores a consumer’s card information in Getnet’s digital vault for future use. It allows the creation of a reusable card resource based on previously tokenized data, enabling seamless and secure transactions without requiring the card details again. **Usage Scenarios:** _- Tokenizing and saving card data for future payments. - Enabling subscriptions or billing cycles without re-entering card information. - Minimizing PCI scope by leveraging secure storage of sensitive data._ **Notes:** _- This operation accepts either an open card number_ (`number`) _or a previously generated tokenized card number_ (`number_token`)_, typically obtained via the_ **/v1/tokens/card** _endpoint. -The card data is stored securely, and sensitive fields like CVV are **never stored**. - You may optionally skip card verification by using the_ `x-by-pass-parameters` _header._

Header Parameters

x-by-pass-parametersboolean

Condition to not validate whether the product vault is enabled parameters.

Body application/json

numberstring

Open card number (PAN). Send `number` or `number_token`. Use `number` to store the card directly.

number_tokenstring

Tokenized card number, generated via the /v1/tokens/card endpoint. Send `number_token` or `number`.

brand"Mastercard" | "Visa" | "Amex" | "Elo" | "Hipercard"

Card Brand.

cardholder_namestring

Buyer's name printed on the card.

expiration_monthstringrequired

Two-digit card expiration month.

expiration_yearstringrequired

Two-digit card expiration year.

customer_idstringrequired

Buyer identifier.

cardholder_identificationstring

Identification of the buyer, such as CPF or ID. (without mask).

verify_cardtrue | false

Performs a transaction that verifies that the card entered does not is cancelled, blocked or restricted.

security_codestring

Security code. CVV or CVC.

transaction_idstring

Number of the card's first transaction.

Response

Card identifier created successfully. Card saved in safe.

card_idstring

Card identifier saved in the safe, can be used to retrieve a valid number_token for future purchases, as well as can be used to remove saved cards.

number_tokenstring

Card token that will be used in transactions.

Invalid request.

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.

Invalid authentication.

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.

Safe product not enabled.

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.

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.

curl -X POST "https://api.pre.globalgetnet.com/dpm/cofre-gw-proxy/v1/cards" \ -H "Content-Type: application/json" \ -H "x-by-pass-parameters: <x-by-pass-parameters>" \ -d '{ "number": "5155901222280001", "number_token": "dfe05208b105578c070f806c80abd3af09e246827d29b866cf4ce16c205849977c9496cbf0d0234f42339937f327747075f68763537b90b31389e01231d4d13c", "brand": "Mastercard", "cardholder_name": "JOAO DA SILVA", "expiration_month": "12", "expiration_year": "28", "customer_id": "customer_21081826", "cardholder_identification": "12345678912", "verify_card": false, "security_code": "123", "transaction_id": "3123131241412" }'

const response = await fetch(`https://api.pre.globalgetnet.com/dpm/cofre-gw-proxy/v1/cards`, { method: 'POST', headers: { 'Content-Type': 'application/json' }, body: JSON.stringify({ "number": "5155901222280001", "number_token": "dfe05208b105578c070f806c80abd3af09e246827d29b866cf4ce16c205849977c9496cbf0d0234f42339937f327747075f68763537b90b31389e01231d4d13c", "brand": "Mastercard", "cardholder_name": "JOAO DA SILVA", "expiration_month": "12", "expiration_year": "28", "customer_id": "customer_21081826", "cardholder_identification": "12345678912", "verify_card": false, "security_code": "123", "transaction_id": "3123131241412" }) }); const data = await response.json();

import requests response = requests.request( "POST", "https://api.pre.globalgetnet.com/dpm/cofre-gw-proxy/v1/cards", json={ "number": "5155901222280001", "number_token": "dfe05208b105578c070f806c80abd3af09e246827d29b866cf4ce16c205849977c9496cbf0d0234f42339937f327747075f68763537b90b31389e01231d4d13c", "brand": "Mastercard", "cardholder_name": "JOAO DA SILVA", "expiration_month": "12", "expiration_year": "28", "customer_id": "customer_21081826", "cardholder_identification": "12345678912", "verify_card": False, "security_code": "123", "transaction_id": "3123131241412" }, ) data = response.json()

<?php $ch = curl_init(); curl_setopt($ch, CURLOPT_URL, "https://api.pre.globalgetnet.com/dpm/cofre-gw-proxy/v1/cards"); curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST"); curl_setopt($ch, CURLOPT_HTTPHEADER, ["Content-Type: application/json"]); curl_setopt($ch, CURLOPT_POSTFIELDS, '{ "number": "5155901222280001", "number_token": "dfe05208b105578c070f806c80abd3af09e246827d29b866cf4ce16c205849977c9496cbf0d0234f42339937f327747075f68763537b90b31389e01231d4d13c", "brand": "Mastercard", "cardholder_name": "JOAO DA SILVA", "expiration_month": "12", "expiration_year": "28", "customer_id": "customer_21081826", "cardholder_identification": "12345678912", "verify_card": false, "security_code": "123", "transaction_id": "3123131241412" }'); $response = curl_exec($ch); curl_close($ch);

package main import ( "fmt" "io" "net/http" "strings" ) func main() { req, _ := http.NewRequest("POST", "https://api.pre.globalgetnet.com/dpm/cofre-gw-proxy/v1/cards", strings.NewReader(`{ "number": "5155901222280001", "number_token": "dfe05208b105578c070f806c80abd3af09e246827d29b866cf4ce16c205849977c9496cbf0d0234f42339937f327747075f68763537b90b31389e01231d4d13c", "brand": "Mastercard", "cardholder_name": "JOAO DA SILVA", "expiration_month": "12", "expiration_year": "28", "customer_id": "customer_21081826", "cardholder_identification": "12345678912", "verify_card": false, "security_code": "123", "transaction_id": "3123131241412" }`)) req.Header.Set("Content-Type", "application/json") resp, err := http.DefaultClient.Do(req) if err != nil { panic(err) } defer resp.Body.Close() data, _ := io.ReadAll(resp.Body) fmt.Println(string(data)) }

HttpClient client = HttpClient.newHttpClient(); HttpRequest request = HttpRequest.newBuilder() .uri(URI.create("https://api.pre.globalgetnet.com/dpm/cofre-gw-proxy/v1/cards")) .header("Content-Type", "application/json") .method("POST", HttpRequest.BodyPublishers.ofString("{\n \"number\": \"5155901222280001\",\n \"number_token\": \"dfe05208b105578c070f806c80abd3af09e246827d29b866cf4ce16c205849977c9496cbf0d0234f42339937f327747075f68763537b90b31389e01231d4d13c\",\n \"brand\": \"Mastercard\",\n \"cardholder_name\": \"JOAO DA SILVA\",\n \"expiration_month\": \"12\",\n \"expiration_year\": \"28\",\n \"customer_id\": \"customer_21081826\",\n \"cardholder_identification\": \"12345678912\",\n \"verify_card\": false,\n \"security_code\": \"123\",\n \"transaction_id\": \"3123131241412\"\n}")) .build(); HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString()); System.out.println(response.body());

require "net/http" require "uri" uri = URI("https://api.pre.globalgetnet.com/dpm/cofre-gw-proxy/v1/cards") http = Net::HTTP.new(uri.host, uri.port) http.use_ssl = uri.scheme == "https" request = Net::HTTP::Post.new(uri) request["Content-Type"] = "application/json" request.body = "{\n \"number\": \"5155901222280001\",\n \"number_token\": \"dfe05208b105578c070f806c80abd3af09e246827d29b866cf4ce16c205849977c9496cbf0d0234f42339937f327747075f68763537b90b31389e01231d4d13c\",\n \"brand\": \"Mastercard\",\n \"cardholder_name\": \"JOAO DA SILVA\",\n \"expiration_month\": \"12\",\n \"expiration_year\": \"28\",\n \"customer_id\": \"customer_21081826\",\n \"cardholder_identification\": \"12345678912\",\n \"verify_card\": false,\n \"security_code\": \"123\",\n \"transaction_id\": \"3123131241412\"\n}" response = http.request(request) puts response.body

{ "card_id": "e8ad2ae4-9e3e-4532-998f-1a5a11e56e58", "number_token": "dfe05208b105578c070f806c80abd3af09e246827d29b866cf4ce16c205849977c9496cbf0d0234f42339937f327747075f68763537b90b31389e01231d4d13c" }

{ "message": "string", "name": "string", "status_code": 0, "details": [ { "status": "string", "error_code": "string", "description": "string", "description_detail": "string", "brand": "string", "payment_id": "string", "seller_id": "string", "amount": "string", "currency": "string", "order_id": "string", "credit_cancel": { "canceled_at": "string", "message": "string" }, "payment_tag": "string", "status_code": "string", "message": "string", "name": "string", "acquirer_transaction_id": "string", "authorization_code": "string", "transaction_id": "string", "reason_code": "string", "reason_message": "string", "merchant_advice_code": "string" } ], "payments": [ { "status": "string", "error_code": "string", "description": "string", "description_detail": "string", "brand": "string", "payment_id": "string", "seller_id": "string", "amount": "string", "currency": "string", "order_id": "string", "credit_cancel": { "canceled_at": "string", "message": "string" }, "payment_tag": "string", "status_code": "string", "message": "string", "name": "string", "acquirer_transaction_id": "string", "authorization_code": "string", "transaction_id": "string", "reason_code": "string", "reason_message": "string", "merchant_advice_code": "string" } ], "combined_id": "string", "order_id": "string", "seller_id": "string" }