Introduction

This API makes possible to register groups and maintain their registration to receive Electronic Data Interchange (EDI) files

Environment

Environment URL
Sandbox https://api2.cielo.com.br/sandbox/edi-api/v2/
Homologation https://apihom-cielo.sensedia.com/edi-api/v2/

Operations

POST Register Merchant ID

Register Merchant ID (just one, a list or all), based on a Entity Number.

Request

POST /edi/registers

Headers

Key Value
externalID Value generated by client to avoid duplicate request. That value can be used to get request. Do not used the same value for new requests.

{
  "mainMerchantId": "9999111222",
  "merchants": [
    "9999111111",
    "9999111333"
  ],
  "merchantEMail": "customer@customer.com",
  "type": [
    "SELL"
  ]
}

Property Description Type Size Required
mainMerchantId The most usual way to retrieve an EDI register in the company String    
merchants List representing the merchant codes registered. Example: List [ “9999111111”, “9999111333” ]      
status Branch is available ou unavailable      
type List representing TO BE state of conciliation file type. At least one of these files are required: SELL, PAYMENT, ANTECIPATION_CIELO      

Response


{
  "legalEntityNumber": 1234567890,
  "mainMerchantId": 2008983,
  "registerID": 12345,
  "merchants": [
    823958412384701,
    679809436576210
  ],
  "type": [
    "SELL"
  ],
  "status": "PROCESSING"
}

Property Description Type Size Required
legalEntityNumber Brazilian entity number. CPF por person and CNPJ for legal person String    
mainMerchantId The most usual way to retrieve an EDI register in the company String    
registerID The same one provided by /edi/registers. String    
merchants List representing the merchant codes registered. Example: List [ “9999111111”, “9999111333” ]      
type List representing TO BE state of conciliation file type. At least one of these files are required: SELL, PAYMENT, ANTECIPATION_CIELO      
status Branch is available ou unavailable      

GET Retrieve status

Retrieve the EDI registration status.

Response

GET /edi/registers/{registerID}

Headers

Key Value
registerID Value used to retrieve the registration status.

{
  "legalEntityNumber": "01234567890",
  "registerID": 12345,
  "merchants": [
    9999222111,
    9999222222
  ],
  "status": "PROCESSING"
}

Property Description Type Size Required
legalEntityNumber Brazilian entity number. CPF por person and CNPJ for legal person String    
registerID The same one provided by /edi/registers. String    
merchants List representing the merchant codes registered. Example: List [ “9999111111”, “9999111333” ]      
status Branch is available ou unavailable      

GET Consult Register Merchant ID

Consult Merchant ID based on a Register ID or a Main Merchant ID.

Response

GET /edi

Headers

Key Value
externalID Value generated by client to avoid duplicate request. That value can be used to get request. Do not used the same value for new requests.
registerID Registration ID provided by /edi/registers when registering. Can be used in place of mainMerchantID if preferred (only one needs to be informed).
mainMerchantID Main Customer ID. The most usual way to retrieve an EDI register in the company. Can be used instead of registerID mainly in cases of registration not performed by /edi/registers.

{
  "legalEntityNumer": "12314314",
  "mainMerchantId": 9999111222,
  "registerID": 12345,
  "merchants": [
    9999111111,
    9999111333
  ],
  "type": [
    "SELL"
  ],
  "acknowledge": "COMPLETED"
}

Property Description Type Size Required
legalEntityNumber Brazilian entity number. CPF por person and CNPJ for legal person String    
mainMerchantId The most usual way to retrieve an EDI register in the company String    
registerID The same one provided by /edi/registers. String    
merchants List representing the merchant codes registered. Example: List [ “9999111111”, “9999111333” ]      
type List representing TO BE state of conciliation file type. At least one of these files are required: SELL, PAYMENT, ANTECIPATION_CIELO      
acknowledge        

PUT Update Register Merchant ID

Update Merchant ID based on a Register ID or a Main Merchant ID.

Request

PUT /edi

Headers

Key Value
externalID Value generated by client to avoid duplicate request. That value can be used to get request. Do not used the same value for new requests.

{
  "registerID": "string",
  "mainMerchantId": "9999222333",
  "merchants": [
    "9999222111",
    "9999222222"
  ],
  "type": [
    "SELL"
  ]
}

Property Description Type Size Required
registerID The same one provided by /edi/registers. String    
mainMerchantId The most usual way to retrieve an EDI register in the company String    
merchants List representing the merchant codes registered. Example: List [ “9999111111”, “9999111333” ]      
type List representing TO BE state of conciliation file type. At least one of these files are required: SELL, PAYMENT, ANTECIPATION_CIELO      

Response


{
  "legalEntityNumber": "01234567890",
  "mainMerchantId": 9999111222,
  "registerID": 12345,
  "merchants": [
    9999222333,
    9999111222
  ],
  "type": [
    "SELL"
  ]
}

Property Description Type Size Required
legalEntityNumber Brazilian entity number. CPF por person and CNPJ for legal person String    
mainMerchantId The most usual way to retrieve an EDI register in the company String    
registerID The same one provided by /edi/registers. String    
merchants List representing the merchant codes registered. Example: List [ “9999111111”, “9999111333” ]      
type List representing TO BE state of conciliation file type. At least one of these files are required: SELL, PAYMENT, ANTECIPATION_CIELO      

DELETE Delete Register Merchant ID

Delete MerchantID based on a Register ID or a Main Merchant ID.

Response

DELETE /edi

Headers

Key Value
externalID Value generated by client to avoid duplicate request. That value can be used to get request. Do not used the same value for new requests.
registerID Registration ID provided by /edi/registers when registering. Can be used in place of mainMerchantID if preferred (only one needs to be informed).
mainMerchantID Main Customer ID. The most usual way to retrieve an EDI register in the company. Can be used instead of registerID mainly in cases of registration not performed by /edi/registers.

{
  "legalEntityNumer": "12314314",
  "mainMerchantId": 9999111222,
  "registerID": 12345,
  "acknowledge": "COMPLETED"
}

Property Description Type Size Required
legalEntityNumber Brazilian entity number. CPF por person and CNPJ for legal person String    
mainMerchantId The most usual way to retrieve an EDI register in the company String    
registerID The same one provided by /edi/registers. String    
acknowledge        

GET List of branches

Performs the list of customers below the informed access_token. The filter can be used to list only those available or unavailable. Unavailable means that the branch already participates in another register. In the register and editing services, there is validation to allow only those available to be informed.

Response

GET /edi/merchantgroup

Headers

Key Value
branchStatus BranchStatus is available ou unavailable.

{
  "legalEntityNumber": "string",
  "branches": [
    {
      "merchantID": "9999111222",
      "legalEntityNumber": "01234567890",
      "businessName": "V",
      "status": "UNAVAILABLE"
    }
  ]
}

Property Description Type Size Required
legalEntityNumber Brazilian entity number. CPF por person and CNPJ for legal person String    
branches List of branches      
businessName Legal business name      
status Branch is available ou unavailable