{"_id":"5b19742cb3baf90003cab552","category":{"_id":"5b19742cb3baf90003cab4f0","version":"5b19742cb3baf90003cab5ae","project":"57336fd5a6a9c40e00e13a0b","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-10-15T16:20:51.519Z","from_sync":false,"order":8,"slug":"resources","title":"Resources"},"parentDoc":null,"project":"57336fd5a6a9c40e00e13a0b","user":"560d5913af97231900938124","version":{"_id":"5b19742cb3baf90003cab5ae","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"5adf4e59ac13b80003d23152","createdAt":"2018-04-24T15:33:45.744Z","releaseDate":"2018-04-24T15:33:45.744Z","categories":["5b19742cb3baf90003cab4e8","5b19742cb3baf90003cab4e9","5b19742cb3baf90003cab4ea","5b19742cb3baf90003cab4eb","5b19742cb3baf90003cab4ec","5b19742cb3baf90003cab4ed","5b19742cb3baf90003cab4ee","5b19742cb3baf90003cab4ef","5b19742cb3baf90003cab4f0","5b19742cb3baf90003cab4f1","5b19742cb3baf90003cab4f2"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"3.26 Release","version_clean":"8976.0.0-Extended","version":"8976-Extended"},"githubsync":"","__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-06-24T18:50:46.232Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":39,"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  * **PLIMUS_ACCOUNT**\\n  * **VENDOR_PAYPAL_ACCOUNT**\",\n    \"11-0\": \"`wallet`\",\n    \"11-1\": \"container\",\n    \"11-2\": \"Container of [wallet](doc:wallet) properties.\",\n    \"12-0\": \"`sepa-direct-debit``\",\n    \"12-1\": \"container\",\n    \"12-2\": \"Container of [sepa-direct-debit](doc:sepa-direct-debit) properties.\"\n  },\n  \"cols\": 3,\n  \"rows\": 13\n}\n[/block]","excerpt":"","slug":"financial-transaction","type":"basic","title":"financial-transaction"}

financial-transaction


Request

N/A

Response

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.

currency

string

Currency code (ISO 4217) for the paid currency.
See Currency codes.

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:

  • PLIMUS_ACCOUNT
  • VENDOR_PAYPAL_ACCOUNT

credit-card

container

Container of credit-card properties.

invoice-contact-info

container

Container of invoice-contact-info properties.

skus

container

Container of skus properties.

wallet

container

Container of wallet properties.

`sepa-direct-debit``

container

Container of sepa-direct-debit properties.