| Field | Type | Required | Description | Example |
|---|---|---|---|---|
type |
Optional[Literal["payment-service"]] | ➖ | Always payment-service |
payment-service |
id |
Optional[str] | ➖ | N/A | fffd152a-9532-4087-9a4f-de58754210f0 |
merchant_account_id |
str | ✔️ | The ID of the merchant account this job belongs to. | default |
payment_service_definition_id |
str | ✔️ | The definition ID of the service that has been configured. | stripe-card |
active |
Optional[bool] | ➖ | Defines if this payment service is currently active. | Example 1: true Example 2: false |
method |
models.Method | ✔️ | N/A | |
display_name |
str | ✔️ | The display name for the payment service. | Stripe |
position |
int | ✔️ | Deprecated field used to define the order in which to process payment services | 1 |
status |
Optional[models.PaymentServiceStatus] | ➖ | N/A | |
accepted_currencies |
List[str] | ✔️ | A list of currencies for which this service is enabled, in ISO 4217 three-letter code format. | [ "USD", "EUR", "GBP" ] |
accepted_countries |
List[str] | ✔️ | A list of countries for which this service is enabled, in ISO two-letter code format. | [ "US", "DE", "GB" ] |
payment_method_tokenization_enabled |
bool | ✔️ | Defines if this payment service support payment method tokenization. | true |
network_tokens_enabled |
bool | ✔️ | Defines if this payment service supports network tokens. | true |
open_loop |
bool | ✔️ | Defines if this payment service is open loop. | true |
settlement_reporting_enabled |
bool | ✔️ | Defines if this payment service has settlement reporting enabled. | true |
three_d_secure_enabled |
OptionalNullable[bool] | ➖ | Defines if this payment service has 3DS enabled. | true |
merchant_profile |
Dict[str, Nullable[models.MerchantProfileSchemeSummary]] | ➖ | An object containing a key for each supported card schemes, and for each key an object with the 3DS profile for this service for that scheme. | |
webhook_url |
OptionalNullable[str] | ➖ | The URL that needs to be configured with this payment service as the receiving endpoint for webhooks from the service to our system. Currently, we dp not yet automatically register webhooks on setup, and therefore webhooks need to be registered manually by the merchant. | |
fields |
List[models.FieldT] | ➖ | The non-secret credential fields that have been configured for this payment service. Any secret fields are omitted. | |
reporting_fields |
List[models.FieldT] | ➖ | The non-secret reporting fields that have been configured for this payment service. Any secret fields are omitted. | |
is_deleted |
Optional[bool] | ➖ | Defines if this payment service has been deleted | false |
created_at |
date | ✔️ | The date and time when this payment service was first created in our system. | 2013-07-16T19:23:00.000+00:00 |
updated_at |
date | ✔️ | The date and time when this payment service was last updated in our system. | 2013-07-16T19:23:00.000+00:00 |