Dfns API Documentation
Ask or search…
K

List Payments

Warning: This API has been deprecated. Please use Wallets. Contact your sales representative if you require additional blockchain support.
GET /assets/asset-accounts/{AssetAccountId}/payments
Retrieves all outboundPayments for the specified AssetAccount.

Required Permissions

Name
Conditions
Payments:Read
Always Required

Parameters

Path parameters

Path parameter
Description
AssetAccountId
Unique identifier of the AssetAccount like: aa-orange-magnesium-a0606d08b2

Query parameters

Query parameter
Description
direction
Filter results by one of the two directions: Incoming, Outgoing
status
Filter results by any of the payment status enumerated types

Response

Response example

The response contains a list of Payments each with a status indicating whether the Payment has been Initiated or Executed. Once executed, it will also return the transaction hash:
{
"items": [
{
"amount": "0.01",
"assetAccountId": "aa-iowa-washington-7a99aa2fd5",
"assetSymbol": "ETH",
"dateCreated": "2022-07-19T19:41:15.656Z",
"externalId": "1-2-3-4",
"id": "pa-edward-emma-9e5130c59f",
"initiator": {
"kind": "Employee",
"orgId": "cu-purple-pip-1b417b958500",
"employeeId": "oe-nine-artist-9de60fef6963"
},
"narrative": "some payment",
"note": "testing",
"direction": "Outgoing",
"orgId": "cu-purple-pip-1b417b958500",
"receiver": {
"kind": "BlockchainWalletAddress",
"address": "0x8b25C5DDeeB75fD73a62Cd8c1E2Ad4EbCf2BA076"
},
"receiverAddress": "0x8b25C5DDeeB75fD73a62Cd8c1E2Ad4EbCf2BA076",
"status": "Executed",
"txHash": "0x7ded8fa5f4a82ddac94608e109eca9944bf98e30b8e6d7faf04f591e0b5769c6"
},
...
]
}
Last modified 1mo ago