{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","settings":"","results":{"codes":[]},"params":[]},"next":{"description":"","pages":[]},"title":"refunds","type":"basic","slug":"refunds","excerpt":"Contains existing refunds for this transaction","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    \"0-0\": \"`refund`\",\n    \"0-1\": \"array\",\n    \"0-2\": \"An array of [refund](doc:refund-1) objects.\",\n    \"1-0\": \"`balanceAmount`\",\n    \"1-1\": \"*decimal*\",\n    \"1-2\": \"Amount available to be refunded\",\n    \"3-0\": \"`vendorBalanceAmount`\",\n    \"3-1\": \"*decimal*\",\n    \"3-2\": \"Amount available to be refunded to vendors. Only applicable if one or more vendors were involved in original transaction.\",\n    \"4-0\": \"`vendorsBalanceInfo`\",\n    \"4-1\": \"*object*\",\n    \"4-2\": \"See [vendorsBalanceInfo](doc:vendorsbalanceinfo).\",\n    \"2-0\": \"`taxBalanceAmount`\",\n    \"2-1\": \"*decimal*\",\n    \"2-2\": \"The tax amount available to be refunded, if taxes were part of the transaction.\"\n  },\n  \"cols\": 3,\n  \"rows\": 5\n}\n[/block]","updates":[],"order":39,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"60a40b18fa93ca00237af50d","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"JSON Objects","slug":"resources","order":15,"from_sync":false,"reference":false,"_id":"60a40b18fa93ca00237af4c8","version":"60a40b18fa93ca00237af576","project":"57336fd5a6a9c40e00e13a0b","createdAt":"2015-10-15T16:20:51.519Z","__v":0},"parentDoc":null,"user":"560d5913af97231900938124","project":"57336fd5a6a9c40e00e13a0b","version":{"version":"8976-JSON","version_clean":"8976.0.0-JSON","codename":"3.38 Release","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["60a40b18fa93ca00237af4bd","60a40b18fa93ca00237af4be","60a40b18fa93ca00237af4bf","60a40b18fa93ca00237af4c0","60a40b18fa93ca00237af4c1","60a40b18fa93ca00237af4c2","60a40b18fa93ca00237af4c3","60a40b18fa93ca00237af4c4","60a40b18fa93ca00237af4c5","60a40b18fa93ca00237af4c6","60a40b18fa93ca00237af4c7","60a40b18fa93ca00237af4c8","60a40b18fa93ca00237af4c9","60a40b18fa93ca00237af4ca","60a40b18fa93ca00237af4cb","60a40b18fa93ca00237af4cc","60a40b18fa93ca00237af4cd","60a40b18fa93ca00237af4ce","60a40b18fa93ca00237af4cf"],"_id":"60a40b18fa93ca00237af576","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"603d5bd1309e0703644e931e","createdAt":"2018-04-24T15:22:41.561Z","releaseDate":"2018-04-24T15:22:41.561Z"},"createdAt":"2016-09-22T14:28:19.570Z","githubsync":"","__v":0}

Payment API (JSON)

Card/Wallet Transactions

PayPal Transactions

ACH/ECP Transactions

iDEAL Transactions

Local Bank Transfer transactions

SEPA Direct Debit Transactions

Sofort Transactions

Refunds

Vaulted Shoppers

Subscriptions

Fraud Review

Marketplace

Wallets

Errors

JSON Objects

Test Data & Codes

Guides & Tools

Mobile SDK

refunds

Contains existing refunds for this transaction

Request

N/A

Response

Property Name
Type
Description

refund

array

An array of refund objects.

balanceAmount

decimal

Amount available to be refunded

taxBalanceAmount

decimal

The tax amount available to be refunded, if taxes were part of the transaction.

vendorBalanceAmount

decimal

Amount available to be refunded to vendors. Only applicable if one or more vendors were involved in original transaction.

vendorsBalanceInfo

object

See vendorsBalanceInfo.