Skip to main content
POST
/
events
/
transfers
/
outbound
Log outbound transfer event
curl --request POST \
  --url http://sandbox.mintlify.com/events/transfers/outbound \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "accountId": "<string>",
  "amount": 1,
  "destinationAccount": {
    "accountNumber": "<string>",
    "routingNumber": "<string>",
    "accountType": "checking"
  },
  "timestamp": "2023-11-07T05:31:56Z",
  "status": "pending"
}
'
{
  "eventId": "<string>",
  "status": "success",
  "timestamp": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Outbound transfer event details

accountId
string
required

ID of the sending account

amount
integer
required

Transfer amount in cents

Required range: x >= 0
destinationAccount
object
required

Details of the receiving account

timestamp
string<date-time>
required

When the transfer was initiated

status
enum<string>

Current status of the transfer

Available options:
pending,
processing,
completed,
failed

Response

201 - application/json

Outbound transfer event logged

eventId
string
required

Unique identifier for the logged event

status
enum<string>
required

Status of the event logging

Available options:
success,
failed
timestamp
string<date-time>

Time when the event was logged