Transfers (branches)

Get the list of transfers for the branch

Get branch payments list

get

Get branch payments list with filter

Path parameters

counterparty_guidstringRequired

Counterparty GUID

branch_guidstringRequired

Branch GUID

Query parameters

receiver_counterpartystringOptional

Receiver counterparty GUID

sender_counterpartystringOptional

Sender counterparty GUID

guidsstring[]Optional

Payment GUIDs

sender_idsstring[]Optional

Payment sender ids

receiver_idsstring[]Optional

Payment receiver ids

min_amountintegerOptional

Minimal amount

max_amountintegerOptional

Maximum amount

statusesstring[]Optional

Payment statuses

asset_issuersstring[]Optional

Asset issuers

asset_codesstring[]Optional

Asset codes

min_created_atstringOptional

ISO date

max_created_atstringOptional

ISO date

min_updated_atstringOptional

ISO date

max_updated_atstringOptional

ISO date

categorystringOptional

Category

orderstring · enumOptional

sorting order

Possible values:

offsetintegerOptional

offset

limitintegerOptional

limit

Responses

200

OK

application/json

400

json with error msg

application/json

get

HTTPcURLJavaScriptPython

GET /api/v1/counterparty/{counterparty_guid}/branch/{branch_guid}/payments HTTP/1.1
Host: your_host
Accept: */*

{
  "payments": [
    {
      "amount": 1,
      "asset_code": "text",
      "asset_issuer": "text",
      "category": "text",
      "category_guid": "text",
      "created_at": "text",
      "deleted_at": "text",
      "fee": 1,
      "guid": "text",
      "purpose": "text",
      "receiver_account_account_kind": "text",
      "receiver_counterparty": "text",
      "receiver_id": "text",
      "sender_account_account_kind": "text",
      "sender_counterparty": "text",
      "sender_id": "text",
      "status": "CREATED",
      "stellar_info": {
        "hash": "text"
      },
      "target_balance": 1,
      "updated_at": "text"
    }
  ],
  "total": 1
}

Create branch transfer

Create branch payment

post

Create branch payment

Path parameters

counterparty_guidstringRequired

Counterparty GUID

branch_guidstringRequired

Branch GUID

Body

amountnumberOptional

amount of tokens to transfer

asset_codestringOptional

asset code

asset_issuerstringOptional

address in Stellar that issues tokens

category_guidstringOptional

payment category

purposestringOptional

receiver_ibanstringOptional

IBAN of receiver account

receiver_idstringOptional

guid of receiver account

sender_ibanstringOptional

IBAN of sender account

sender_idstringOptional

guid of sender account

target_balancenumberOptional

account balance after operation

Responses

200

OK

application/json

400

json with error msg

application/json

post

HTTPcURLJavaScriptPython

POST /api/v1/counterparty/{counterparty_guid}/branch/{branch_guid}/payments HTTP/1.1
Host: your_host
Content-Type: application/json
Accept: */*
Content-Length: 197

{
  "amount": 1,
  "asset_code": "text",
  "asset_issuer": "text",
  "category_guid": "text",
  "purpose": "text",
  "receiver_iban": "text",
  "receiver_id": "text",
  "sender_iban": "text",
  "sender_id": "text",
  "target_balance": 1
}

{
  "guid": "text"
}

Confirm branch transfer

Confirm Branch Payment

post

Confirm branch payment

Path parameters

counterparty_guidstringRequired

Counterparty GUID

branch_guidstringRequired

Branch GUID

Body

bank_guidstringOptional

Counterparty's GUID (receiver's bank). If it is not provided, the payment will be considered an internal transfer.

guidstringOptional

Payment's GUID

Responses

200

OK

application/json

Responseobject

400

json with error msg

application/json

post

HTTPcURLJavaScriptPython

POST /api/v1/counterparty/{counterparty_guid}/branch/{branch_guid}/payments/confirm HTTP/1.1
Host: your_host
Content-Type: application/json
Accept: */*
Content-Length: 34

{
  "bank_guid": "text",
  "guid": "text"
}

{}

Get branch transfer

Get branch payment

get

Get branch payments with filter

Path parameters

counterparty_guidstringRequired

Counterparty GUID

branch_guidstringRequired

Branch GUID

payment_guidstringRequired

Payment GUID

Responses

200

OK

application/json

400

json with error msg

application/json

get

HTTPcURLJavaScriptPython

GET /api/v1/counterparty/{counterparty_guid}/branch/{branch_guid}/payments/{payment_guid} HTTP/1.1
Host: your_host
Accept: */*

{
  "amount": 1,
  "asset_code": "text",
  "asset_issuer": "text",
  "category": "text",
  "category_guid": "text",
  "created_at": "text",
  "deleted_at": "text",
  "fee": 1,
  "guid": "text",
  "purpose": "text",
  "receiver_account_account_kind": "text",
  "receiver_counterparty": "text",
  "receiver_id": "text",
  "sender_account_account_kind": "text",
  "sender_counterparty": "text",
  "sender_id": "text",
  "status": "CREATED",
  "stellar_info": {
    "hash": "text"
  },
  "target_balance": 1,
  "updated_at": "text"
}

Update branch payment

put

Update branch payment

Path parameters

counterparty_guidstringRequired

Counterparty GUID

branch_guidstringRequired

Branch GUID

payment_guidstringRequired

Payment GUID

Body

amountnumberOptional

asset_codestringOptional

asset_issuerstringOptional

purposestringOptional

receiver_idstringOptional

sender_idstringOptional

statusstring · enumOptionalPossible values:

Responses

200

OK

application/json

Responseobject

400

json with error msg

application/json

put

HTTPcURLJavaScriptPython

PUT /api/v1/counterparty/{counterparty_guid}/branch/{branch_guid}/payments/{payment_guid} HTTP/1.1
Host: your_host
Content-Type: application/json
Accept: */*
Content-Length: 130

{
  "amount": 1,
  "asset_code": "text",
  "asset_issuer": "text",
  "purpose": "text",
  "receiver_id": "text",
  "sender_id": "text",
  "status": "CREATED"
}

{}