Skip to content

Instantly share code, notes, and snippets.

@ygarasab

ygarasab/card.md

Last active August 28, 2023 18:45
Show Gist options
  • Save ygarasab/2fa26f6148eee09708c9a90d8fca0798 to your computer and use it in GitHub Desktop.
Save ygarasab/2fa26f6148eee09708c9a90d8fca0798 to your computer and use it in GitHub Desktop.
Download ZIP
Cartão Asaas
Raw
card.md

Status possíveis:

PENDING - Pendente de envio
IN_TRANSIT - Em trânsito
ACTIVE - Ativo
BLOCKED - Bloqueado

Buscar um cartão

[GET] - /api/v3/asaasCards/?id={id}

Parâmetros

Id - Identificador único do cartão no Asaas

Headers:

access_token: sua_api_key

Response

{
    "object": "asaasCard",
    "id": "3f7fd23c-5c4f-4bf9-904c-49b7b758fa3a",
    "status": "ACTIVE",
    "name": "Cartão do João",
    "expirationMonth": null,
    "expirationYear": null,
    "number": "5555 55** **** 5555",
    "fourthLine": "Asaas Gestão Financeira",
    "balance": null,
    "holder": {
        "name": "João da Silva",
        "email": "joao.silva@asaas.com",
        "mobilePhone": "47999999999",
        "postalCode": "89223005",
        "address": "Av. Rolf Wiest",
        "addressNumber": "277",
        "province": "Bom Retiro",
        "complement": "Ao lado do Garten Shopping",
        "city": {
            "object": "city",
            "id": 13660,
            "ibgeCode": "4209102",
            "name": "Joinville",
            "districtCode": "05",
            "district": "Joinville",
            "state": "SC"
        }
    },
    "embossingName": "",
    "type": "ELO_DEBIT"
}

Listar cartões

[GET] - /api/v3/asaasCards

Parâmetros

offset - Elemento inicial da lista
limit - Número de elementos da lista (max: 100)

Headers:

access_token: sua_api_key

Response

{
    "object": "list",
    "hasMore": false,
    "totalCount": 1,
    "limit": 10,
    "offset": 0,
    "data": [
        {
            "object": "asaasCard",
            "id": "3f7fd23c-5c4f-4bf9-904c-49b7b758fa3a",
            "status": "ACTIVE",
            "name": "Cartão do João",
            "expirationMonth": null,
            "expirationYear": null,
            "number": "5555 55** **** 5555",
            "fourthLine": "ASAAS",
            "balance": null,
            "holder": {
                "name": "João da Silva",
                "email": "joao.silva@asaas.com",
                "mobilePhone": "47999999999",
                "postalCode": "89223005",
                "address": "Av. Rolf Wiest",
                "addressNumber": "277",
                "province": "Bom Retiro",
                "complement": "Ao lado do Garten Shopping",
                "city": {
                    "object": "city",
                    "id": 13660,
                    "ibgeCode": "4209102",
                    "name": "Joinville",
                    "districtCode": "05",
                    "district": "Joinville",
                    "state": "SC"
                }
            },
            "embossingName": "",
            "type": "ELO_DEBIT"
        }
    ]
}

Solicitar um cartão

[POST] - /api/v3/asaasCards

Parâmetros

  • name (string) - Nome do portador do cartão
  • cpf (string) - CPF do portador do cartão
  • email (string) - Email do portador do cartão
  • mobilePhone (string) - Telefone do portador do cartão
  • birthDate (string) - Data de nascimento do portador do cartão
  • postalCode (string) - CEP do portador do cartão
  • address (string) - Endereço do portador do cartão
  • addressNumber (string) - Número de endereço do portador do cartão
  • province (string) - Bairro de residência do portador do cartão
  • complement (string) - Complemento de residência do portador do cartão
  • cardName (string, opcional) - Nome do cartão
  • type (string) - Tipo do cartão
    • ELO_DEBIT - Cartão de crédito da bandeira Elo, podendo ser usado apenas em 1x, tendo o valor descontado diretamente do saldo em conta.

Request

{
    "name": "João da Silva",
    "cpf": "53202688073",
    "email": "joao.silva@asaas.com.br",
    "mobilePhone": "47999999999",
    "birthDate": "1984-10-05",
    "postalCode": "89223005",
    "address": "Av. Rolf Wiest",
    "addressNumber": "277",
    "province": "Bom Retiro",
    "complement": "Ao lado do Garten Shopping",
    "cardName": "Cartão do João",
    "type": "ELO_DEBIT"
}

Response

{
    "object": "asaasCard",
    "id": "aee12225-7e0c-4515-a705-79618b9a3b13",
    "status": "PENDING",
    "name": "Cartão do João",
    "expirationMonth": null,
    "expirationYear": null,
    "number": "**** **** **** ****",
    "fourthLine": "ASAAS",
    "balance": null,
    "holder": {
        "name": "João da Silva",
        "email": "joao.silva@asaas.com.br",
        "mobilePhone": "47999999999",
        "postalCode": "89223005",
        "address": "Av. Rolf Wiest",
        "addressNumber": "277",
        "province": "Bom Retiro",
        "complement": "Ao lado do Garten Shopping",
        "city": {
            "object": "city",
            "id": 13660,
            "ibgeCode": "4209102",
            "name": "Joinville",
            "districtCode": "05",
            "district": "Joinville",
            "state": "SC"
        }
    },
    "embossingName": "",
    "type": "ELO_DEBIT"
}

Ativar cartão

[POST] - /api/v3/asaasCards/{id}/activate

Parâmetros

  • Id - Identificador único do cartão no Asaas
  • pin (string) - Senha do cartão
  • lastDigits (string) - Ultimos 4 dígitos do cartão

Request

{
    "pin": "3544",
    "pinConfirmation": "3544",
    "lastDigits": "5555"
}

Response

{
    "object": "asaasCard",
    "id": "4130fd11-b185-4d5b-955d-6cef00a9d543",
    "status": "ACTIVE",
    "name": "Cartão do João",
    "expirationMonth": "11",
    "expirationYear": "25",
    "number": "**** **** **** ****",
    "fourthLine": "ASAAS",
    "balance": null,
    "holder": {
        "name": "João da Silva",
        "email": "joao.silva@asaas.com.br",
        "mobilePhone": "47999999999",
        "postalCode": "89223005",
        "address": "Av. Rolf Wiest",
        "addressNumber": "277",
        "province": "Bom Retiro",
        "complement": "Ao lado do Garten Shopping",
        "city": {
            "object": "city",
            "id": 13660,
            "ibgeCode": "4209102",
            "name": "Joinville",
            "districtCode": "05",
            "district": "Joinville",
            "state": "SC"
        }
    },
    "embossingName": "",
    "type": "ELO_DEBIT"
}

Bloquear cartão

[POST] - /api/v3/asaasCards/{id}/block

Parâmetros

Id - Identificador único do cartão no Asaas

Response

{
    "object": "asaasCard",
    "id": "4130fd11-b185-4d5b-955d-6cef00a9d543",
    "status": "BLOCKED",
    "name": "Cartão do João",
    "expirationMonth": "11",
    "expirationYear": "25",
    "number": "**** **** **** ****",
    "fourthLine": "ASAAS",
    "balance": null,
    "holder": {
        "name": "João da Silva",
        "email": "joao.silva@asaas.com.br",
        "mobilePhone": "47999999999",
        "postalCode": "89223005",
        "address": "Av. Rolf Wiest",
        "addressNumber": "277",
        "province": "Bom Retiro",
        "complement": "Ao lado do Garten Shopping",
        "city": {
            "object": "city",
            "id": 13660,
            "ibgeCode": "4209102",
            "name": "Joinville",
            "districtCode": "05",
            "district": "Joinville",
            "state": "SC"
        }
    },
    "embossingName": "",
    "type": "ELO_DEBIT"
}

Deletar cartão

[DELETE] - /api/v3/asaasCards/{id}

Parâmetros

Id - Identificador único do cartão no Asaas

Response

{
    "deleted": true,
    "id": "4130fd11-b185-4d5b-955d-6cef00a9d543"
}

Trocar nome do cartão

[POST] - /api/v3/asaasCards/{id}/updateName

Parâmetros

Id - Identificador único do cartão no Asaas
name - Novo nome do cartão

Request

{
    "name": "Cartão do João da Silva"
}

Response

{
    "object": "asaasCard",
    "id": "4130fd11-b185-4d5b-955d-6cef00a9d543",
    "status": "BLOCKED",
    "name": "Cartão do João da Silva",
    "expirationMonth": "11",
    "expirationYear": "25",
    "number": "**** **** **** ****",
    "fourthLine": "ASAAS",
    "balance": null,
    "holder": {
        "name": "João da Silva",
        "email": "joao.silva@asaas.com.br",
        "mobilePhone": "47999999999",
        "postalCode": "89223005",
        "address": "Av. Rolf Wiest",
        "addressNumber": "277",
        "province": "Bom Retiro",
        "complement": "Ao lado do Garten Shopping",
        "city": {
            "object": "city",
            "id": 13660,
            "ibgeCode": "4209102",
            "name": "Joinville",
            "districtCode": "05",
            "district": "Joinville",
            "state": "SC"
        }
    },
    "embossingName": "",
    "type": "ELO_DEBIT"
}

Trocar senha

[POST] - /api/v3/asaasCards/{id}/changePin

Parâmetros

Id - Identificador único do cartão no Asaas
pin - Nova senha do cartão

Request

{
    "pin": "5269"
}

Response

{
    "object": "asaasCard",
    "id": "4130fd11-b185-4d5b-955d-6cef00a9d543",
    "status": "ACTIVE",
    "name": "Cartão do João da Silva",
    "expirationMonth": "11",
    "expirationYear": "25",
    "number": "**** **** **** ****",
    "fourthLine": "ASAAS",
    "balance": null,
    "holder": {
        "name": "João da Silva",
        "email": "joao.silva@asaas.com.br",
        "mobilePhone": "47999999999",
        "postalCode": "89223005",
        "address": "Av. Rolf Wiest",
        "addressNumber": "277",
        "province": "Bom Retiro",
        "complement": "Ao lado do Garten Shopping",
        "city": {
            "object": "city",
            "id": 13660,
            "ibgeCode": "4209102",
            "name": "Joinville",
            "districtCode": "05",
            "district": "Joinville",
            "state": "SC"
        }
    },
    "embossingName": "",
    "type": "ELO_DEBIT"
}

Desbloquear cartão

[POST] - /api/v3/asaasCards/{id}/unblock

Parâmetros

Id - Identificador único do cartão no Asaas

Response

{
    "object": "asaasCard",
    "id": "4130fd11-b185-4d5b-955d-6cef00a9d543",
    "status": "ACTIVE",
    "name": "Cartão do João da Silva",
    "expirationMonth": "11",
    "expirationYear": "25",
    "number": "**** **** **** ****",
    "fourthLine": "ASAAS",
    "balance": null,
    "holder": {
        "name": "João da Silva",
        "email": "joao.silva@asaas.com.br",
        "mobilePhone": "47999999999",
        "postalCode": "89223005",
        "address": "Av. Rolf Wiest",
        "addressNumber": "277",
        "province": "Bom Retiro",
        "complement": "Ao lado do Garten Shopping",
        "city": {
            "object": "city",
            "id": 13660,
            "ibgeCode": "4209102",
            "name": "Joinville",
            "districtCode": "05",
            "district": "Joinville",
            "state": "SC"
        }
    },
    "embossingName": "",
    "type": "ELO_DEBIT"
}

Listar transações

[GET] - /api/v3/asaasCards/{id}/listStatements

Parâmetros

Id - Identificador único do cartão no Asaas
offset - Elemento inicial da lista
limit - Número de elementos da lista (max: 100)

Headers:

access_token: sua_api_key

Response

{
    "object": "list",
    "hasMore": false,
    "totalCount": 2,
    "limit": 10,
    "offset": 0,
    "data": [
        {
            "id": "5479849849849",
            "date": "2021-02-23 17:24:03",
            "totalAmount": 1000,
            "refunded": false,
            "isOffline": true,
            "canRequestChargeback": false,
            "isRelatedToPurchaseTypes": true,
            "establishment": {
                "name": "Centauro Shopping Garten"
            },
            "chargebackDispute": {
                "refusalReason": "Nenhuma evidência pôde ser identificada.",
                "confirmedDate": "2021-02-23",
                "status": "DONE"
            }
        },
        {
            "id": "5479849849849",
            "date": "2021-02-23 17:24:03",
            "totalAmount": 50,
            "refunded": false,
            "isOffline": true,
            "canRequestChargeback": true,
            "isRelatedToPurchaseTypes": false,
            "establishment": {
                "name": "Caixa 23 horas - Shopping Garten"
            },
            "chargebackDispute": null
        }
    ]
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment