TED

Nesta seção estão descritas as APIs que gerenciam o ciclo de vida do produto transferência eletrônica disponível (TED) de banking.

A rota da API para sandbox é: https://apigw-sandbox.zoop.ws/v2

Envio de TED

post
Solicitação de Envio de TED

https://api-beta.zoop.ws/v2/marketplaces/:marketplace_id/holders/:holder_id/accounts/:account_id/external-transfer-send
Este serviço destina-se a criar uma TED para outra conta. Obs.: O horário para a realização de TED é de 08:00 - 16:30 horas.
Request
Response
Request
Path Parameters
marketplace_id
required
string
Id do marketplace
holder_id
required
string
Id do holder que requisita o envio de TED
account_id
required
string
Id da conta
Body Parameters
purpose_code
optional
integer
Código do propósito do envio da TED. Se não informado, o valor considerado será 10 (crédito em conta)
amount
required
integer
Valor em centavos a ser transferido
recipient
required
object
Conjunto referente ao recebedor da transferência
account_check_digit
required
integer
Digito verificador da conta de destino - parâmetro pertencente ao objeto recipient
account_number
required
integer
Número da conta de destino - parâmetro pertencente ao objeto recipient
bank_code
required
integer
Código do banco de destino - parâmetro pertencente ao objeto recipient (utilizar 208 para TED com destino Zoop)
document
required
integer
CPF/CNPJ da conta de destino - parâmetro pertencente ao objeto recipient
name
required
string
Nome do beneficiário do TED - parâmetro pertencente ao objeto recipient
routing_check_digit
optional
integer
Digito verificador da agencia da conta de destino - parâmetro pertencente ao objeto recipient
routing_number
required
integer
Número da agencia da conta de destino - parâmetro pertencente ao objeto recipient (Utilizar 0025 para TED com destino Zoop)
description
optional
string
Descrição da transferência
reference_id
optional
string
Identificador único para a transferência
Response
200: OK
{
"external_transfer_id": "2a53965957814b30a065a2bb5d25bf67",
"amount": 400,
"formated_amount": "4.00",
"description": "Transferência Bancária",
"reference_id": "22b0255e-367a-43f0-bab4-eb81da0f6969",
"status": "AUTHORIZED",
"recipient": {
"name": "Zoop",
"document": "99467256000170",
"bank_code": "208",
"routing_number": "001",
"routing_check_digit": "01",
"account_number": "10101010",
"account_check_digit": "01"
}
}
400: Bad Request
Reference Id já existe
{
"status": "bad_request",
"type": "invalid_request",
"message": "Reference id already exists for this account.",
"category": "business",
"status_code": 400
}
403: Forbidden
Janela de Transferência inválida
{
"status": "bad_request",
"type": "invalid_request",
"message": "Transfer window is not valid",
"category": "business",
"status_code": 400
}
404: Not Found
Conta não encontrada
{
"status": "bad_request",
"type": "invalid_request",
"message": "Account not found",
"category": "business",
"status_code": 404
}
{
"amount": 400,
"recipient": {
"account_check_digit": "01",
"account_number": "10101010",
"bank_code": "208",
"document": "99467256000170",
"name": "Zoop",
"routing_check_digit": "01",
"routing_number": "001"
},
"description": "Transferência Bancária",
"purpose_code": "10",
"reference_id": "7acb2cec-0f18-482c-a508-3eade9367ba3"
}

get
Consulta de Envio de TED pelo referenceId

https://api-beta.zoop.ws/v2/marketplaces/:marketplace_id/holders/:holder_id/accounts/:account_id/external-transfer-send/reference-id/:referenceId
Este serviço recupera os detalhes de uma TED utilizando o referece_id como parâmetro de busca.
Request
Response
Request
Path Parameters
marketplaceId
required
string
Id do marketplace sob qual o holder requisitou o envio da TED
holderId
required
string
Id do holder que requisita o envio da TED
accountId
required
string
Id da conta
referenceId
required
string
Id de referencia informado na solicitação da TED
Response
200: OK
{
"external_transfer_id": "2c7336f582194c28aec6d3317a17da11",
"amount": 5000,
"formated_amount": "50.00",
"description": "Transferência Bancária",
"reference_id": "0cabeb6a-5110-4943-b555-9cebcbdae627",
"status": "PROCESSING",
"recipient": {
"name": "Zoop",
"document": "99467256000170",
"bank_code": "208",
"routing_number": "001",
"routing_check_digit": "01",
"account_number": "10101010",
"account_check_digit": "01"
}
}
404: Not Found
{
"status": "not_found",
"type": "not_found",
"message": "Ted not found",
"category": "business",
"status_code": 404
}

get
Consulta de Envio de TED por externalTransferId

https://api-beta.zoop.ws/v2/marketplaces/:marketplace_id/holders/:holder_id/accounts/:account_id/external-transfer-send/:externalTransferId
Este serviço recupera os detalhes de uma TED utilizando o external transfer ID como parâmetro de busca.
Request
Response
Request
Path Parameters
marketplaceId
required
string
Id do marketplace sob o qual o holder requisitou o envio da TED
holderId
required
string
Id do holder que requisitou o envio da TED
accountId
required
string
Id da conta
externalTransferId
required
string
Id gerado da transferência quando bem sucedida
Response
200: OK
{
"external_transfer_id": "2c7336f582194c28aec6d3317a17da11",
"amount": 5000,
"formated_amount": "50.00",
"description": "Transferência Bancária",
"reference_id": "0cabeb6a-5110-4943-b555-9cebcbdae627",
"status": "PROCESSING",
"recipient": {
"name": "Zoop",
"document": "99467256000170",
"bank_code": "208",
"routing_number": "001",
"routing_check_digit": "01",
"account_number": "10101010",
"account_check_digit": "01"
}
}
400: Bad Request
{
"status": "bad_request",
"type": "invalid_request",
"message": "Invalid value for the path variable externalTransferId",
"category": "business",
"status_code": 400
}
404: Not Found
{
"status": "not_found",
"type": "not_found",
"message": "Ted not found",
"category": "business",
"status_code": 404
}

Lista de erros no envio de TED