Money object | Clearpay Documentation

Attributes

Attribute	Type	Description
`amount`	string `required`	The amount is a string representation of a decimal number, rounded to 2 decimal places.
`currency`	string `required`	The currency in ISO 4217 format. Only “GBP” is supported.

422 Errors

Where a Money object is included in an API request, it will be validated according to the specification above. Invalid Money objects will trigger a 422 Unprocessable Entity response. The following is a list of common examples.

Example	errorCode	message
`amount` is omitted or null	`invalid_object`	`{Money object}`.amount Amount field required
`amount` is less than or equal to 0	`invalid_object`	amount must be greater than 0.00
`amount` has more than 2 decimal places	`invalid_object`	amount. must be a valid ISO 4217 format value
`amount` is not a decimal number, for example: “free”, “1,000”, “$2” or an empty string	`invalid_object`	The object provided is not valid
`currency` is omitted or null	`invalid_object`	`{Money object}`.currency Currency field required
`currency` is not a valid currency code, not all uppercase or an empty string	`invalid_object`	`{Money object}`.currency Currency not supported for this merchant
`currency` is supported by Afterpay, but not valid for the Merchant account	`unsupported_currency`	An error occurred

Example Money object

1 {
2   "amount": "29.99",
3   "currency": "GBP"
4 }