Creating an inbound operation

POST {{Environment_URL}}/v2/remittances/inbound

This route is responsible for creating the inbound operation after generating the quotation. You will need the quotation ID to proceed.

Request Body

Attribute	Description	Type	Required
quotationId	Previously generated inbound quotation identifier	String	Yes
accountId	Client account ID which will receive the inbound operation	String	Yes
clientCpf	Client document	String	Yes
inboundPaymentMethod	The payment method must be BANK_PATH	String	Yes
payment.method	Payment method must be TED	String	Yes

Headers

Name	Value	Description
authorization	Bearer <token>	Bearer Token obtained via sign-in
client-key	123ABCD456	Client authentication key, obtained via webhook.

Request

Bank Path

{
  "quotationId": "98918e024aef4cc5f623c89e15ac6983341dfc33",
  "accountId": "6973a19f2a7bbba96a8fd350",
  "clientCpf": "123.456.789-00",
  "inboundPaymentMethod": "BANK_PATH",
  "payment": {
    "method": "TED"
  }
}

Response

200 OK

{
  "id": "697ca5f998ff6000287b5666",
  "type": "INBOUND",
  "subType": "PERSON_TRANSFER",
  "correspondentId": 1,
  "status": {
    "key": "AWAITING_PAYMENT",
    "label": "Aguardando pagamento"
  },
  "quotation": {
    "currency": {
      "commercialExchangeRate": {
        "divisor": 10000,
        "updatedAt": "2023-08-14T20:08:25.000Z",
        "value": 53526
      },
      "levelingRate": {
        "value": 53526,
        "divisor": 10000
      },
      "offer": {
        "value": 100000,
        "divisor": 100
      },
      "offerUSD": {
        "value": 1000000000,
        "divisor": 10000,
        "currency": "USD",
        "precision": 4
      },
      "offerWithoutDiscount": {
        "value": 100000,
        "divisor": 100
      },
      "price": {
        "withTax": {
          "value": 51950,
          "divisor": 10000
        },
        "withoutTax": {
          "value": 52199,
          "divisor": 10000
        },
        "withFutureTax": {
          "value": 51950,
          "divisor": 10000
        },
        "withoutDiscount": {
          "value": 53056,
          "divisor": 10000
        }
      },
      "code": "USD",
      "name": "Dólar Americano",
      "countryFlagUrl": "https://s3.amazonaws.com/simple-exchanges-demo/new-flags/united-states.svg",
      "maxValue": 500000,
      "minValue": 100,
      "spreadPercentage": 0.5,
      "spreadPercentageWithoutDiscount": 0.5
    },
    "tax": {
      "iof": {
        "total": {
          "value": 1984,
          "divisor": 100
        },
        "percentage": 0.38
      },
      "bankFee": {
        "total": {
          "value": 500,
          "divisor": 100
        },
        "valueUSD": 5
      },
      "paymentProvider": {
        "total": {
          "value": 5220,
          "divisor": 100,
          "currency": "BRL",
          "precision": 2
        },
        "percentage": 1
      },
      "efxProvider": {
        "total": {
          "value": 5220,
          "divisor": 100,
          "currency": "BRL",
          "precision": 2
        },
        "percentage": 1
      }
    },
    "futureTax": {
      "ir": {
        "total": {
          "value": 0,
          "divisor": 100
        },
        "percentage": 0
      }
    },
    "total": {
      "withTax": {
        "value": 519502,
        "divisor": 100
      },
      "withoutTax": {
        "value": 521985,
        "divisor": 100
      },
      "withFutureTax": {
        "value": 519502,
        "divisor": 100
      },
      "withoutDiscount": {
        "value": 530060,
        "divisor": 100
      }
    },
    "discounts": {
      "coupon": {
        "total": {
          "value": 530060,
          "divisor": 100
        },
        "id": null,
        "code": null,
        "discountValue": 0
      }
    },
    "id": "77ffe28c7f631dc0aef8fddc597809e546500e56",
    "correspondentId": 111,
    "purposeCode": "MAINTENANCE",
    "type": "INBOUND",
    "clamp": "NORMAL",
    "timeToLive": 600,
    "expiresAt": "2026-01-30T12:47:00.000Z",
    "createdAt": "2026-01-30T12:37:00.936Z",
    "miles": {
      "regular": 2078,
      "bonus": 3117
    },
    "metaData": {
      "managerOperation": null
    }
  },
  "total": {
    "value": 519502,
    "divisor": 100
  },
  "client": {
    "address": {
      "state": "SP",
      "city": "São Paulo",
      "neighborhood": "Centro",
      "street": "Anchieta",
      "number": 123,
      "complement": "Casa",
      "zipCode": "12345-678",
      "nickname": "Work"
    },
    "name": "JOHN DOE",
    "email": "[email protected]",
    "mobile": "[phone]",
    "wlStatus": "accepted",
    "firstOperationDate": "2023-03-21T13:39:39.150Z",
    "lastOperationDate": "2023-03-21T14:05:20.352Z",
    "totalOperations": {
      "TED": 0,
      "CREDIT_CARD_LINK": 0,
      "PIX": 0,
      "DYNAMIC_PIX": 2,
      "PICPAY": 0,
      "CREDIT_CARD": 0,
      "UNKNOWN": 0,
      "MONEY_TRANSFER": 0
    },
    "cpf": "123.456.789-00",
    "birthDate": "1997-09-11T03:00:00.000Z"
  },
  "receiver": {
    "address": {},
    "id": "68cc6bb3eaec5976b2c2e54b",
    "name": "JOHN DOE",
    "email": "[email protected]",
    "mobile": "[phone]",
    "cpf": "123.456.789-00"
  },
  "account": {
    "id": "69440c9bcc731f14f8008a1f",
    "paymentMethod": "PIX",
    "pixKey": "123.456.789-00",
    "pixType": "CPF",
    "name": "JOHN DOE",
    "type": "INBOUND",
    "beneficiaryDocument": {},
    "code": {},
    "investmentBrokerCode": []
  },
  "user": {
    "id": 72,
    "email": "[email protected]",
    "type": "user_correspondent"
  },
  "paymentId": "",
  "partnerId": "",
  "provider": "NIUM",
  "cancellationReason": "",
  "failedReason": "",
  "createdAt": "2026-01-30T12:37:13.946Z",
  "conciliationDate": "",
  "updatedAt": "2026-01-30T12:37:13.946Z",
  "payment": {
    "method": "MONEY_TRANSFER"
  },
  "events": [
    {
      "dateOfOccurrence": "2026-01-30T12:37:13.786Z",
      "name": "PROCESSING",
      "rippleStatus": []
    },
    {
      "dateOfOccurrence": "2026-01-30T12:37:13.960Z",
      "name": "AWAITING_PAYMENT",
      "description": "",
      "rippleStatus": []
    }
  ],
  "serviceInfo": {},
  "correspondent": null,
  "canCancel": false,
  "canApproveDocument": false,
  "documents": [],
  "documentsLinks": [],
  "firstOperation": false,
  "smilesAccrual": {},
  "isAwaitingFunds": false,
  "providerId": "",
  "providerFx": 0,
  "serverTime": "2026-01-30T12:37:14.146Z",
  "inboundPaymentMethod": "BANK_PATH",
  "sender": {
    "address": {}
  },
  "source": "EXTERNAL"
}