Criar uma transferência interna

POST

/internal-transfers

Internal Transfers

Cria uma nova transferência interna entre contas da mesma instituição

Requisição

Authorization

OAuth 2.0

Client Credentials

Adicionar o parâmetro

Authorization

a Cabeçalhos, cujo valor é concatenar o Token após o Bearer.

Exemplo:

Authorization: Bearer ********************

Token URL: /oauth/token

Scopes:

internal-transfer.write-Access to create internal transfers

Parâmetros Header

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢202

application/json

Transferência aceita para processamento

Bodyapplication/json

🟠400

🟠401

🟠403

🟠412

🟠422

🟠429

🔴500

🔴503

🔴504

Request Example

Shell

JavaScript

Java

Swift

curl --location '/internal-transfers' \
--header 'x-idempotency-key;' \
--header 'Content-Type: application/json' \
--data '{
    "creditorAccount": {
        "document": "12345678901",
        "name": "João Silva",
        "issuer": "0001",
        "number": "123456",
        "accountType": "CACC"
    },
    "payment": {
        "currency": "BRL",
        "amount": 100.5
    },
    "paymentFlow": "INSTANT",
    "remittanceInformation": "Transferência para pagamento"
}'

Response Example

202 - Exemplo 1

{
    "data": {
        "id": 0,
        "endToEndId": "string",
        "status": "PROCESSING",
        "transactionType": "INTERNAL",
        "createdAt": "2019-08-24T14:15:22.123Z",
        "eventDate": "2019-08-24T14:15:22.123Z",
        "idempotencyKey": "string",
        "payment": {
            "currency": "BRL",
            "amount": 0
        },
        "creditorAccount": {
            "document": "string",
            "name": "string",
            "issuer": "string",
            "number": "string",
            "accountType": "SLRY",
            "ispb": "string"
        },
        "debtorAccount": {
            "document": "string",
            "name": "string",
            "issuer": "string",
            "number": "string",
            "accountType": "SLRY",
            "ispb": "string"
        },
        "remittanceInformation": "string",
        "refunds": [
            {
                "id": 0,
                "amount": 0,
                "reason": "string",
                "status": "string",
                "createdAt": "2019-08-24T14:15:22.123Z"
            }
        ]
    }
}

Página anterior

Criar webhooks para operações de infração.

Próxima página

Obter transferência interna por EndToEndId