POST api/v1/customer/payments/update

Update an existing payment profile. It is not necessary to include fields that are NOT changing, just the ones that are. The card number, the cardholder name and the billing country cannot be changed; all other fields can be changed.

Request Information

URI Parameters

None.

Body Parameters

PaymentProfileUpdateBindingModel

Name	Description	Type	Additional information
Authentication		AuthenticationModel	Required
Request		PaymentProfileUpdateRequestModel	Required

Request Formats

application/json, text/json

Sample:

{
  "Authentication": {
    "Id": "170200123",
    "Key": "467512342123"
  },
  "Request": {
    "CustomerProfileId": "123456789",
    "PaymentProfileId": "123456789",
    "Authorizer": "Sierra",
    "Updates": {
      "Card": {
        "ExpiryDate": "12/19 (MM/YY) - optional",
        "CVV": "123 (3 or 4 digits, depending upon card scheme) - optional"
      },
      "BillingAddress": {
        "HouseNumber": "123 (optional)",
        "ApartmentNumber": "4A (optional)",
        "Street": "Welling Ave (optional)",
        "Street2": "Houseblocks (optional)",
        "City": "Saverton (optional)",
        "Zip": "90001 (optional)",
        "County": "King (optional)",
        "State": "WA (optional)"
      },
      "MakeDefault": null
    },
    "UpdateDateTime": "2025-04-19 08:29:17 (YYYY-MM-DD HH:MM:SS - UTC format)"
  }
}

application/xml, text/xml

Sample:

<PaymentProfileUpdateBindingModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Payments.Api.Models">
  <Authentication>
    <Id>170200123</Id>
    <Key>467512342123</Key>
  </Authentication>
  <Request>
    <Authorizer>Sierra</Authorizer>
    <CustomerProfileId>123456789</CustomerProfileId>
    <PaymentProfileId>123456789</PaymentProfileId>
    <UpdateDateTime>2025-04-19 08:29:17 (YYYY-MM-DD HH:MM:SS - UTC format)</UpdateDateTime>
    <Updates>
      <BillingAddress>
        <ApartmentNumber>4A (optional)</ApartmentNumber>
        <City>Saverton (optional)</City>
        <County>King (optional)</County>
        <HouseNumber>123 (optional)</HouseNumber>
        <State>WA (optional)</State>
        <Street>Welling Ave (optional)</Street>
        <Street2>Houseblocks (optional)</Street2>
        <Zip>90001 (optional)</Zip>
      </BillingAddress>
      <Card>
        <CVV>123 (3 or 4 digits, depending upon card scheme) - optional</CVV>
        <ExpiryDate>12/19 (MM/YY) - optional</ExpiryDate>
      </Card>
      <MakeDefault i:nil="true" />
    </Updates>
  </Request>
</PaymentProfileUpdateBindingModel>

Response Information

Resource Description

ProfileOutgoingModel

Name	Description	Type	Additional information
Message		MessageModel	None.
Response		IProfileResponseModel	None.

Response Formats

application/json, text/json

Sample:

{
  "Message": {
    "Code": "(2 digit code reflecting result of request - 00 is good)",
    "Description": "(Message response in text depending upon request/result of request)"
  },
  "Response": {
    "CustomerProfileId": "000000000 (some 9 digit code/will be null for registering payment only)",
    "PaymentProfileId": "000000000 (some 9 digit code)"
  }
}

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.