Skip to main content

Input fields

displayNote : String

Optional short note about the credit, to be displayed to the user.

externalAccountId : String! required

The external account identifier.

netAmount : Int! required

The net amount of the credit to be added. Amount should be posted in the smallest unit of currency.

reason : AccountCreditReasonType! required

The reason why the credit is added.

taxAmount : Int! required

The tax amount of the credit to be added. Amount should be posted in the smallest unit of currency.

The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

Example

{ "displayNote": "president-require-spring-especially-participant", "externalAccountId": "41153797", "netAmount": 51, "reason": "EXTERNAL_REFERRAL_CREDIT", "taxAmount": 72 }