Retrieve a transfer

Retrieves a specific transfer by its ID.

GET /transfer/{id}

Try it

Retrieve a transfer

cURL

curl --request GET \
  --url https://api.pushcash.com/transfer/{id} \
  --header 'Authorization: Bearer <token>'

200

{
  "id": "transfer_xle830ef8djeoiu",
  "amount": 700284,
  "currency": "USD",
  "direction": "credit",
  "created_at": "2023-05-24T20:15:18.158Z",
  "date": "2023-05-24",
  "transactions": [
    {
      "id": "txn_230vjroij4985uefjoiu9",
      "amount": -700284,
      "currency": "USD",
      "created_at": "2023-05-24T20:15:18.158Z",
      "date": "2023-05-24",
      "batch": null,
      "account_id": "account_WsELzpJOvU6fNafvzWbF6K",
      "type": "transfer",
      "source_id": "transfer_xle830ef8djeoiu",
      "status": "settled"
    }
  ],
  "account": {
    "id": "account_WsELzpJOvU6fNafvzWbF6K",
    "type": "settlement",
    "name": "Settlement Account",
    "created_at": "2023-05-24T20:15:18.158Z"
  }
}

Authorizations

Authorization · string · header · required

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

Path Parameters

id · string · required

The ID of the transfer to retrieve.

Response

200

application/json

Successful operation

id · string · required

The unique identifier assigned by Push, prefix is "transfer_"

amount · integer · required

Amount of the transfer

currency · enum<string> · required

Currency associated with the amount

Available options: USD

direction · enum<string> · required

The direction of the transfer, as indicated by the sign of the amount

• a credit represents a payout to your operational account
• a debit represents a withdrawal from your operational account

Available options: credit, debit

created_at · string<date-time> · required

When the transfer was created (ISO 8061 date string)

date · string<date> · required

Date of the transfer

transactions · object[] · required

Show child attributes

transactions. id · string · required

The unique identifier assigned by Push

transactions. amount · integer · required

Amount of the transaction (signed)

transactions. currency · enum<string> · required

Currency associated with the amount

Available options: USD

transactions. created_at · string<date-time> · required

When the transaction was created (ISO 8061 date string)

transactions. date · string<date> · required

The settlement date of the transaction

transactions. batch · string | null · required

The batch for the transaction

transactions. account_id · string · required

The account associated with the transaction

transactions. type · enum<string> · required

The type of transaction

Available options: intent, transfer, unreconciled

transactions. source_id · string | null · required

The ID of the intent, dispute, or transfer associated with the transaction. If the transaction is unreconciled, this field will be null

transactions. status · enum<string> · required

The transaction's settlement status

Available options: settled, pending

transactions. direction · enum<string>

The direction of the transaction, as indicated by the sign of the amount

Available options: credit, debit

account · object · required

Show child attributes

account. id · string · required

The unique identifier assigned by Push

account. type · enum<string> · required

The type of account

Available options: settlement, dispute

account. name · string · required

The name of the account

account. created_at · string<date-time> · required

When the account was created (ISO 8061 date string)

account. balance · integer

The balance of the account.

Example:

{
  "id": "account_WsELzpJOvU6fNafvzWbF6K",
  "type": "settlement",
  "name": "Settlement Account",
  "balance": 1000000,
  "created_at": "2023-05-24T20:15:18.158Z"
}