Key Creation

Request

POST 'https://apisandbox.delbank.com.br/indirect-pix/api/v1/dict/entries'

curl --request POST \
     --url https://apisandbox.delbank.com.br/indirect-pix/api/v1/dict/claims \
     --header 'IdempotencyKey: 9d16ea35-8a85-49ea-a41e-bcf56c677129' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --header 'x-delbank-api-key: {{apiKey}}' \
     --data '
{
    "type": "DOCUMENT",
    "account": {
        "type": "CURRENT",
        "number": "2000",
        "branch": "0001",
        "createdAt": "2023-05-07T16:36:08.111Z",
        "holder": {
            "document": "06130856555",
            "name": "NATURAL PERSON LOREN IPSUN LOREN",
            "type": "NATURAL"
        }
    }
}
'

curl --request POST \
     --url https://apisandbox.delbank.com.br/indirect-pix/api/v1/dict/claims \
     --header 'IdempotencyKey: 9d16ea35-8a85-49ea-a41e-bcf56c677129' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --header 'x-delbank-api-key: {{apiKey}}' \
     --data '
{
    "key": "+5579999999999",
    "type": "PHONE",
    "account": {
        "type": "CURRENT",
        "number": "2000",
        "branch": "0001",
        "createdAt": "2023-05-07T16:36:08.111Z",
        "holder": {
            "document": "06130856555",
            "name": "NATURAL PERSON LOREN IPSUN LOREN",
            "type": "NATURAL"
        }
    }
}
'

Headers

Name	Description
x-delbank-api-key	Required. API key
IdempotencyKey	Required. Request's idempotency key. Provide a GUID, being a new one for each request.

Body

Name	Type	Description
type	`string`	Required. Key type. Domains: `DOCUMENT` - CPF or CNPJ (This field will be utilized in the `account.holder.document` as Pix key to create a revindication); `EMAIL` - Inform in the case where a `key` being the e-mail type. `PHONE` - Inform in the case where a `key` being the phone type.
account	`object`	Required. Object containing the bank account information of the client that’s creating the revindication.
account.number	`string`	Client bank account number Required Min length: 1 Max length: 20
account.branch	`string`	Client bank account branch Required Length: 4
account.type	`enum`	Required. Client bank account type. Domains: `CURRENT` - Current account `PAYMENT` - Payment account `SAVING` - Savings account `SALARY` - Salary account
account.createdAt	`datetime`	Required. Bank account creation date. Format: `yyyy-MM-dd'T'HH:mm:ss:sssZ`
account.holder	`object`	Required. Object containing the bank account holder information
account.holder.document	`string`	Required. Hoder name
account.holder.name	`string`	Required. Holder’s document (CPF or CNPJ)
account.holder.type	`enum`	Required.Holder’s bank account type. Domains: `NATURAL` - Natural Person `LEGAL` - Legal Person

{
    "type": "EVP",
    "account": {
        "type": "CURRENT",
        "number": "10110",
        "branch": "0001",
        "createdAt": "2023-05-07T16:36:08.123Z",
        "holder": {
            "document": "15879803040",
            "name": "NATURAL PERSON LOREN IPSUN LOREN",
            "type": "NATURAL"
        }
    }
}

{
    "type": "EMAIL",
    "key": "[email protected]",
    "account": {
        "type": "CURRENT",
        "number": "1011",
        "branch": "0001",
        "createdAt": "2023-05-07T16:36:08.789Z",
        "holder": {
            "document": "96814572001",
            "name": "NATURAL PERSON LOREN IPSUN LOREN",
            "type": "NATURAL"
        }
    }
}

{
    "type": "PHONE",
    "key": "+5555991000025",
    "account": {
        "type": "PAYMENT",
        "number": "10001",
        "branch": "0001",
        "createdAt": "2023-07-20T23:00:00.000Z",
        "holder": {
            "name": "TESTE DICT OK",
            "document": "60680955097",
            "type": "NATURAL"
        }
    }
}

{
    "type": "DOCUMENT",
    "account": {
        "type": "CURRENT",
        "number": "1002",
        "branch": "0001",
        "createdAt": "2023-05-07T16:36:08.999Z",
        "holder": {
            "document": "49862900024",
            "name": "LOREM IPSUM DOLOR SIT",
            "type": "NATURAL"
        }
    }
}

{
    "type": "DOCUMENT",
    "account": {
        "type": "CURRENT",
        "number": "1001",
        "branch": "0001",
        "createdAt": "2023-05-07T16:36:08.876Z",
        "holder": {
            "document": "15060996000106",
            "name": "LEGAL PERSON LOREN IPSUN LOREN",
            "type": "LEGAL"
        }
    }
}

Response

The `status code 200`` will indicate success in the transaction.

Being well-succeeded, the return will have the following fields:

{
    "id": "7fa3dc4a-f45e-4c39-8999-da49c76c1174",
    "key": "15060996000106",
    "type": "DOCUMENT",
    "createdAt": "2023-11-08T03:18:43.853Z",
    "account": {
        "number": "1001",
        "branch": "0001",
        "type": "CURRENT",
        "createdAt": "2023-05-07T16:36:08.876Z",
        "participant": {
            "name": "PARTICIPANT NAME",
            "ispb": "99999999"
        },
        "holder": {
            "name": "LEGAL PERSON LOREN IPSUN LOREN",
            "document": "15060996000106",
            "type": "LEGAL"
        }
    }
}

Body

Name	Type	Description
type	`string`	Key type
key	`string`	Key value (IF the key is an EVP, then the returned value will be a GUID)
account	`object`	Information about a client bank account that is creating a key
account.number	`string`	Client’s bank account number
account.branch	`string`	Client’s bank account branch
account.type	`enum`	Client’s bank account type
account.createdAt	`datetime`	Bank account opening date Format: `yyyy-MM-dd'T’HH:mm:ss.sssZ`
participant	`object`	Information about the key’s participant holder
participant.name	`string`	Participant’s name
participant.ispb	`string`	Participant’s ISPB
account.holder	`object`	Information about the bank account holder
account.holder.document	`string`	Holder’s name
account.holder.name	`string`	Holder’s document
account.holder.type	`enum`	Type of the holder’s document. Domains: `NATURAL` - Natural Person `LEGAL` - Legal Person