API documentação

post/api/v1/Psp/deposits

Announces a bank transfer deposit the user is about to send, so it is credited to the chosen account when it arrives. Send the transfer to the bank details identified by {instructionId}.

Psp

Parâmetros

version

path · string

Obrigatório

Corpo da solicitação

{
  "provider": "string",
  "instructionId": "string",
  "accountId": 0,
  "amount": 0
}

RESPOSTAS

200The deposit, waiting for the bank transfer.application/json

{
  "isUnmatched": false,
  "canChooseAccount": false,
  "id": "6f1c2a9e-3b4d-4c8a-9f10-2a7e5b8c1d34",
  "provider": "bank-transfer",
  "direction": "Deposit",
  "status": "AwaitingFunds",
  "createdAt": "2026-10-16T09:30:00Z",
  "completedAt": null,
  "accountId": 1042,
  "accountCurrency": "USD",
  "amount": 500,
  "currency": "EUR",
  "accountAmount": null,
  "bankAmount": 500,
  "bankCurrency": "EUR",
  "rail": "SEPA",
  "beneficiaryName": null,
  "message": null,
  "rows": [
    {
      "label": "Bank transfer",
      "value": "500.00 EUR"
    },
    {
      "label": "Credited to your account",
      "value": "Pending"
    }
  ]
}

400The deposit cannot be announced, for example below the minimum. The body is a message to show the user.application/json
```
"string"
```
401Not authenticated.application/json
```
{}
```
404Unknown method.application/json
```
{}
```

Lance a sua plataforma.

Começar.