POST api/v1/customer/payments/register

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
Authentication		AuthenticationModel	Required
Request		PaymentProfileRequestModel	Required

Request Formats

application/json, text/json

Sample:

{
  "Authentication": {
    "Id": "170200123",
    "Key": "467512342123"
  },
  "Request": {
    "Card": {
      "CardNumber": "4000000000000001",
      "ExpiryDate": "12/19 (MM/YY)",
      "CVV": "123 (3 or 4 digits, depending upon card scheme)"
    },
    "BankAccount": {
      "RoutingNumber": "123456789",
      "BankAccountNumber": "1234567890",
      "AccountHolderName": "Angie E. Collard"
    },
    "Name": {
      "FirstName": "Angie",
      "LastName": "Collard",
      "CompanyName": "New Media",
      "MiddleName": "E."
    },
    "BillingAddress": {
      "HouseNumber": "123",
      "ApartmentNumber": "4A (optional)",
      "Street": "Welling Ave",
      "Street2": "Houseblocks (optional)",
      "City": "Saverton",
      "Zip": "90001",
      "County": "King (optional)",
      "State": "WA",
      "Country": "USA",
      "CountryName": null,
      "Country2AlphaCode": null,
      "Country3AlphaCode": null,
      "CountryNumericCode": null
    },
    "RegistrationDateTime": "2026-01-25 10:39:22 (YYYY-MM-DD HH:MM:SS - UTC format)",
    "CustomerProfileId": "123456789",
    "DefaultPayment": "(True or False)",
    "Authorizer": "Sierra"
  }
}

application/xml, text/xml

Sample:

<PaymentProfileBindingModel 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>
    <BankAccount>
      <AccountHolderName>Angie E. Collard</AccountHolderName>
      <BankAccountNumber>1234567890</BankAccountNumber>
      <RoutingNumber>123456789</RoutingNumber>
    </BankAccount>
    <BillingAddress>
      <ApartmentNumber>4A (optional)</ApartmentNumber>
      <City>Saverton</City>
      <Country>USA</Country>
      <Country2AlphaCode i:nil="true" />
      <Country3AlphaCode i:nil="true" />
      <CountryName i:nil="true" />
      <CountryNumericCode i:nil="true" />
      <County>King (optional)</County>
      <HouseNumber>123</HouseNumber>
      <State>WA</State>
      <Street>Welling Ave</Street>
      <Street2>Houseblocks (optional)</Street2>
      <Zip>90001</Zip>
    </BillingAddress>
    <Card>
      <CVV>123 (3 or 4 digits, depending upon card scheme)</CVV>
      <CardNumber>4000000000000001</CardNumber>
      <ExpiryDate>12/19 (MM/YY)</ExpiryDate>
    </Card>
    <CustomerProfileId>123456789</CustomerProfileId>
    <DefaultPayment>(True or False)</DefaultPayment>
    <Name>
      <CompanyName>New Media</CompanyName>
      <FirstName>Angie</FirstName>
      <LastName>Collard</LastName>
      <MiddleName>E.</MiddleName>
    </Name>
    <RegistrationDateTime>2026-01-25 10:39:22 (YYYY-MM-DD HH:MM:SS - UTC format)</RegistrationDateTime>
  </Request>
</PaymentProfileBindingModel>

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.