Starting the claiming process

Request

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

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
key	`string`	Optional. Key value. It must be informed if the key type is either EMAIL or PHONE.
type	`string`	Required. Key type. Domain: `DOCUMENT` - CPF or CNPJ (In this case, the key utilized will be the same as the account.holder.document to create the claim). `EMAIL` - Informs case the key value is of email type. `PHONE` - Informs case the key value is of phone type.
account	`object`	Required. Object containing information about the end client account.
account.number	`string`	Required. End client’s bank account number
account.branch	`string`	Required. End client’s bank account branch
account.type	`enum`	Required. End client’s bank account type. Domain: `CURRENT` - Current Account `PAYMENT` - Payment Account `SAVING` - Savings Account `SALARY` - Salary Account
account.holder	`object`	Required. Object containing information about the bank account holder.
account.holder.document	`string`	Required. Bank account holder’s document (CPF or CNPJ)
account.holder.name	`string`	Required. Bank account holder’s name
account.holder.type	`enum`	Required. Bank account holder’s document type. Domains: `NATURAL` - Natural Person `LEGAL` - Legal Person

Response

The status code 200 will indicate success in the transaction.

Being successful, the return will bring the following field in JSON format:

{
    "id": "6ab2d260-16db-4d7f-aac9-a91ba038f82d",
    "status": "PENDING",
    "resolutionDeadline": "2023-10-30T13:37:30.161Z",
    "donorParticipant": {
        "name": "EBANX IP LTDA.",
        "ispb": "21018182"
    }
}

Body

Name	Type	Description
id	`string`	Claiming Id
status	`enum`	Claiming status. Domains: `PENDIG` `AWAITING_RESOLUTION` `CONFIRMED` `CANCELED` `COMPLETED`
resolutionDeadline	`datetime`	Resolution date limit. UTC Format: `yyyy-MM-ddTHH:mm:ss.fffZ`
donorParticipant	`object`	Information about the key donor (Current owner of the key)
donorParticipant.name	`string`	Participant name that contains the donor key (current key owner)
donorParticipant.ispb	`string`	Participant’s ISPB that containing the doner key (current key owner)