Schemas used in requests/responses of our API:
| Parameter | Type | Description | Constraints | Required |
|---|
| success | String(1...2000) | Return URL to use when the transaction succeeds. | | ✅ |
| cancelled | String(1...2000) | Return URL to use when the transaction is cancelled. | | ✅ |
| expired | String(1...2000) | Return URL to use when the transaction is expired. | | ✅ |
| failed | String(1...2000) | Return URL to use when the transaction is failed. | | ✅ |
| Parameter | Type | Description | Constraints | Required |
|---|
| redirect | redirect Object | Next action to be performed by merchant (or consumer) to complete the payment. | | |
| Parameter | Type | Description | Constraints | Required |
|---|
| url | String | URL where consumer should be redirected to by the merchant to perform the payment. | | |
| Parameter | Type | Description | Constraints | Required |
|---|
| name | String | Customer name. | | |
| bic | String(8...11) | Bank Identification Code used by the customer. | | |
| iban | String | IBAN used by the customer. | | |
| checkoutDetails | Object | Contains the optional Fast Checkout details requested during the transaction creation. | | |
| Parameter | Type | Description | Constraints | Required |
|---|
| contactDetails | Object | Contact details of the consumer | Available if requested | |
| shippingAddress | Object | Shipping Address of the consumer | Available if requested | |
| invoiceAddress | Object | Invoice Address of the consumer | Available if requested | |
| Parameter | Type | Description | Constraints | Required |
|---|
| firstName | String | The first name of the consumer as configured in their Currence profile | Available if requested | |
| lastName | String | The last name of the consumer as configured in their Currence profile | Available if requested | |
| phoneNumber | String | The phone number of the consumer as configured in their Currence profile | Available if requested | |
| email | String | The email of the consumer as configured in their Currence profile | Available if requested | |
| Parameter | Type | Description | Constraints | Required |
|---|
| firstName | String | The first name of the consumer as configured in their Currence profile | Available if requested | |
| lastName | String | The last name of the consumer as configured in their Currence profile | Available if requested | |
| companyName | String | The company name of the consumer as configured in their Currence profile | Available if requested | |
| postalCode | String | The postal code of the consumer as configured in their Currence profile | Available if requested | |
| houseNumber | String | The house number of the consumer as configured in their Currence profile | Available if requested | |
| addition | String | Addition to the house number of the consumer as configured in their Currence profile | Available if requested | |
| street | String | The street of the consumer as configured in their Currence profile | Available if requested | |
| city | String | The city of the consumer as configured in their Currence profile | Available if requested | |
| countryName | String | The countryName of the consumer as configured in their Currence profile | Available if requested | |
| Parameter | Type | Description | Constraints | Required |
|---|
| refundedAmount | Int(0...99999999) | Amount in the smallest currency subunit, as for example eurocents, that has already been refunded. | | ✅ |
| refundedPendingAmount | Int(1...99999999) | Amount in the smallest currency subunit, as for example eurocents, that has been requested to be refunded. | | ✅ |
