Update Payment Serie

Last changes: 09-04-2023

As a Merchant you could update the below properties of a payment serie:

consumer
billingAddress
shippingAddress
merchantMetadata
externalMerchantId

Request parameters

Field	Description	Type	Length	Mandatory
externalMerchantId	Field that allows the merchant to store a specific value as an external reference Available as a filtering field	String	255	No
externalReference	As an integrating merchant you could link any custom reference on your end to the Payment Serie through this field	String	255	No
merchantMetadata	Field that allows the merchant to store any specific merchant metadata	String	255	No
billingAddress	Parent element. Billing address of the consumer. Please refer to Data Model for details.	Object	-	No
shippingAddress	Parent element. Shipping address of the consumer. Please refer to Data Model for details.	Object	-	No
consumer	Parent element. Business/Company information. Please refer to Data Model for details.	Object	-	No
businessConsumer	Parent element. Customer information. Please refer to Data Model for details.	Object	-	No

The request must provide the followng header:

x-api-key: {merchantKey}

Request sample

Path:: PATCH {BaseUrl}/payment-series/PaymentSeries-f45b5e21-5279-48f8-9b7a-b3e071363de6
Header:: Content-Type: application/json
Accept-Language: en-US

{
"externalMerchantId": "UMerchantExternalPSerie01",
"merchantMetadata": "{ \"clientId\": U453456790 }",
"externalReference":"UPaymentSerie 01 Payment",
"billingAddress": {
"addressLine1": "Leopoldstr",
"number": "245",
"city": "Munich",
"postCode": "80806",
"countryCode": "DE"
},
"shippingAddress": {
"addressLine1": "Leopoldstr.",
"number": "245",
"city": "Munich",
"postCode": "80806",
"countryCode": "DE"
},
"consumer": {
"firstName": "UFirstNameA",
"lastName": "ULastNameA",
"emailAddress": "UNewcustomerSerie01@email.com",
"title": "Mr",
"culture": "de-de",
"dateOfBirth": "1995-10-26",
"gender": "F",
"mobilePhone": "01234567890",
"homePhone": "01234567891",
"workPhone": "01234567892"
}
}

Response parameters

Field	Description	Type	Length	Mandatory
id	Payment Serie ID, automatically generated by the system Format: "PaymentSeries" + "-" + <UUID> Example: "PaymentSeries-fe3f839f-c8b5-48cd-a4f4-cbbb3766013b"	String	50	Yes
createdAt	Timestamp of when the payment serie was created. Format: yyyy-MM-dd'T'HH:mm:ss.SS'Z (E.g: 2021-02-11T15:00:44.718Z)	String	24	Yes
updatedAt	Timestamp of when the payment serie was last updated. Format: yyyy-MM-dd'T'HH:mm:ss.SS'Z (E.g: 2021-02-11T15:00:44.718Z)	String	24	Yes
deletedAt	Timestamp of when the payment serie was deleted (if applicable). Format: yyyy-MM-dd'T'HH:mm:ss.SS'Z (E.g: 2021-02-11T15:00:44.718Z)	String	24	Yes
currencyIsoCode	Currency code (e.g. EUR) Format: ISO 4217	String	3	Yes
customerAccountId	Customer Account ID - A unique identifier provided by the integrating merchant by which the user's account could be identified e.g. customer number For subscription Module, SmartPay checks if an account exists, if so, your end customer would be able to see their previously stored payment instruments, if any.	String	125	Yes
merchantMetadata	Field that allows the merchant to store a specific metadata linked with the payment serie.	String	255	No
externalMerchantId	Field that allows the merchant to store a specific value for external reference. Available as a filtering field.	String	255	No
externalReference	Integrating merchant could link any custom reference on their end to the Payment Serie through this field	String	255	No
billingAgreement	Billing Agreement linked to the payment serie. This field hosts the payment instrument information. Returns "null" for a newly created payment serie as no payment instrument is linked to the payment serie yet!	Object	-	Yes
billingAddress	Billing address of the consumer. Please refer to Data Model for details.	Object	-	Yes
shippingAddress	Shipping address of the consumer. Please refer to Data Model for details.	Object	-	Yes
consumer	Mandatory if "businessConsumer" object is not provided. Customer information. Please refer to Data Model for details.	Object	-	Conditional
businessConsumer	Mandatory if "consumer" object is not provided. Business/Company information. Please refer to Data Model for details.	Object	-	Conditional

Response sample

Status Code:: 200 (OK)
Header:: Content-Type: application/json
Accept-Language: en-US

{
"id": "PaymentSeries-f45b5e21-5279-48f8-9b7a-b3e071363de6",
"createdAt": "2021-06-14T17:36:11.25Z",
"updatedAt": "2021-06-14T17:45:22.33Z",
"deletedAt": null,
"customerAccountId": "NewcustomerSerie01",
"currencyIsoCode": "EUR",
"externalMerchantId": "UMerchantExternalPSerie01",
"merchantMetadata": "{ \"clientId\": U453456790 }",
"externalReference": "UPaymentSerie 01 Payment",
"billingAddress": {
"addressLine1": "Leopoldstr",
"addressLine2": null,
"addressLine3": null,
"number": "245",
"city": "Munich",
"postCode": "80806",
"countryCode": "DE",
"state": null
},
"shippingAddress": {
"addressLine1": "Leopoldstr.",
"addressLine2": null,
"addressLine3": null,
"number": "245",
"city": "Munich",
"postCode": "80806",
"countryCode": "DE",
"state": null
},
"consumer": {
"firstName": "UFirstNameA",
"lastName": "ULastNameA",
"middleName": null,
"emailAddress": "UNewcustomerSerie01@email.com",
"title": "Mr",
"culture": "de-de",
"dateOfBirth": "1995-10-26",
"gender": "F",
"mobilePhone": "01234567890",
"homePhone": "01234567891",
"workPhone": "01234567892",
"taxId": null
},
"billingAgreement": null
}

For error handling, please refer to this section.

Previous

Next