Tarjetas

A API de Cartões contém todos os endpoints necessários para criar cartões nominados e innominados, ativá-los, fazer buscas, obter as informações de um cartão em particular e mais.

Criar Cartão

O endpoint /cards/v1/ permite criar um novo cartão nomeado que pode ser físico ou virtual.

Validaremos que você atenda aos requisitos que detalhamos na documentação.

Parâmetros disponíveis
Header Parameters
Authorizationstringrequired
Exemplo: Bearer {access_token}
x-idempotency-keystringrequired
ID único em cada solicitação para usar nosso esquema de idempotência.
Exemplo: fRwX12Dg3345AD
Body Parameters
user_idstringrequired
Exemplo: usr-5BERfwA0nyGFI4Wn8a5y3yv3IGW
affinity_group_idstringrequired
Exemplo: afg-20MpN8vmIPj77ujhb9cS8ctstN2
card_typestringrequired
Exemplo: PHYSICAL
addressobject
companystring(maxLength: 30)
Exemplo: Pomelo
previous_card_idstring
Se você enviar este atributo, trataremos o novo cartão como um substituto deste.
Exemplo: crd-20gRqyp809SvDzXzhSeG2w6UiO5
parent_idstring
ID do cartão pai.
Exemplo: crd-20gRqyp809SvDzXzhSeG2w6UiO5
pinstring
Exemplo: 2023
name_on_cardstring(maxLength: 19)
Se você enviar este atributo, é o nome que irá no cartão em vez do nome e sobrenome do usuário. [Somente disponível para Idemia, na Colômbia e no Peru]
Pattern: ^[A-Za-zÀ-ÿ ]+$
Exemplo: Dieguito
Detalhe de respostas
dataobject

Esta seção foi útil para você?

POST/cards/v1/
{
"user_id":
"usr-5BERfwA0nyGFI4Wn8a5y3yv3IGW"
"affinity_group_id":
"afg-20MpN8vmIPj77ujhb9cS8ctstN2"
"card_type":
"PHYSICAL"
"address":{
"street_name":
"Street"
"street_number":
"123"
"floor":
"5"
"apartment":
"A"
"city":
"Buenos Aires"
"region":
"Buenos Aires"
"country":
"Argentina"
"zip_code":
"5653"
"neighborhood":
"Palermo"
"additional_info":
"Torre 2. Casa amarilla"
}
"company":
"Pomelo"
"previous_card_id":
"crd-20gRqyp809SvDzXzhSeG2w6UiO5"
"parent_id":
"crd-20gRqyp809SvDzXzhSeG2w6UiO5"
"pin":
"2023"
"name_on_card":
"Dieguito"
}
Respostas de amostra
{
"data":{
"id":
"crd-20gRqyp809SvDzXzhSeG2w6UiO5"
"affinity_group_id":
"afg-20MpN8vmIPj77ujhb9cS8ctstN2"
"card_type":
"VIRTUAL"
"product_type":
"PREPAID"
"status":
"ACTIVE"
"status_detail":
"CLIENT_INTERNAL_REASON"
"shipment_id":
"shi-2VOLbX1fAeWAn1rABlorxBqRyGF"
"user_id":
"usr-5BERfwA0nyGFI4Wn8a5y3yv3IGW"
"start_date":
"2021-11-08"
"last_four":
"1573"
"provider":
"MASTERCARD"
"affinity_group_name":
"VIRTUAL_TEST"
"company":
"Pomelo"
"name_on_card":
"Dieguito"
"parent_id":
"crd-20gRqyp809SvDzXzhSeG2w6UiO5"
}
}

Buscar Cartões

O endpoint /cards/v1/ permite buscar um grupo de cartões de acordo com os atributos que você especificar.

Você poderá filtrar e ordenar os cartões seguindo esta documentação.

Os atributos para ordenar são:

  • card_type
  • user_id
  • status
  • affinity_group_id
  • status_detail
  • shipment_id
  • innominate
  • start_date.
Parâmetros disponíveis
Header Parameters
Authorizationstringrequired
Exemplo: Bearer {access_token}
Query Parameters
filter[card_type]string
Enum: VIRTUALPHYSICAL
filter[id]string
filter[user_id]string
filter[status]string
filter[status_detail]string
Enum: CLIENT_INTERNAL_REASONUSER_INTERNAL_REASONPOMELO_INTERNAL_REASONPROVIDER_INTERNAL_REASONLOSTSTOLENBROKENUPGRADE
filter[affinity_group_id]string
filter[shipment_id]string
filter[innominate]boolean
filter[product_type]string
Enum: PREPAIDCREDITDEBIT
filter[product_provider]string
Enum: MASTERCARDVISA
filter[country_code]string
ISO 3166-1 alpha-3
page[size]number
Tamanho da página.
page[number]number
Número da página. O número da primeira página é 0.
sortstring
Exemplo: status,-card_type
Detalhe de respostas
dataarray
metaobject

Esta seção foi útil para você?

GET/cards/v1/
Respostas de amostra
{
"data":[
0:{
...
}
]
"meta":{
"pagination":{
...
}
"filter":[
...
]
}
}

Obter Cartão.

O endpoint /cards/v1/{id} permite que você obtenha informações sobre um cartão em particular.

Considerações

  • Se você contratou CVV dinâmico, verá o campo cvv_expiration_time que determina a validade do novo código. Saiba mais sobre CVV dinâmico.

⚠️ Acesso a dados sensíveis por meio do parâmetro extend

Esta funcionalidade permite acessar dados sensíveis de cartão como o número completo (PAN), código de segurança (CVV), nome do titular e data de expiração.

Por requerimento do padrão PCI DSS, você só poderá usar esta funcionalidade se:

  • Contas com certificação PCI DSS vigente que contemple o tratamento e armazenamento de dados de cartão.
  • Você nos envia por e-mail sua Attestation of Compliance (AOC) como prova formal do cumprimento.

Se você não cumprir esses requisitos, poderá utilizar nossa Web de dados seguros.

Parâmetros disponíveis
Header Parameters
Authorizationstringrequired
Exemplo: Bearer {access_token}
Query Parameters
extendstring
Permite obter informações adicionais como o pan e cvc, que não estão incluídos por padrão na resposta.
Enum: pancvvpinnameexpiration_date
Path Parameters
idstringrequired
ID público do cartão.
Detalhe de respostas
dataobject
metaobject

Esta seção foi útil para você?

GET/cards/v1/{id}
Respostas de amostra
{
"data":{
"id":
"crd-20gRqyp809SvDzXzhSeG2w6UiO5"
"affinity_group_id":
"afg-20MpN8vmIPj77ujhb9cS8ctstN2"
"card_type":
"VIRTUAL"
"product_type":
"PREPAID"
"status":
"ACTIVE"
"status_detail":
"CLIENT_INTERNAL_REASON"
"shipment_id":
"shi-2VOLbX1fAeWAn1rABlorxBqRyGF"
"user_id":
"usr-5BERfwA0nyGFI4Wn8a5y3yv3IGW"
"start_date":
"2021-11-08"
"last_four":
"1573"
"provider":
"MASTERCARD"
"affinity_group_name":
"VIRTUAL_TEST"
"company":
"Pomelo"
"name_on_card":
"Dieguito"
"parent_id":
"crd-20gRqyp809SvDzXzhSeG2w6UiO5"
"activated_at":
"2021-11-18"
}
"meta":{
"extend":[
...
]
}
}

Atualizar Cartão

O endpoint /cards/v1/{id} permite atualizar o status de um cartão, seu grupo de afinidade e o PIN.

Considerações

Você deve especificar uma razão da seguinte lista para poder atualizar o estado de um cartão:

Novo estado.Razão válida
BLOCKED / DISABLEDCLIENT_INTERNAL_REASON
BLOCKED / DISABLEDUSER_INTERNAL_REASON
DISABLEDLOST
DISABLEDSTOLEN
DISABLEDBROKEN
DISABLEDUPGRADE
Parâmetros disponíveis
Header Parameters
Authorizationstringrequired
Exemplo: Bearer {access_token}
Body Parameters
affinity_group_idstring
Exemplo: afg-20MpN8vmIPj77ujhb9cS8ctstN2
statusstring
Enum: ACTIVEBLOCKEDDISABLED
status_reasonstring
Enum: CLIENT_INTERNAL_REASONUSER_INTERNAL_REASONPOMELO_INTERNAL_REASONPROVIDER_INTERNAL_REASONLOSTSTOLENBROKENUPGRADE
pinstring
Exemplo: 1234
parent_idstring
ID do cartão pai.
Exemplo: crd-20gRqyp809SvDzXzhSeG2w6UiO5
Path Parameters
idstringrequired
ID público do cartão.
Detalhe de respostas
dataobject

Esta seção foi útil para você?

PATCH/cards/v1/{id}
{
"affinity_group_id":
"afg-20MpN8vmIPj77ujhb9cS8ctstN2"
"status":
"ACTIVE"
"status_reason":
"CLIENT_INTERNAL_REASON"
"pin":
"1234"
"parent_id":
"crd-20gRqyp809SvDzXzhSeG2w6UiO5"
}
Respostas de amostra
{
"data":{
"affinity_group_id":
"afg-20MpN8vmIPj77ujhb9cS8ctstN2"
"status":
"ACTIVE"
"status_reason":
"CLIENT_INTERNAL_REASON"
"pin":
"1234"
"parent_id":
"crd-20gRqyp809SvDzXzhSeG2w6UiO5"
}
}

Criar Multi-Cartão

Criar um multi-cartão que permite associar dois bines em um mesmo cartão físico.
Parâmetros disponíveis
Header Parameters
Authorizationstringrequired
Exemplo: Bearer {access_token}
x-idempotency-keystringrequired
ID único em cada solicitação para usar nosso esquema de idempotência.
Exemplo: fRwX12Dg3345AD
Body Parameters
user_idstringrequired
Exemplo: usr-5BERfwA0nyGFI4Wn8a5y3yv3IGW
affinity_group_idstringrequired
Exemplo: afg-20MpN8vmIPj77ujhb9cS8ctstN2
secondary_affinity_group_idstringrequired
Exemplo: afg-21MpN8vmIPj77ujhb9cS8ctstN3
card_typestringrequired
Exemplo: PHYSICAL
addressobject
companystring(maxLength: 30)
Exemplo: Pomelo
name_on_cardstring(maxLength: 19)
Se você enviar este atributo, é o nome que irá no cartão em vez do nome e sobrenome do usuário. [Somente disponível para Idemia, na Colômbia e no Peru]
Pattern: ^[A-Za-zÀ-ÿ ]+$
Exemplo: Dieguito
Detalhe de respostas
dataarray

Esta seção foi útil para você?

POST/cards/v1/multicard
{
"user_id":
"usr-5BERfwA0nyGFI4Wn8a5y3yv3IGW"
"affinity_group_id":
"afg-20MpN8vmIPj77ujhb9cS8ctstN2"
"secondary_affinity_group_id":
"afg-21MpN8vmIPj77ujhb9cS8ctstN3"
"card_type":
"PHYSICAL"
"address":{
"street_name":
"Street"
"street_number":
"123"
"floor":
"5"
"apartment":
"A"
"city":
"Buenos Aires"
"region":
"Buenos Aires"
"country":
"Argentina"
"zip_code":
"5653"
"neighborhood":
"Palermo"
"additional_info":
"Torre 2. Casa amarilla"
}
"company":
"Pomelo"
"name_on_card":
"Dieguito"
}
Respostas de amostra
{
"data":[
0:{
...
}
]
}

Ativar Cartão

O endpoint /cards/v1/activation permite ativar um cartão físico e também configurar um PIN.

Validaremos que você atenda aos requisitos que detalhamos na documentação..

Parâmetros disponíveis
Header Parameters
Authorizationstringrequired
Exemplo: Bearer {access_token}
Body Parameters
user_idstring
ID público do portador do cartão.
Exemplo: usr-5BERfwA0nyGFI4Wn8a5y3yv3IGW
pinstringrequired
Novo PIN do cartão escolhido pelo usuário.
Exemplo: 1475
previous_card_idstring
Se você enviar este atributo, trataremos o novo cartão como um substituto deste.
Exemplo: crd-20gRqyp809SvDzXzhSeG2w6UiO5
activation_codestring(minLength: 10, maxLength: 10)required
Se você enviar este atributo, o cartão será ativado usando o código de ativação do mesmo
Exemplo: 0023456783
Detalhe de respostas
dataobject

Esta seção foi útil para você?

POST/cards/v1/activation
{
"user_id":
"usr-5BERfwA0nyGFI4Wn8a5y3yv3IGW"
"pin":
"1475"
"previous_card_id":
"crd-20gRqyp809SvDzXzhSeG2w6UiO5"
"activation_code":
"0023456783"
}
Respostas de amostra
{
"data":{
"id":
"crd-16262002575379UCMD2"
}
}

Eventos de cartões

Adicione este endpoint ao seu serviço para que possamos comunicar as novidades dos seus cartões em tempo real.

Se você tiver dúvidas sobre como configurar um webhook, visite nossa documentação.

Considerações

Esperamos uma resposta do tipo 2XX para garantir que você recebeu a notificação. Caso contrário, iremos reenviá-la.

Tipos de Eventos.

  • CREATION: Nós o notificaremos sempre que um novo cartão for criado.
  • ACTIVATION: Nós o notificaremos sempre que um cartão for ativado.
  • EMBOSSMENT: Nós o notificaremos sempre que enviarmos uma cartão para embozar.
  • BLOCK: Nós o notificaremos sempre que um cartão for bloqueado.
  • UNBLOCK: Nós o notificaremos sempre que um cartão for desbloqueado.
  • DISABLEMENT: Nós o notificaremos sempre que um cartão for desativado.
Parâmetros disponíveis
Header Parameters
X-Api-Keystringrequired
Este header permitirá identificar qual api-secret usar no caso de múltiplos pares de api-key e api-secret terem sido configurados.
Exemplo: X-Api-Key: h3Ws4Cv09JcCdw7732ig+1Eq3I2b+IWOI1anUu1A4dE=
X-Signaturestringrequired
Este header contém a assinatura digital (timestamp + endpoint + body) que você deve verificar para garantir a integridade do request. Se a assinatura não coincidir, você deve rejeitar o pedido.
Exemplo: X-Signature: hmac-sha256 kLV3Jeyn7qbKfGHLDQKKuy5xzG/kbPrYEg8RvD8jb8A=
X-Timestampstringrequired
Este header contém o momento em que o pedido foi assinado em formato unix-epoch para que você possa verificar se a assinatura não expirou.
Exemplo: X-Timestamp: 1637117179
X-Endpointstringrequired
O endpoint para o qual o pedido é feito e que você usou para gerar a assinatura. Use este cabeçalho para regenerar a assinatura a ser validada, compará-la com o endpoint do seu serviço e verificar se coincidem.
Exemplo: X-Endpoint: {clientPath}/cards/events
Body Parameters
event_idstring
Identificador de evento.
Enum: card-notificationcard-activationcard-creationcard-embossmentcard-blockcard-unblockcard-disablement
idstring
ID do cartão.
Exemplo: crd-23hJL4bm94q9BFEd2sGhBjY6xbH
updated_atstring
Data de atualização.
Exemplo: 2023-09-21T14:15:31.186Z
user_idstring
ID do usuário.
Exemplo: usr-23hJL4bm94q9BFEd2sGhBjY6xbH
eventstring
Tipo de notificação.
Exemplo: ACTIVATION
card_typestring
Tipo de cartão.
Enum: VIRTUALPHYSICAL
related_card_idstring
ID do cartão relacionado para cartões MultiApp.
Exemplo: crd-23hJL4bm94q9BFEd2sGhBjY6xbH
idempotency_keystring
Identificador idempotente de criação do evento.
Exemplo: e42c0eb9-3986-4f01-9f4a-df8d02a9a92f

Esta seção foi útil para você?

POST/cards/v1/cards/events
{
"event_id":
"card-notification"
"id":
"crd-23hJL4bm94q9BFEd2sGhBjY6xbH"
"updated_at":
"2023-09-21T14:15:31.186Z"
"user_id":
"usr-23hJL4bm94q9BFEd2sGhBjY6xbH"
"event":
"ACTIVATION"
"card_type":
"VIRTUAL"
"related_card_id":
"crd-23hJL4bm94q9BFEd2sGhBjY6xbH"
"idempotency_key":
"e42c0eb9-3986-4f01-9f4a-df8d02a9a92f"
}
Respostas de amostra

Atualizar Envio de Cartão

O endpoint /cards/v1/{id}/shipment permite atualizar o endereço de envio de um cartão.

Considerações

O cartão deve ser físico, nominativo e ter estado CREATED.

Parâmetros disponíveis
Header Parameters
Authorizationstringrequired
Exemplo: Bearer {access_token}
Body Parameters
addressobject
Path Parameters
idstringrequired
ID público do cartão.
Detalhe de respostas
dataobject

Esta seção foi útil para você?

PUT/cards/v1/{id}/shipment
{
"address":{
"street_name":
"Street"
"street_number":
"123"
"floor":
"5"
"apartment":
"A"
"city":
"Buenos Aires"
"region":
"Buenos Aires"
"country":
"Argentina"
"zip_code":
"5653"
"neighborhood":
"Palermo"
"additional_info":
"Torre 2. Casa amarilla"
}
}
Respostas de amostra
{
"data":{
"address":{
...
}
}
}

Atualizar CVV do Cartão

O endpoint /cards/{id}/cvv/refresh permite atualizar o CVV dinâmico de um cartão, invalidando o CVV atual e gerando um novo. Você poderá obter o novo CVV com o endpoint Obter Cartão.

Considerações

Este endpoint se aplica apenas a cartões virtuais de um grupo de afinidade com a funcionalidade de CVV dinâmico habilitada.

Parâmetros disponíveis
Header Parameters
Authorizationstringrequired
Exemplo: Bearer {access_token}
Path Parameters
idstringrequired
ID público do cartão.
Detalhe de respostas
dataobject

Esta seção foi útil para você?

POST/cards/v1/{id}/cvv/refresh
Respostas de amostra
{
"data":{
"id":
"crd-23hJL4bm94q9BFEd2sGhBjY6xbH"
}
}

Criar Lote de Cartões Innominados

O endpoint /cards/v1/batches permite criar um lote de cartões innominados.

Validaremos que você atenda aos requisitos que detalhamos na documentação.

Considerações

  • Cada lote tem um máximo de 1.000 cartões.
  • O endereço de envio é obrigatório se o tipo de distribuição for CLIENT.
  • Processaremos a chamada de forma assíncrona, ou seja, é possível que os cartões não estejam disponíveis imediatamente.
Parâmetros disponíveis
Header Parameters
Authorizationstringrequired
Exemplo: Bearer {access_token}
x-idempotency-keystringrequired
ID único em cada solicitação para usar nosso esquema de idempotência.
Exemplo: fRwX12Dg3345AD
Body Parameters
affinity_group_idstringrequired
Exemplo: afg-20MpN8vmIPj77ujhb9cS8ctstN2
quantitynumber(minimum: 1, maximum: 1000)required
Exemplo: 100
distribution_typestringrequired
Enum: CLIENTWAREHOUSEEXTERNAL
addressobject
Endereço é obrigatório quando a distribuição é do tipo CLIENTE
receiverobject
Receiver é obrigatório quando a distribuição é do tipo CLIENT.
Detalhe de respostas
dataobject

Esta seção foi útil para você?

POST/cards/v1/batches
{
"affinity_group_id":
"afg-20MpN8vmIPj77ujhb9cS8ctstN2"
"quantity":
100
"distribution_type":
"CLIENT"
"address":{
"street_name":
"Street"
"street_number":
"123"
"floor":
"5"
"apartment":
"A"
"city":
"Buenos Aires"
"region":
"Buenos Aires"
"country":
"Argentina"
"zip_code":
"5653"
"neighborhood":
"Palermo"
"additional_info":
"Torre 2. Casa amarilla"
}
"receiver":{
"full_name":
"Gonzalo Iglesias"
"email":
"document_type":
"DNI"
"document_number":
"35354896"
"telephone_number":
"1132421452"
}
}
Respostas de amostra
{
"data":{
"shipment_id":
"shi-16281925351057V5BKK"
"affinity_group_id":
"afg-20MpN8vmIPj77ujhb9cS8ctstN2"
"card_type":
"PHYSICAL"
"quantity":
100
"distribution_type":
"CLIENT"
}
}

Criar Múltiplos Lotes de Innominados

O endpoint /cards/v1/batches/bulk permite criar até 15 lotes de cartões innominados ao mesmo tempo.

Validaremos que você atenda aos requisitos que detalhamos na documentação.

Considerações

  • Cada lote tem um máximo de 1.000 cartões.
  • O endereço de envio é obrigatório se o tipo de distribuição for CLIENT.
  • Processaremos a chamada de forma assíncrona, ou seja, é possível que os cartões não estejam disponíveis imediatamente.
Parâmetros disponíveis
Header Parameters
Authorizationstringrequired
Exemplo: Bearer {access_token}
x-idempotency-keystringrequired
ID único em cada solicitação para usar nosso esquema de idempotência.
Exemplo: fRwX12Dg3345AD
Body Parameters
affinity_group_idstringrequired
Exemplo: afg-20MpN8vmIPj77ujhb9cS8ctstN2
quantitynumber(minimum: 1, maximum: 15000)required
Exemplo: 100
distribution_typestringrequired
Enum: CLIENTWAREHOUSEEXTERNAL
addressobject
Endereço é obrigatório quando a distribuição é do tipo CLIENTE
receiverobject
Receiver é obrigatório quando a distribuição é do tipo CLIENT.
Detalhe de respostas
dataobject

Esta seção foi útil para você?

POST/cards/v1/batches/bulk
{
"affinity_group_id":
"afg-20MpN8vmIPj77ujhb9cS8ctstN2"
"quantity":
100
"distribution_type":
"CLIENT"
"address":{
"street_name":
"Street"
"street_number":
"123"
"floor":
"5"
"apartment":
"A"
"city":
"Buenos Aires"
"region":
"Buenos Aires"
"country":
"Argentina"
"zip_code":
"5653"
"neighborhood":
"Palermo"
"additional_info":
"Torre 2. Casa amarilla"
}
"receiver":{
"full_name":
"Gonzalo Iglesias"
"email":
"document_type":
"DNI"
"document_number":
"35354896"
"telephone_number":
"1132421452"
}
}
Respostas de amostra
{
"data":{
"shipment_ids":[
...
]
"affinity_group_id":
"afg-20MpN8vmIPj77ujhb9cS8ctstN2"
"card_type":
"PHYSICAL"
"quantity":
100
"distribution_type":
"CLIENT"
}
}

Criar Lote de Multi-Cartões

Criar um lote de multi-cartões que permite associar dois bines em um mesmo cartão físico.
Parâmetros disponíveis
Header Parameters
Authorizationstringrequired
Exemplo: Bearer {access_token}
x-idempotency-keystringrequired
ID único em cada solicitação para usar nosso esquema de idempotência.
Exemplo: fRwX12Dg3345AD
Body Parameters
affinity_group_idstringrequired
Exemplo: afg-20MpN8vmIPj77ujhb9cS8ctstN2
secondary_affinity_group_idstringrequired
Exemplo: afg-21MpN8vmIPj77ujhb9cS8ctstN3
quantitynumber(minimum: 1, maximum: 500)required
Exemplo: 100
distribution_typestringrequired
Enum: CLIENTWAREHOUSEEXTERNAL
addressobject
Endereço é obrigatório quando a distribuição é do tipo CLIENTE
receiverobject
Receiver é obrigatório quando a distribuição é do tipo CLIENT.
Detalhe de respostas
dataobject

Esta seção foi útil para você?

POST/cards/v1/batches/multicard
{
"affinity_group_id":
"afg-20MpN8vmIPj77ujhb9cS8ctstN2"
"secondary_affinity_group_id":
"afg-21MpN8vmIPj77ujhb9cS8ctstN3"
"quantity":
100
"distribution_type":
"CLIENT"
"address":{
"street_name":
"Street"
"street_number":
"123"
"floor":
"5"
"apartment":
"A"
"city":
"Buenos Aires"
"region":
"Buenos Aires"
"country":
"Argentina"
"zip_code":
"5653"
"neighborhood":
"Palermo"
"additional_info":
"Torre 2. Casa amarilla"
}
"receiver":{
"full_name":
"Gonzalo Iglesias"
"email":
"document_type":
"DNI"
"document_number":
"35354896"
"telephone_number":
"1132421452"
}
}
Respostas de amostra
{
"data":{
"shipment_id":
"shi-16281925351057V5BKK"
"affinity_group_id":
"afg-20MpN8vmIPj77ujhb9cS8ctstN2"
"secondary_affinity_group_id":
"afg-21MpN8vmIPj77ujhb9cS8ctstN3"
"card_type":
"PHYSICAL"
"quantity":
100
"distribution_type":
"CLIENT"
}
}

Atualizar Envio de um lote de cartões

O endpoint /cards/v1/batches/shipments/{shipmentId} permite atualizar o endereço de envio de um lote de cartões.

Considerações

O lote de cartões deve ser físico innominado e ter estado CREATED.

Parâmetros disponíveis
Header Parameters
Authorizationstringrequired
Exemplo: Bearer {access_token}
Body Parameters
addressobject
receiverobject
Path Parameters
shipmentIdstringrequired
ID público do envio.
Detalhe de respostas
dataobject

Esta seção foi útil para você?

PUT/cards/v1/batches/shipments/{shipmentId}
{
"address":{
"street_name":
"Street"
"street_number":
"123"
"floor":
"5"
"apartment":
"A"
"city":
"Buenos Aires"
"region":
"Buenos Aires"
"country":
"Argentina"
"zip_code":
"5653"
"neighborhood":
"Palermo"
"additional_info":
"Torre 2. Casa amarilla"
}
"receiver":{
"full_name":
"Gonzalo Iglesias"
"email":
"document_type":
"DNI"
"document_number":
"35354896"
"telephone_number":
"1132421452"
}
}
Respostas de amostra
{
"data":{
"address":{
...
}
}
}

Obter Grupo de Afinidade.

O endpoint /config/affinity-groups/{id} permite obter informações sobre um grupo de afinidade em particular.
Parâmetros disponíveis
Header Parameters
Authorizationstringrequired
Exemplo: Bearer {access_token}
Path Parameters
idstringrequired
ID público do grupo de afinidade.
Detalhe de respostas
dataobject
metaobject

Esta seção foi útil para você?

GET/cards/v1/config/affinity-groups/{id}
Respostas de amostra
{
"data":{
"name":
"Pomelo Innominate"
"card_type_supported":[
...
]
"innominate":
true
"months_to_expiration":
96
"issued_account":
9
"fee_account":
36
"exchange_rate_type":
"none"
"exchange_rate_amount":
100
"local_withdrawal_allowed":
true
"international_withdrawal_allowed":
true
"local_ecommerce_allowed":
true
"international_ecommerce_allowed":
true
"local_purchases_allowed":
true
"international_purchases_allowed":
true
"product_id":
"prd-20MpN8vmIPj77ujhb9cS8ctstN2"
"local_extracash_allowed":
false
"international_extracash_allowed":
true
"plastic_model":
388
"provider":
"MASTERCARD"
"kit_model":
122323
"embossing_company":
"THALES"
"courier_company":
"ANDREANI"
"id":
"string"
"status":
"ACTIVE"
"total_exchange_rate":
150.5
"total_non_usd_exchange_rate":
150.5
"exchange_currency_name":
"ARS"
"activation_code_enabled":
true
"dcvv_enabled":
true
"dcvv_expiration_in_seconds":
60
"start_date":
"2024-01-01"
"provider_algorithm":
"EMV_CSKD"
"custom_name_on_card_enabled":
false
"total_dcc_exchange_rate":
20.6
"dcc_exchange_rate_amount":
2
"non_usd_exchange_rate_amount":
100
"min_months_to_expiration":
36
"max_months_to_expiration":
48
"country":{
...
}
}
"meta":{}
}