{"info":{"_postman_id":"1a7570ff-a9a5-4484-be61-7e39fb674a74","name":"API Partnership Program","description":"

Digital Gift Card Issuing Endpoint

In this document you will find all the details for integrating your system with our digital gift card issuing API.

Digital Gift Card

The issuing Digital Gift Card endpoint creates and activates a card using the value send as parameter. It is possible to configute 1 (one) Gift Card per request. You should send your external_id of the object related to your system in order to sync your ID to ours.

E-mail delivery

You can use a flag and we will send the e-mails for you.

In the case of send_emails is true, Todo Cartões will send the e-mail.
- If you set send_emails as true, you should set the e-mail at the object email, using the property to and the custom message at the property message.
\n
In case of the flag send_emails set as false, Todo Cartões will not send the e-mail. You should be responsible to et the data at the response of the request you've sent.

Your identifier

You should send a property called external_partner_load_id. This is the ID of this purchase in your platform. It is very important that you send a unique identifier for every Gift Card generated. The endpoint will not allow.

We will provide you with 2 keys that represent the created (activated) or reloaded Gift Card transaction. These are the fields: transaction_code and transaction_date.

Authentication:

A Bearer Token will be provided by Todo Cartões

Input

With e-mail:

{\n  \"card_identificator\": \"VALEVIRTUALTESTE\",\n  \"store_cnpj\": \"21647164000185\",\n  \"external_partner_load_id\": \"190\",\n  \"total\": 190.11,\n  \"send_email\": true,\n  \"email\": {\n    \"to\": \"test@todocartoes.com.br\",\n    \"custom_fields\": {\n      \"sender_name\": \"Thomás Sieczkowski\",\n      \"receiver_name\": \"Gregório Rados\",\n      \"message\": \"Hello friend. Congratulations for your job promotion :)\"\n    }\n  }\n}\n

Without e-mail:

{\n  \"card_identificator\": \"VALEVIRTUALTESTE\",\n  \"store_cnpj\": \"21647164000185\",\n  \"external_partner_load_id\": \"190\",\n  \"total\": 190.11,\n  \"send_email\": false\n}\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Campo	Tipo	Observações	Obrigatório
card_identificator	String	Identifier of the brand of the Gift Card	SIM
store_cnpj	String	CNPJ of the store that is originating this activation/reload	SIM
external_partner_load_id	Integer	ID on you platform	SIM
total	Decimal	Value to be activated/reloaded into the Gift Card	SIM
email	Chave	Weather to send the e-mails or not	NÃO

Detalhamento da chave de email

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Campo	Tipo	Observações	Obrigatório
to	String	E-mail of the recipient	SIM
from	String	Sender e-mail	SIM
custom_fields	Chave	Dynamic fields within the e-mail	SIM

Saída

{\n  \"response_code\": \"00\",\n  \"response_message\": \"OK. Transações efetuadas\",\n  \"transaction_code\": \"123\",\n  \"transaction_date\": \"2018-11-06\",\n  \"card_number\": \"504161000000000\",\n  \"card_password\": \"835837\",\n  \"expire_date\": \"2019-11-05\",\n  \"external_partner_load_id\": \"190\"\n}\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Campo	Tipo	Observações
card_response_code	String	Status code
card_response_message	String	Status messages
transaction_code	String	Daily sequencial transaction identifier
transaction_date	String	Date of the transaction at our server. You should combine to transaction_code to have a unique ID at your side
card_number	String	Number of the digital gift card generated
card_password	String	Generated 6 digit password
expire_date	Date	Date of expiration of the card
external_partner_load_id	Integer	Your ID

","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Digital Gift Card Issuing Endpoint","slug":"digital-gift-card-issuing-endpoint"}],"owner":"2516022","collectionId":"1a7570ff-a9a5-4484-be61-7e39fb674a74","publishedId":"S1Lr3Amz","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2019-04-29T19:21:49.000Z"},"item":[{"name":"Digital Gift Card Issuing","id":"1a8e7b9a-99d2-48d2-bdce-e10f337e366c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"card_identificator\": \"API - LENTRECOTE DE PARIS\",\n \"store_cnpj\": \"12316059000415\",\n \"external_partner_load_id\": \"190\",\n \"total\": 100.00,\n \"send_email\": true,\n \"email\": {\n \"to\": \"receiversemail@domain.com.br\",\n \"custom_fields\": {\n \"sender_name\": \"José Alves\",\n \"receiver_name\": \"John Lester\",\n \"message\": \"Congratulations on your job promotion!\"\n }\n }\n}"},"url":"https://corporate-sandbox.todocartoes.com.br/api/v1/gift-cards","description":"

This endpoint issues new Digital Gift Cards for our corporate partners.

\n","urlObject":{"protocol":"https","path":["api","v1","gift-cards"],"host":["corporate-sandbox","todocartoes","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"1a8e7b9a-99d2-48d2-bdce-e10f337e366c"},{"name":"Available stores list","id":"4e512c81-a26b-4b13-8a58-0a3753448947","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://corporate-sandbox.todocartoes.com.br/api/v1/brands","description":"

Endpoint de listagem de marcas

Lista todas das lojas disponíveis para criação de gift card coporativos

GET https://corporate-sandobox.todocartoes.com.br/api/v1/brands

Headers

Content-Type application/json

Response

A resposta possui um body contendo as seguintes informações disponíveis em um array brands, para cada marca:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Nome	Tipo	Descrição
brand_name	string	Nome da Marca
min_value	string	Valor mínimo
max_value	string	Valor Máximo
expiration_in_months	int	Validade em meses
card_identificator	string	Identificador do cartão
perform_in	string	Local de utilização
stores	string	Lojas participantes
site	string	Site do lojista
image_thumb	string	Logo do logista Thumb 600x600
image_small	string	Logo do logista Small 100x100
image_default	string	Logo do logista original

","urlObject":{"protocol":"https","path":["api","v1","brands"],"host":["corporate-sandbox","todocartoes","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"4e512c81-a26b-4b13-8a58-0a3753448947"}],"event":[{"listen":"prerequest","script":{"id":"32ae8abb-4aa2-4c63-bad6-e0b8b8814a56","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"72eef2a4-cc53-482a-ae8c-5f71478495b3","type":"text/javascript","exec":[""]}}]}