{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","results":{"codes":[]},"settings":"","params":[]},"next":{"description":"","pages":[]},"title":"financial-transaction","type":"basic","slug":"financial-transaction","excerpt":"","body":"###Request\nN/A\n\n###Response\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Property Name\",\n \"h-1\": \"Type\",\n \"h-2\": \"Description\",\n \"1-0\": \"`date-due`\",\n \"1-1\": \"*date*\",\n \"h-3\": \"Description\",\n \"1-3\": \"Defines the type of transaction. Values can be:\\nAUTH_ONLY\\nAUTH_CAPTURE\\nCAPTURE\\nAUTH_REVERSAL\\nSee Transaction Types\",\n \"h-4\": \"Description\",\n \"1-2\": \"Date when the transaction was processed. For credit card orders this is the same date as the `date-created`.\",\n \"4-0\": \"`currency`\",\n \"4-1\": \"*string*\",\n \"4-2\": \"Currency code (ISO 4217) for the paid currency.\\nSee [Currency codes](/docs/currency-codes).\",\n \"2-0\": \"`date-created`\",\n \"3-0\": \"`amount`\",\n \"2-1\": \"*date*\",\n \"3-1\": \"*decimal*\",\n \"2-2\": \"Date that the order was created.\",\n \"3-2\": \"Total amount for the order.\",\n \"0-0\": \"`status`\",\n \"0-1\": \"*string*\",\n \"5-0\": \"`soft-descriptor`\",\n \"6-0\": \"`payment-method`\",\n \"8-0\": \"`credit-card`\",\n \"9-0\": \"`invoice-contact-info`\",\n \"10-0\": \"`skus`\",\n \"6-1\": \"*string*\",\n \"5-1\": \"*string*\",\n \"8-1\": \"container\",\n \"9-1\": \"container\",\n \"10-1\": \"container\",\n \"0-2\": \"Status of the order:\\n * **Approved** – Order was approved.\\n * **Canceled** – Order was cancelled.\\n * **Declined** – Order was declined.\\n * **Pending BlueSnap Review** – Order is pending BlueSnap’s review.\\n * **Pending** – Order has not been processed.\\n * **Pending Merchant Review** – Order is pending merchant’s review.\\n * **PayPal email mismatch** - pending customer verification\\n * **Skrill email mismatch** - pending customer verification\\n * **Pending PayPal processing** - pending PayPal reply.\\n * **Wire** - indicates a wire transfer took place.\\n * **Error **- indicates a payment processing error.\",\n \"5-2\": \"Soft descriptor (statement descriptor) as it will appear on the credit card bill.\",\n \"6-2\": \"These methods are supported:\\n * **Apple Pay**\\n * **Boleto**\\n * **Credit Card**\\n * **PayPal**\\n * **PaySafeCard**\\n * **Wallie**\\n * **SEPA Direct Debit**\",\n \"9-2\": \"Container of [invoice-contact-info](doc:invoice-contact-info) properties.\",\n \"10-2\": \"Container of [skus](doc:skus) properties.\",\n \"8-2\": \"Container of [credit-card](doc:credit-card) properties.\",\n \"7-0\": \"`target-balance`\",\n \"7-1\": \"*string*\",\n \"7-2\": \"Values:\\n * **BLUESNAP_ACCOUNT**\\n * **VENDOR_PAYPAL_ACCOUNT**\",\n \"12-0\": \"`wallet`\",\n \"12-1\": \"container\",\n \"12-2\": \"Container of [wallet](doc:wallet) properties.\",\n \"13-0\": \"`sepa-direct-debit``\",\n \"13-1\": \"container\",\n \"13-2\": \"Container of [sepa-direct-debit](doc:sepa-direct-debit) properties.\",\n \"11-0\": \"`authorization-code`\",\n \"11-1\": \"*alphanumeric*\",\n \"11-2\": \"Bank authorization code of the original, transaction.\"\n },\n \"cols\": 3,\n \"rows\": 14\n}\n[/block]","updates":[],"order":39,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"61a5033cd3c4d201e7b5841e","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Resources","slug":"resources","order":8,"from_sync":false,"reference":false,"_id":"61a5033cd3c4d201e7b583c2","version":"61a5033cd3c4d201e7b5848b","project":"57336fd5a6a9c40e00e13a0b","createdAt":"2015-10-15T16:20:51.519Z","__v":0},"parentDoc":null,"project":"57336fd5a6a9c40e00e13a0b","user":"560d5913af97231900938124","version":{"version":"8976-Extended","version_clean":"8976.0.0-Extended","codename":"3.40 Release","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["61a5033cd3c4d201e7b583ba","61a5033cd3c4d201e7b583bb","61a5033cd3c4d201e7b583bc","61a5033cd3c4d201e7b583bd","61a5033cd3c4d201e7b583be","61a5033cd3c4d201e7b583bf","61a5033cd3c4d201e7b583c0","61a5033cd3c4d201e7b583c1","61a5033cd3c4d201e7b583c2","61a5033cd3c4d201e7b583c3","61a5033cd3c4d201e7b583c4"],"_id":"61a5033cd3c4d201e7b5848b","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"6040037678d626005641a154","createdAt":"2018-04-24T15:33:45.744Z","releaseDate":"2018-04-24T15:33:45.744Z"},"createdAt":"2016-06-24T18:50:46.232Z","githubsync":"","__v":0}financial-transaction
Property Name
Type
Description
status
string
Status of the order:
- Approved – Order was approved.
- Canceled – Order was cancelled.
- Declined – Order was declined.
- Pending BlueSnap Review – Order is pending BlueSnap’s review.
- Pending – Order has not been processed.
- Pending Merchant Review – Order is pending merchant’s review.
- PayPal email mismatch - pending customer verification
- Skrill email mismatch - pending customer verification
- Pending PayPal processing - pending PayPal reply.
- Wire - indicates a wire transfer took place.
- Error - indicates a payment processing error.
date-due
date
Date when the transaction was processed. For credit card orders this is the same date as the date-created.
date-created
date
Date that the order was created.
amount
decimal
Total amount for the order.
soft-descriptor
string
Soft descriptor (statement descriptor) as it will appear on the credit card bill.
payment-method
string
These methods are supported:
- Apple Pay
- Boleto
- Credit Card
- PayPal
- PaySafeCard
- Wallie
- SEPA Direct Debit
target-balance
string
Values:
- BLUESNAP_ACCOUNT
- VENDOR_PAYPAL_ACCOUNT
authorization-code
alphanumeric
Bank authorization code of the original, transaction.
