{"openapi":"3.1.0","info":{"title":"Transaction API","description":"View transactions performed on the CFX Network.\n\nThis API allows you to view transactions performed on the CFX Network. Transactions include deposits, withdrawals, and transfers. You can search for transactions by various criteria, such as transaction type, status, and currency.","termsOfService":"","contact":{"name":"API Owner","email":"api@cfxlabs.com"},"license":{"name":"","url":""},"version":"@VERSION@","summary":"CFX Transaction API"},"components":{"securitySchemes":{"ApiKeyAuth":{"name":"x-api-key","type":"apiKey","in":"header"},"ApiSecretAuth":{"name":"x-api-secret","type":"apiKey","in":"header"}},"schemas":{}},"paths":{"/v1/transaction":{"get":{"summary":"Search transactions","tags":["Transaction"],"parameters":[{"schema":{"type":"string"},"in":"query","name":"types","required":false,"description":"Comma-separated list transaction types ('CREDIT', 'DEBIT')"},{"schema":{"type":"string"},"in":"query","name":"methods","required":false,"description":"Comma-separated list of products."},{"schema":{"type":"string"},"in":"query","name":"statuses","required":false,"description":"Comma-separated list of transaction statuses ('PROCESSING', 'COMPLETED', 'FAILED', 'RETURNED')"},{"schema":{"type":"string"},"in":"query","name":"ids","required":false,"description":"Comma-separated list of transaction IDs"},{"schema":{"type":"string"},"in":"query","name":"entityIds","required":false,"description":"Comma-separated list of entity IDs"},{"schema":{"type":"string"},"in":"query","name":"entityTypes","required":false,"description":"Comma-separated list of entity types ('IDENTITY', 'ORGANIZATION')"},{"schema":{"type":"string"},"in":"query","name":"walletAddresses","required":false,"description":"Comma-separated list of wallet public key addresses"},{"schema":{"anyOf":[{"type":"string","enum":["EQ"]},{"type":"string","enum":["LTE"]},{"type":"string","enum":["GTE"]}]},"in":"query","name":"amountOperator","required":false,"description":"Operator for the amount (EQ, LTE, GTE)"},{"schema":{"type":"string"},"in":"query","name":"amountValue","required":false,"description":"Transaction amount value"},{"schema":{"type":"string","format":"date-time"},"in":"query","name":"createdBefore","required":false,"description":"Filter transactions created before the specified date-time"},{"schema":{"type":"string","format":"date-time"},"in":"query","name":"createdAfter","required":false,"description":"Filter transactions created after the specified date-time"},{"schema":{"type":"string","format":"date-time"},"in":"query","name":"updatedBefore","required":false,"description":"Filter transactions updated before the specified date-time"},{"schema":{"type":"string","format":"date-time"},"in":"query","name":"updatedAfter","required":false,"description":"Filter transactions updated after the specified date-time"},{"schema":{"type":"string"},"in":"query","name":"orderBy","required":false,"description":"Comma-separated list of fields and directions to order the results by.\n\nFormat: `<field name>:<direction>,...`\n\n* `<field name>`: `createdAt`, `updatedAt`\n* `<direction>`: `ASC`, `DESC`"},{"schema":{"type":"integer","default":1},"in":"query","name":"page","required":false,"description":"Result page number to return, starting from 1"},{"schema":{"type":"integer","default":10,"maximum":100},"in":"query","name":"pageSize","required":false,"description":"Items per page to return"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["items","hasNext"],"properties":{"items":{"type":"array","items":{"type":"object","required":["id","type","method","status","amount","currency","entityId","entityName","entityType","description","walletAddress","signature","createdAt","updatedAt"],"properties":{"id":{"type":"string","description":"Not necessarily unique, e.g. transfers will appear as credit and debit transactions with the same ID."},"type":{"type":"string","enum":["CREDIT","DEBIT"]},"method":{"type":"string","enum":["DEPOSIT_BLOCKCHAIN","DEPOSIT_DIRECT","DEPOSIT_US_BANK_ACH","DEPOSIT_ACH_CREDIT","DEPOSIT_RTP","DEPOSIT_US_CASH","DEPOSIT_US_WIRE","DEPOSIT_SWIFT_WIRE","REDEMPTION","SWAP","FEE_TRANSFER","TRANSFER","TRANSFER_NETWORK","WITHDRAW_AF_BANK","WITHDRAW_AF_MOMO","WITHDRAW_BLOCKCHAIN","WITHDRAW_MX_SPEI","WITHDRAW_US_BANK_ACH","WITHDRAW_US_INSTANT","WITHDRAW_ACH_PULL","WITHDRAW_US_WIRE_DRAWDOWN","WITHDRAW_SWIFT_WIRE","WITHDRAW_US_WIRE","VIRTUAL_CARD","PHYSICAL_CARD"]},"status":{"type":"string","enum":["PROCESSING","COMPLETED","FAILED","RETURNED"]},"subType":{"type":"string","enum":["RETURN","FEE"]},"amount":{"type":"string","description":"Currency amount, including fees, that were eventually debited from/credited to the account"},"currency":{"type":"string","description":"ISO currency code"},"entityId":{"type":"string","description":"ID of the entity that the transaction is associated with"},"entityName":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Display name of the entity (identity or organization) that owns this transaction"},"entityType":{"anyOf":[{"type":"string","enum":["IDENTITY"]},{"type":"string","enum":["ORGANIZATION"]},{"type":"null"}],"description":"Discriminator for the entity at entityId: 'IDENTITY' (a specific person), 'ORGANIZATION', or null when the entity isn't directly resolvable."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Fully-formatted English description for the to/from cell — already incorporates the resolved counterparty (e.g. 'From John Doe', 'To Platform', 'Return X', 'Fee'). Consumers render as `description ?? 'Not available'`."},"walletAddress":{"type":"string","description":"Public key of the wallet address"},"signature":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"On-chain transaction signature, if applicable"},"preBalance":{"type":"string","description":"MOVEUSD token balance before the on-chain transaction, if applicable"},"postBalance":{"type":"string","description":"MOVEUSD token balance after the on-chain transaction, if applicable"},"deviceLocation":{"type":"object","required":["lat","long"],"properties":{"lat":{"type":"number"},"long":{"type":"number"}},"description":"Approximate user device location (IP-derived) at the time the originating quote was created. Populated for deposits and withdrawals that captured a device location on the creating request; absent for all other transaction types."},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}}},"hasNext":{"type":"boolean"}}}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string","description":"Bad Request"}}}}}},"401":{"description":"The access to this resource has been denied","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"type":"string"}},"title":"UNAUTHORIZED","description":"The access to this resource has been denied"}}}},"default":{"description":"Catch-all error response for any unexpected internal errors","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["INTERNAL"]},"message":{"type":"string","enum":["An unexpected internal error has occurred"]}},"title":"INTERNAL","description":"Catch-all error response for any unexpected internal errors"}}}}}}}},"servers":[{"url":"https://api.dev.cfx.to","description":"Customer Sandbox"},{"url":"https://api.cfx.to","description":"Production"}],"security":[{"ApiKeyAuth":[],"ApiSecretAuth":[]}],"tags":[{"name":"Transaction"}],"externalDocs":{"description":"Find out more about CFX","url":"https://www.cfxlabs.com/"}}