Transfer

To start using transfer please top-up your identification entity. Once you have identifiers on your digital entity you may distribute them between processing and customer entities.

API provides the following ways to work with payments:

Get transfer information

Create payment

Confirm transfer

Get transfers list

As a best practice please rely on the following transfer routes inside 1 Counterparty:

• from identification to processing entity;

• from bank processing entity to customer;

• from customer to customer;

• from processing to identification entity;

• from customer to bank processing entity.

For external transfers (2 counterparties) the following transfer types are advised:

• from your processing entity to a processing entity of another Counterparty;

• from your customer counterparty to a customer of another Counterparty.

Get transfer information

Get payment

get

Get payments with filter

Path parameters

counterparty_guidstringRequired

Counterparty GUID

payment_guidstringRequired

Payment GUID

Query parameters

with_stellar_infobooleanOptional

Include stellar info

Responses

200

OK

application/json

amountnumberOptional

asset_codestringOptional

asset_issuerstringOptional

categorystringOptional

category_guidstringOptional

created_atstringOptional

deleted_atstringOptional

feenumberOptional

guidstringOptional

purposestringOptional

receiver_account_account_kindstringOptional

receiver_counterpartystringOptional

receiver_idstringOptional

sender_account_account_kindstringOptional

sender_counterpartystringOptional

sender_idstringOptional

statusstring · enumOptionalPossible values:

target_balancenumberOptional

updated_atstringOptional

400

json with error msg

application/json

get

/counterparty/{counterparty_guid}/payments/{payment_guid}

HTTPcURLJavaScriptPython

GET /api/v1/counterparty/{counterparty_guid}/payments/{payment_guid} HTTP/1.1
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"
}

Response example

{
    "guid": "37f6b441-0906-46b6-9349-e742531f4eb7",  //payment GUID
    "asset_issuer": "GC63UKIHPPR4F74IZ6BU24ZCJXHO4Y4C2KAUATDAQQFXKRW5FT6AJKYS",
    "asset_code": "UAH",
    "sender_id": "7f971dc7-0fd2-4c5c-926d-75a6d6088535",   //account_guid
    "sender_counterparty": "ac75f1a6-0abe-11ee-be56-0242ac120002",
    "sender_account_account_kind": "root",        //enum(customer, processing, emission)
    "receiver_id": "d5085e37-1a50-11ee-bd5f-3a6aa4436fee",
    "receiver_counterparty": "130a613a-d5ba-42fd-9915-ae289f392def",
    "receiver_account_account_kind": "emission",  //enum(customer, processing, emission)
    "amount": 100,
    "status": "CONFIRMED",     // enum(CREATED, CONFIRMED)
    "fee": 0,
    "stellar_info": {
        "hash": "e2302182308fad32018e57095537d7850a085ae8034df07224f8d5da79c1662d"
    },
    "created_at": "2023-08-18T12:49:33.774546Z",
    "updated_at": "2023-08-18T12:49:33.774546Z",
    "deleted_at": null
}

Using the parameter hash you can see this operation in Stellar.Expert.

Create transfer

The transfer is done with 2 steps: first, you need to create a draft record with "Create payment". When it is done a confirmation is required.

Create payment

Precondition: the sender's digital entity should have a balance before creating a transfer.

Create payment

post

Create payment

Path parameters

counterparty_guidstringRequired

Counterparty GUID

Body

application/json

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

guidstringOptional

400

json with error msg

application/json

post

/counterparty/{counterparty_guid}/payments

HTTPcURLJavaScriptPython

POST /api/v1/counterparty/{counterparty_guid}/payments HTTP/1.1
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 transfer

After creating a transfer you should confirm the transfer.

Before the confirmation be sure that the transfer is already created, the corresponding transfer guid should be used in the request body.

bank_guid is mandatory only for a transfer to another counterparty.

Confirm Payment

post

Confirm payment

Path parameters

counterparty_guidstringRequired

Counterparty GUID

Body

application/json

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

objectOptional

400

json with error msg

application/json

post

/counterparty/{counterparty_guid}/payments/confirm

HTTPcURLJavaScriptPython

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

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

{}

Get transfers list

If you want to get payment list you should make the following request.

Get payments list

get

Get payments list with filter

Path parameters

counterparty_guidstringRequired

Counterparty 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

external_idstringOptional

External transaction id

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

category_guidstringOptional

Category's guid

orderstring · enumOptional

sorting order

Possible values:

offsetintegerOptional

offset

limitintegerOptional

limit

Responses

200

OK

application/json

totalintegerOptional

400

json with error msg

application/json

get

/counterparty/{counterparty_guid}/payments

HTTPcURLJavaScriptPython

GET /api/v1/counterparty/{counterparty_guid}/payments HTTP/1.1
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
}