# Parameters source: https://developer.mastercard.com/straight-through-processing/documentation/parameters/index.md ## CustomDataField {#customdatafield} ### Properties {#properties} | Name | Type | Description | Notes | |-----------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------| | key | String | The unique ID of this custom data field. String. Read-only. | \[optional\] | | name | String | The human-readable description of this custom data field. String. Read-only. | \[optional\] | | dataType | String | It defines the set of allowed values. String in the format '\[BASE TYPE\]-\[LENGTH\]', where \[BASE_TYPE\] may be one of 'ALPHA', 'NUMERIC', or 'ALPHANUMERIC'. Read-only. | \[optional\] | | mandatory | Boolean | It indicates whether this custom data field must be provided when registering a new supplier with this payment provider. Boolean. Read-only. | \[optional\] | ## CustomDataFieldValue {#customdatafieldvalue} ### Properties {#properties-1} | Name | Type | Description | Notes | |-------|--------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------| | key | String | The unique ID of this custom data field. String with a minimum of 1 char and maximum of 60 chars. | | | name | String | The human-readable description of this custom data field. String. | \[optional\] | | value | String | The supplier-specific value of the custom data field. It must conform to the data type specified in the custom data field definition. String with a maximum of 200 chars (ASCII alphanumeric chars only). | | ## Payment {#payment} ### Properties {#properties-2} | Name | Type | Description | Notes | |-------------------|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------| | cardNumber | String | The Primary Account Number (PAN) of the payment card to charge for this payment request. String with a minimum of 12 chars and a maximum of 19 chars (ASCII digits only). | | | expiryMonth | Integer | The expiry month of the payment card to charge for this payment request. Integer between 1 and 12 (inclusive). | | | expiryYear | Integer | The expiry year of the payment card to charge for this payment request. Integer between 1900 and 9999 (inclusive). | | | amount | String | The amount to be paid to the recipient supplier. String containing the textual representation of decimal value (maximum 16 integer digits, maximum 4 decimal digits). | | | currencyAlphaCode | String | The code of the currency used for this payment request. String containing valid ISO 4217 alphabetic 3-letter code. | | | payerRef | String | The supplier-provided unique ID for the payment request. String with a maximum of 25 chars (limited to ASCII alphanumeric chars, spaces, and -/,.). | \[optional\] | | taxAmount | String | The amount of tax due on this payment request. String containing the textual representation of decimal value (maximum 16 integer digits, maximum 4 decimal digits). | \[optional\] | | supplierTaxId | String | The tax ID of the supplier who is the recipient of this payment request. String with a maximum of 21 chars (all Unicode chars allowed except for \<\>;\&). | \[optional\] | | clientRef | String | The client-supplied unique ID for the payment request. The ID provided is not used by STP and is used only by the calling client for correlation between client-generated IDs and STP-generated IDs. String with a maximum of 64 chars (limited to ASCII alphanumeric chars). | \[optional\] | | addendum | Object | The optional map of key/value to supply extra information for the payment request. Note that the key must only contain letters, and its value must only contain letters, digits, spaces, hyphens, slashes, commas, and periods. Example: 'ICA' as key and its appropriate value '123456'. | \[optional\] | | _links | Object | Link relations to other resources. | \[optional\] | ## PaymentStatus {#paymentstatus} ### Properties {#properties-3} | Name | Type | Description | Notes | |---------------------------|----------------|----------------------------------------------------------------------------------------------------------------------------------|--------------| | completed | Boolean | It indicates whether this payment request has been fully processed or not. Boolean. Read-only. | \[optional\] | | successful | Boolean | It indicates whether the processing of this payment request was successful or not. Boolean. Read-only. | \[optional\] | | paymentDateTime | OffsetDateTime | The date/time at which the payment provider processed this payment request. String in date-time format (see RFC3339). Read-only. | \[optional\] | | authCode | String | The authorization code returned by the payment provider for this payment request. String. Read-only. | \[optional\] | | providerResultCode | String | The provider-specific result code that was returned for this payment request. String. Read-only. | \[optional\] | | providerResultDetailCode1 | String | The provider-specific result detail code that was returned for this payment request. String. Read-only. | \[optional\] | | providerResultDetailCode2 | String | The provider-specific additional result detail code that was returned for this payment request. String. Read-only. | \[optional\] | | providerResultText | String | The provider-specific result message that was returned for this payment request. String. Read-only. | \[optional\] | | _links | Object | Link relations to other resources. | \[optional\] | ## Provider {#provider} ### Properties {#properties-4} | Name | Type | Description | Notes | |--------------|-----------------------------|---------------------------------------------------------------------------------------------------------------------------------------------|--------------| | name | String | The name of the payment provider. String. Read-only. | \[optional\] | | customFields | \[List\\] | A list of the metadata fields required by this payment provider when registering a new supplier. Array of CustomDataField items. Read-only. | \[optional\] | | _links | Object | Link relations to other resources. Read-only. | \[optional\] | ## Providers {#providers} ### Properties {#properties-5} | Name | Type | Description | Notes | |-----------|--------|-----------------------------------------------|--------------| | _embedded | Object | Collection data. Read-only. | \[optional\] | | _links | Object | Link relations to other resources. Read-only. | \[optional\] | ## Supplier {#supplier} ### Properties {#properties-6} | Name | Type | Description | Notes | |--------------|------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------| | name | String | The supplier name. String with a minimum of 1 char and maximum of 320 chars (limited to Unicode alphanumeric chars, spaces, and -.\&'/(),:_). | | | clientRef | String | The client-supplied unique ID for the supplier resource. The ID provided is not validated by STP and is used only by the calling client for correlation between client-generated IDs and STP-generated IDs. String with a maximum of 30 chars (ASCII alphanumeric chars only). | \[optional\] | | active | Boolean | It indicates whether the supplier is enabled and an eligible recipient for payment requests. Boolean. | \[optional\] | | customFields | List\ | A list of supplier-specific values for the metadata fields required by the payment provider for the successful processing of payment requests for this supplier. Array of CustomDataFieldValue items. | \[optional\] | | _links | Object | Link relations to other resources. | \[optional\] |